SurrealDB Docs Logo

Enter a search query

Quick start

Now that you have a more comprehensive understanding of the SurrealDB SDK for Golang, let’s create a simple project to get you started.

This guide will walk you through connecting and authenticating to a SurrealDB server, set the namespace and database, and make several data manipulation requests.

Prerequisites

This guide assumes the following:

  • You have a basic understanding of the Go ecosystem and the Go language.
  • You have an install version of SurrealDB >1.4.2 installed on your machine.

Setup your project

Create a new main.go file and add the following code to try out some basic operations using the SurrealDB SDK.

package main import ( "fmt" surrealdb "github.com/surrealdb/surrealdb.go" "github.com/surrealdb/surrealdb.go/pkg/models" ) type Person struct { ID *models.RecordID `json:"id,omitempty"` Name string `json:"name"` Surname string `json:"surname"` Location models.GeometryPoint `json:"location"` } func main() { // Connect to SurrealDB db, err := surrealdb.New("ws://localhost:8000") if err != nil { panic(err) } // Set the namespace and database if err = db.Use("testNS", "testDB"); err != nil { panic(err) } // Sign in to authentication `db` authData := &surrealdb.Auth{ Username: "root", // use your setup username Password: "root", // use your setup password } token, err := db.SignIn(authData) if err != nil { panic(err) } // Check token validity. This is not necessary if you called `SignIn` before. This authenticates the `db` instance too if sign in was // not previously called if err := db.Authenticate(token); err != nil { panic(err) } // And we can later on invalidate the token if desired defer func(token string) { if err := db.Invalidate(); err != nil { panic(err) } }(token) // Create an entry person1, err := surrealdb.Create[Person](db, models.Table("persons"), map[interface{}]interface{}{ "Name": "John", "Surname": "Doe", "Location": models.NewGeometryPoint(-0.11, 22.00), }) if err != nil { panic(err) } fmt.Printf("Created person with a map: %+v\n", person1) // Or use structs person2, err := surrealdb.Create[Person](db, models.Table("persons"), Person{ Name: "John", Surname: "Doe", Location: models.NewGeometryPoint(-0.11, 22.00), }) if err != nil { panic(err) } fmt.Printf("Created person with a struvt: %+v\n", person2) // Get entry by Record ID person, err := surrealdb.Select[Person, models.RecordID](db, *person1.ID) if err != nil { panic(err) } fmt.Printf("Selected a person by record id: %+v\n", person) // Or retrieve the entire table persons, err := surrealdb.Select[[]Person, models.Table](db, models.Table("persons")) if err != nil { panic(err) } fmt.Printf("Selected all in persons table: %+v\n", persons) // Delete an entry by ID if err = surrealdb.Delete[models.RecordID](db, *person2.ID); err != nil { panic(err) } // Delete all entries if err = surrealdb.Delete[models.Table](db, models.Table("persons")); err != nil { panic(err) } // Confirm empty table persons, err = surrealdb.Select[[]Person](db, models.Table("persons")) if err != nil { panic(err) } fmt.Printf("No Selected person: %+v\n", persons) }

Run the example

  • Run go mod init github.com/<github-username>/<project-name> to initialise a go.mod file
  • Run go mod tidy to download the surrealdb.go dependency
  • Run go run main.go to run the example.

Next steps

Now that you have learned the basics of the Golang SDK for SurrealDB, you can learn more about the SDK and its methods in the methods section and data types section.

On this page

© SurrealDB GitHub Discord Community Cloud Features Releases Install