Golang RethinkDB 数据库驱动插件库 gorethink 的使用

安装

go get gopkg.in/rethinkdb/rethinkdb-go.v6

可以将 v6 替换为 v5 或 v4 来使用旧版本。

基本示例

package main

import (
    "fmt"
    "log"

    r "gopkg.in/rethinkdb/rethinkdb-go.v6"
)

func main() {
    // 连接到 RethinkDB
    session, err := r.Connect(r.ConnectOpts{
        Address: "localhost:28015", // 不带 http 的地址
    })
    if err != nil {
        log.Fatalln(err)
    }

    // 执行简单查询
    res, err := r.Expr("Hello World").Run(session)
    if err != nil {
        log.Fatalln(err)
    }

    var response string
    err = res.One(&response)
    if err != nil {
        log.Fatalln(err)
    }

    fmt.Println(response)
}

连接方式

基本连接

func ExampleConnect() {
    session, err := r.Connect(r.ConnectOpts{
        Address: "localhost:28015",
    })
    if err != nil {
        log.Fatalln(err.Error())
    }
    defer session.Close()
}

连接池配置

func ExampleConnect_connectionPool() {
    session, err := r.Connect(r.ConnectOpts{
        Address:    "localhost:28015",
        InitialCap: 10,  // 初始连接数
        MaxOpen:    10,  // 最大连接数
    })
    if err != nil {
        log.Fatalln(err.Error())
    }
    defer session.Close()
}

连接到集群

func ExampleConnect_cluster() {
    session, err := r.Connect(r.ConnectOpts{
        Addresses: []string{"localhost:28015", "node2:28015", "node3:28015"},
    })
    if err != nil {
        log.Fatalln(err.Error())
    }
    defer session.Close()
}

用户认证

首先创建用户并授权：

// 创建用户
err := r.DB("rethinkdb").Table("users").Insert(map[string]string{
    "id": "john",
    "password": "p455w0rd",
}).Exec(session)

// 授权
err = r.DB("blog").Table("posts").Grant("john", map[string]bool{
    "read": true,
    "write": true,
}).Exec(session)

然后使用认证信息连接：

session, err := r.Connect(r.ConnectOpts{
    Address:  "localhost:28015",
    Database: "blog",
    Username: "john",
    Password: "p455w0rd",
})

查询示例

基本查询

// 查询单个文档
res, err := r.DB("database").Table("table").Get("GUID").Run(session)
if err != nil {
    log.Fatal(err)
}
defer res.Close()

var row interface{}
err = res.One(&row)

使用 Map 函数

// 使用函数
r.Expr([]interface{}{1, 2, 3, 4, 5}).Map(func(row r.Term) interface{} {
    return row.Add(1)
}).Run(session)

// 使用隐式 Row
r.Expr([]interface{}{1, 2, 3, 4, 5}).Map(r.Row.Add(1)).Run(session)

使用可选参数

r.DB("database").Table("table").Between(1, 10, r.BetweenOpts{
    Index:      "num",
    RightBound: "closed",
}).Run(session)

结果处理

// 获取所有结果
var rows []interface{}
err := res.All(&rows)

// 获取单个结果
var row interface{}
err := res.One(&row)
if err == r.ErrEmptyResult {
    // 没有找到记录
}

// 遍历结果
var row interface{}
for res.Next(&row) {
    // 处理每一行
}
if res.Err() != nil {
    // 处理错误
}

数据模型映射

结构体标签

type User struct {
    ID      string `rethinkdb:"id,omitempty"`
    Name    string `rethinkdb:"name"`
    Email   string `rethinkdb:"email,omitempty"`
    Ignored int    `rethinkdb:"-"`
}

复合主键

type Book struct {
    AuthorID string `rethinkdb:"id[0]"`
    Name     string `rethinkdb:"id[1]"`
}
// 在 RethinkDB 中存储为 {"id": [AUTHORID, NAME]}

引用关系

type Author struct {
    ID   string `rethinkdb:"id,omitempty"`
    Name string `rethinkdb:"name"`
}

type Book struct {
    ID     string `rethinkdb:"id,omitempty"`
    Title  string `rethinkdb:"title"`
    Author Author `rethinkdb:"author_id,reference" rethinkdb_ref:"id"`
}

完整示例

package main

import (
    "fmt"
    "log"
    "time"

    r "gopkg.in/rethinkdb/rethinkdb-go.v6"
)

type Post struct {
    ID        string    `rethinkdb:"id,omitempty"`
    Title     string    `rethinkdb:"title"`
    Content   string    `rethinkdb:"content"`
    CreatedAt time.Time `rethinkdb:"created_at"`
    Tags      []string  `rethinkdb:"tags"`
}

func main() {
    // 连接到 RethinkDB
    session, err := r.Connect(r.ConnectOpts{
        Address:  "localhost:28015",
        Database: "blog",
    })
    if err != nil {
        log.Fatalf("Error connecting to DB: %v", err)
    }
    defer session.Close()

    // 创建表
    r.DB("blog").TableCreate("posts").Run(session)

    // 插入文档
    newPost := Post{
        Title:     "My First Post",
        Content:   "This is the content of my first post",
        CreatedAt: time.Now(),
        Tags:      []string{"golang", "rethinkdb"},
    }

    res, err := r.Table("posts").Insert(newPost).RunWrite(session)
    if err != nil {
        log.Fatalf("Error inserting post: %v", err)
    }
    fmt.Printf("Inserted %d posts\n", res.Inserted)

    // 查询文档
    cursor, err := r.Table("posts").OrderBy(r.OrderByOpts{Index: "created_at"}).Run(session)
    if err != nil {
        log.Fatalf("Error querying posts: %v", err)
    }
    defer cursor.Close()

    var posts []Post
    err = cursor.All(&posts)
    if err != nil {
        log.Fatalf("Error scanning posts: %v", err)
    }

    fmt.Println("Posts:")
    for _, post := range posts {
        fmt.Printf("- %s (%v)\n", post.Title, post.CreatedAt)
    }
}

日志和调试

// 启用详细日志
r.SetVerbose(true)

// 禁用日志
r.Log.Out = ioutil.Discard

测试和模拟

func TestGetPosts(t *testing.T) {
    mock := r.NewMock()
    mock.On(r.Table("posts")).Return([]interface{}{
        map[string]interface{}{"id": "1", "title": "First Post"},
        map[string]interface{}{"id": "2", "title": "Second Post"},
    }, nil)

    cursor, err := r.Table("posts").Run(mock)
    if err != nil {
        t.Errorf("Error: %v", err)
    }

    var posts []map[string]interface{}
    err = cursor.All(&posts)
    if err != nil {
        t.Errorf("Error: %v", err)
    }

    if len(posts) != 2 {
        t.Errorf("Expected 2 posts, got %d", len(posts))
    }

    mock.AssertExpectations(t)
}

这个驱动库提供了丰富的功能来操作 RethinkDB 数据库，包括连接管理、查询构建、结果处理和模型映射等。通过结构体标签可以方便地定义数据模型与数据库字段的映射关系，还支持高级功能如复合键、引用关系和自定义编解码器等。