Yandex Database (YDB) 在 Golang 中的使用

Yandex Database (YDB) 是 Yandex 开发的分布式数据库系统，支持 SQL 查询和 ACID 事务。在 Golang 中，我们可以通过两种方式连接 YDB：

1. 原生驱动 ydb-go-sdk
2. 通过 database/sql 接口的标准方式

1. 原生驱动 ydb-go-sdk 使用

安装

go get github.com/ydb-platform/ydb-go-sdk/v3

基本示例

package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/ydb-platform/ydb-go-sdk/v3"
	"github.com/ydb-platform/ydb-go-sdk/v3/table"
	"github.com/ydb-platform/ydb-go-sdk/v3/table/options"
	"github.com/ydb-platform/ydb-go-sdk/v3/table/result"
	"github.com/ydb-platform/ydb-go-sdk/v3/table/types"
)

func main() {
	ctx := context.Background()
	
	// 创建连接
	db, err := ydb.Open(ctx,
		"grpcs://ydb.serverless.yandexcloud.net:2135/ru-central1/b1g8skpblkos03malf3s/etn02qso4h3isjb00te1",
		ydb.WithAccessTokenCredentials("your-access-token"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close(ctx)

	// 创建表
	err = createTable(ctx, db.Table())
	if err != nil {
		log.Fatal(err)
	}

	// 插入数据
	err = upsertData(ctx, db.Table())
	if err != nil {
		log.Fatal(err)
	}

	// 查询数据
	err = selectData(ctx, db.Table())
	if err != nil {
		log.Fatal(err)
	}
}

func createTable(ctx context.Context, c table.Client) error {
	return c.Do(ctx,
		func(ctx context.Context, s table.Session) error {
			return s.CreateTable(ctx, "example",
				options.WithColumn("id", types.TypeUint64),
				options.WithColumn("name", types.TypeUTF8),
				options.WithColumn("created_at", types.TypeTimestamp),
				options.WithPrimaryKeyColumn("id"),
			)
		},
	)
}

func upsertData(ctx context.Context, c table.Client) error {
	return c.Do(ctx,
		func(ctx context.Context, s table.Session) error {
			_, _, err := s.Execute(ctx,
				table.DefaultTxControl(),
				"DECLARE $id AS Uint64; DECLARE $name AS Utf8; DECLARE $created_at AS Timestamp;"+
					"UPSERT INTO example (id, name, created_at) VALUES ($id, $name, $created_at);",
				table.NewQueryParameters(
					table.ValueParam("$id", types.Uint64Value(1)),
					table.ValueParam("$name", types.UTF8Value("Alice")),
					table.ValueParam("$created_at", types.TimestampValueFromTime(time.Now())),
				),
			)
			return err
		},
	)
}

func selectData(ctx context.Context, c table.Client) error {
	return c.Do(ctx,
		func(ctx context.Context, s table.Session) error {
			_, res, err := s.Execute(ctx,
				table.DefaultTxControl(),
				"SELECT id, name, created_at FROM example WHERE id = $id;",
				table.NewQueryParameters(
					table.ValueParam("$id", types.Uint64Value(1)),
				),
			)
			if err != nil {
				return err
			}
			defer res.Close()
			
			for res.NextResultSet(ctx) {
				for res.NextRow() {
					var (
						id        uint64
						name      string
						createdAt time.Time
					)
					if err := res.Scan(&id, &name, &createdAt); err != nil {
						return err
					}
					fmt.Printf("id: %d, name: %q, created_at: %v\n", id, name, createdAt)
				}
			}
			return res.Err()
		},
	)
}

2. 通过 database/sql 接口使用

安装

go get github.com/ydb-platform/ydb-go-sdk/v3
go get github.com/ydb-platform/ydb-go-sdk-auth-environ

基本示例

package main

import (
	"context"
	"database/sql"
	"fmt"
	"log"
	"time"

	"github.com/ydb-platform/ydb-go-sdk/v3"
	ydbsql "github.com/ydb-platform/ydb-go-sdk/v3/sql"
)

func main() {
	ctx := context.Background()
	
	// 创建连接
	dsn := "grpcs://ydb.serverless.yandexcloud.net:2135/ru-central1/b1g8skpblkos03malf3s/etn02qso4h3isjb00te1"
	nativeDriver, err := ydb.Open(ctx, dsn)
	if err != nil {
		log.Fatal(err)
	}
	defer nativeDriver.Close(ctx)

	// 创建 database/sql 连接
	connector, err := ydbsql.Connector(nativeDriver)
	if err != nil {
		log.Fatal(err)
	}
	
	db := sql.OpenDB(connector)
	defer db.Close()

	// 创建表
	_, err = db.ExecContext(ctx, `
		CREATE TABLE IF NOT EXISTS example_sql (
			id Uint64,
			name Utf8,
			created_at Timestamp,
			PRIMARY KEY (id)
		)
	`)
	if err != nil {
		log.Fatal(err)
	}

	// 插入数据
	_, err = db.ExecContext(ctx, `
		UPSERT INTO example_sql (id, name, created_at) VALUES (?, ?, ?)
	`, 1, "Bob", time.Now())
	if err != nil {
		log.Fatal(err)
	}

	// 查询数据
	rows, err := db.QueryContext(ctx, `
		SELECT id, name, created_at FROM example_sql WHERE id = ?
	`, 1)
	if err != nil {
		log.Fatal(err)
	}
	defer rows.Close()

	for rows.Next() {
		var (
			id        uint64
			name      string
			createdAt time.Time
		)
		if err := rows.Scan(&id, &name, &createdAt); err != nil {
			log.Fatal(err)
		}
		fmt.Printf("id: %d, name: %q, created_at: %v\n", id, name, createdAt)
	}
	if err := rows.Err(); err != nil {
		log.Fatal(err)
	}
}

两种方式的比较

1. 原生驱动 (ydb-go-sdk)

   • 提供更完整的 YDB 功能支持
   • 支持更精细的控制和优化
   • 性能更好
   • 语法更接近 YDB 原生接口

2. database/sql 接口

   • 更符合标准 SQL 接口习惯
   • 可以更容易地与其他数据库切换
   • 代码更简洁
   • 功能可能受限于标准接口的限制

最佳实践建议

• 如果项目需要充分利用 YDB 的特定功能，建议使用原生驱动
• 如果项目需要数据库抽象层或可能切换数据库，建议使用 database/sql 接口
• 对于新项目，可以从 database/sql 接口开始，需要时再切换到原生驱动

两种方式可以混合使用，因为 ydb-go-sdk 提供了 Connector 接口，可以在同一个应用中同时使用两种方式访问 YDB。