Go SDK

The SurrealDB SDK for Go enables simple and advanced querying of a remote database from server-side applications.

The SurrealDB SDK for Go enables you to interact with SurrealDB from server-side applications, systems, APIs, and as an embedded instance. You can use the SDK to execute queries, manage data, authenticate users, subscribe to real-time changes with live queries, and work with interactive sessions and transactions.

Important

The SDK requires Go 1.23 or greater, and is available as a go.dev package.

Note

The latest version of the SDK is v1.5.1.
The SDK works with SurrealDB versions v2.0.0 to v3.2.0, ensuring compatibility with the latest version.

Getting started

Installation

Install the SDK and add it to your project.

Getting started guide

Connect to SurrealDB and run your first queries.

Learn

Concepts

Guides for connecting, authenticating, querying, and working with data.

API Reference

Complete reference for the SDK's methods, types, and errors.

Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.go repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

Getting started

Learn

Contributing

Sources