SurrealDB Go 驱动使用指南

SurrealDB 是一个新兴的分布式图数据库，而 surrealdb.go 是它的 Go 语言驱动程序。下面我将详细介绍如何使用这个驱动连接和操作 SurrealDB 数据库。

安装驱动

首先安装 surrealdb.go 驱动：

go get github.com/surrealdb/surrealdb.go

基本使用

1. 连接数据库

package main

import (
	"fmt"
	"log"

	"github.com/surrealdb/surrealdb.go"
)

func main() {
	// 创建数据库连接
	db, err := surrealdb.New("ws://localhost:8000/rpc")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 登录（认证）
	if _, err = db.Signin(map[string]interface{}{
		"user": "root",
		"pass": "root",
	}); err != nil {
		log.Fatal(err)
	}

	// 选择命名空间和数据库
	if _, err = db.Use("test", "test"); err != nil {
		log.Fatal(err)
	}

	fmt.Println("成功连接到SurrealDB!")
}

2. 创建记录

// 创建单个记录
user := map[string]interface{}{
	"username": "john",
	"password": "123456",
	"age":      25,
}

created, err := db.Create("user", user)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("创建的用户: %+v\n", created)

// 批量创建
users := []map[string]interface{}{
	{
		"username": "alice",
		"password": "654321",
		"age":      30,
	},
	{
		"username": "bob",
		"password": "abcdef",
		"age":      28,
	},
}

createdMany, err := db.Create("user", users)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("批量创建的用户: %+v\n", createdMany)

3. 查询数据

// 查询单个记录
selected, err := db.Select("user:john")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("查询结果: %+v\n", selected)

// 执行SQL查询
query := "SELECT * FROM user WHERE age > $age"
bindings := map[string]interface{}{"age": 26}

results, err := db.Query(query, bindings)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("SQL查询结果: %+v\n", results)

4. 更新数据

// 更新记录
changes := map[string]interface{}{
	"age": 26,
}

updated, err := db.Update("user:john", changes)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("更新后的用户: %+v\n", updated)

// 替换整个记录
newUser := map[string]interface{}{
	"username": "john_doe",
	"password": "newpass",
	"age":      27,
}

replaced, err := db.Change("user:john", newUser)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("替换后的用户: %+v\n", replaced)

5. 删除数据

// 删除单个记录
deleted, err := db.Delete("user:john")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("删除的用户: %+v\n", deleted)

// 删除所有用户记录
_, err = db.Delete("user")
if err != nil {
	log.Fatal(err)
}

高级功能

1. 使用结构体

type User struct {
	Username string `json:"username"`
	Password string `json:"password"`
	Age      int    `json:"age"`
}

// 创建结构体记录
newUser := User{
	Username: "emma",
	Password: "emma123",
	Age:      22,
}

createdUser, err := db.Create("user", newUser)
if err != nil {
	log.Fatal(err)
}

// 查询到结构体
var user User
if err = db.Unmarshal(createdUser, &user); err != nil {
	log.Fatal(err)
}
fmt.Printf("结构体用户: %+v\n", user)

2. 事务处理

// 开始事务
tx, err := db.Begin()
if err != nil {
	log.Fatal(err)
}

// 在事务中执行操作
if _, err = tx.Create("user", map[string]interface{}{
	"username": "tx_user",
	"password": "tx_pass",
}); err != nil {
	tx.Rollback()
	log.Fatal(err)
}

// 提交事务
if err = tx.Commit(); err != nil {
	log.Fatal(err)
}

3. 订阅实时更新

// 创建订阅通道
events, err := db.Live("user")
if err != nil {
	log.Fatal(err)
}

// 处理实时事件
go func() {
	for event := range events {
		fmt.Printf("实时事件: %+v\n", event)
	}
}()

// 在另一个goroutine中修改数据会触发事件
go func() {
	_, err := db.Create("user", map[string]interface{}{
		"username": "event_user",
	})
	if err != nil {
		log.Println(err)
	}
}()

错误处理

// 检查特定错误类型
if surrealdb.IsConnectionError(err) {
	fmt.Println("连接错误:", err)
} else if surrealdb.IsQueryError(err) {
	fmt.Println("查询错误:", err)
} else if err != nil {
	fmt.Println("其他错误:", err)
}

性能优化建议

1. 使用连接池管理数据库连接
2. 批量操作时尽量使用事务
3. 合理设计数据模型和索引
4. 对于频繁查询可以考虑使用缓存

总结

surrealdb.go 驱动提供了简洁的API来操作SurrealDB数据库，支持基本的CRUD操作、事务处理和实时订阅等功能。通过结构体绑定可以更方便地处理数据，而错误处理机制帮助开发者构建健壮的应用程序。

SurrealDB作为新兴数据库，其Go驱动仍在不断发展中，建议定期关注GitHub仓库以获取最新功能和改进。