Golang

Databend 提供了一个用 Golang 编写的驱动程序（databend-go），它便于使用 Golang 编程语言开发应用程序并与 Databend 建立连接。

有关安装说明、示例和源代码，请参见 GitHub 上的 databend-go 仓库。

Databend Go 驱动行为总结

Databend 的 Go Driver 兼容 "database/sql" 接口规范。下面列出了一些常见的基本行为，及其涉及的关键函数和原理。

基本行为	涉及的关键函数	原理
创建连接	DB.Open	使用 DSN 字符串和 DB.Open 方法建立与 Databend 的连接。 DSN 字符串格式为 https://user:password@host/database?<query_option>=<value>。
执行语句	DB.Exec	DB.Exec 方法利用 v1/query 接口执行 SQL 语句，进行数据表的创建、删除和数据的插入操作。
批量插入	DB.Begin, Tx.Prepare, Stmt.Exec, Tx.Commit	批量插入/替换数据（INSERT INTO 和 REPLACE INTO）通过事务进行处理。 利用 Stmt.Exec，向已创建的语句对象添加尽可能多的数据，数据将会追加到文件中。 执行 Tx.Commit() 最终会上传数据到内置 Stage 并执行插入/替换操作，使用 Stage Attachment。
查询单行数据	DB.QueryRow, Row.Scan	通过 DB.QueryRow 方法查询单行数据并返回一个 *sql.Row，随后调用 Row.Scan 方法将列数据映射到变量中。
遍历多行数据	DB.Query, Rows.Next, Rows.Scan	通过 DB.Query 方法查询多行数据并返回一个 *sql.Rows 结构体，使用 Rows.Next 方法迭代遍历行，并使用 Rows.Scan 映射数据到变量中。
上传文件到内部 Stage	APIClient.UploadToStage	上传数据到 Stage。默认使用 PRESIGN UPLOAD 获得 URL，或者如果 PRESIGN 被禁用，则使用 v1/upload_to_stage API。

教程 -1：使用 Golang 与 Databend 集成

在开始之前，请确保您已成功安装了本地的 Databend。有关详细说明，请参见 本地和 Docker 部署。

步骤 1. 准备一个 SQL 用户账户

要将您的程序连接到 Databend 并执行 SQL 操作，您必须在代码中提供具有适当权限的 SQL 用户账户。如果需要，请在 Databend 中创建一个，并确保 SQL 用户仅具有出于安全考虑所需的权限。

本教程使用名为 'user1'，密码为 'abc123' 的 SQL 用户作为示例。由于程序将向 Databend 写入数据，因此用户需要 ALL 权限。有关如何管理 SQL 用户及其权限，请参见 用户与角色。

CREATE USER user1 IDENTIFIED BY 'abc123';
GRANT ALL on *.* TO user1;

步骤 2. 编写一个 Golang 程序

在此步骤中，您将创建一个简单的 Golang 程序，该程序与 Databend 通信。程序将涉及创建表、插入数据和执行数据查询等任务。

1

将以下代码复制并粘贴到文件 main.go 中

备注

• 下面的代码以用户名 "user1" 的 SQL 用户和密码 "abc123" 为例连接到本地 Databend 实例。在保持相同格式的条件下，您可以随意使用自己的值。
• 代码下方的 hostname 值必须与您的 Databend 查询服务的 HTTP 处理程序设置保持一致。

main.go

package main

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

    _ "github.com/databendcloud/databend-go"
)

const (
    username = "user1"
    password = "abc123"
    hostname = "127.0.0.1:8000"
)

type Book struct {
    Title  string
    Author string
    Date   string
}

func dsn() string {
    return fmt.Sprintf("http://%s:%s@%s", username, password, hostname)
}

func main() {
    db, err := sql.Open("databend", dsn())

    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    err = db.Ping()
    if err != nil {
        log.Fatal(err)
    }
    log.Println("Connected")

    // 如果不存在则创建数据库
    dbSql := "CREATE DATABASE IF NOT EXISTS book_db"
    _, err = db.Exec(dbSql)
    if err != nil {
        log.Fatal(err)
    }
    log.Println("成功创建数据库 book_db")

    // 使用 book_db 数据库
    _, err = db.Exec("USE book_db")
    if err != nil {
        log.Fatal(err)
    }

    // 创建表。
    sql := "create table if not exists books(title VARCHAR, author VARCHAR, date VARCHAR)"
    _, err = db.Exec(sql)
    if err != nil {
        log.Fatal(err)
    }
    log.Println("创建表：books")

    // 插入 1 行数据。
    _, err = db.Exec("INSERT INTO books VALUES(?, ?, ?)", "mybook", "author", "2022")
    if err != nil {
        log.Fatal(err)
    }
    log.Println("插入 1 行数据")

    // 查询。
    res, err := db.Query("SELECT * FROM books")
    if err != nil {
        log.Fatal(err)
    }

    for res.Next() {
        var book Book
        err := res.Scan(&book.Title, &book.Author, &book.Date)
        if err != nil {
            log.Fatal(err)
        }

        log.Printf("查询：%v", book)
    }
    db.Exec("drop table books")
    db.Exec("drop database book_db")
}

2

安装依赖项。

go mod init databend-golang

go.mod

module databend-golang

go 1.20

require github.com/databendcloud/databend-go v0.3.10

require (
    github.com/BurntSushi/toml v1.2.1 // indirect
    github.com/avast/retry-go v3.0.0+incompatible // indirect
    github.com/google/uuid v1.3.0 // indirect
    github.com/pkg/errors v0.9.1 // indirect
    github.com/sirupsen/logrus v1.9.0 // indirect
    golang.org/x/sys v0.5.0 // indirect
)

3

运行程序。

go run main.go

输出

2023/02/24 23:57:31 Connected
2023/02/24 23:57:31 Create database book_db success
2023/02/24 23:57:31 Create table: books
2023/02/24 23:57:31 Insert 1 row
2023/02/24 23:57:31 Select:{mybook author 2022}

教程 -2：使用 Golang 与 Databend Cloud 集成

在开始之前，请确保您已成功创建一个计算集群并获取了连接信息。有关如何操作，请参见 连接到计算集群。

步骤 1. 创建一个 Go 模块

$ mkdir sample
$ cd sample
$ go mod init cloud.databend.com/sample

步骤 2. 安装依赖项

$ go get github.com/databendcloud/databend-go

步骤 3. 使用 databend-go 连接

创建一个名为 main.go 的文件，并使用以下代码：

package main

import (
    "database/sql"
    "fmt"

    _ "github.com/databendcloud/databend-go"
)

func main() {
    dsn := "databend://{USER}:{PASSWORD}@${HOST}:443/{DATABASE}?&warehouse={WAREHOUSE_NAME}";
    conn, err := sql.Open("databend", dsn)
    if err != nil {
        fmt.Println(err)
    }
    conn.Exec(`DROP TABLE IF EXISTS data`)
    createTable := `CREATE TABLE  IF NOT EXISTS data (
        i64 Int64,
        u64 UInt64,
        f64 Float64,
        s   String,
        s2  String,
        a16 Array(Int16),
        a8  Array(UInt8),
        d   Date,
        t   DateTime)`
    _, err = conn.Exec(createTable)
    if err != nil {
        fmt.Println(err)
    }
    scope, err := conn.Begin()
    batch, err := scope.Prepare(fmt.Sprintf("INSERT INTO %s VALUES", "data"))
    if err != nil {
        fmt.Println(err)
    }
    for i := 0; i < 10; i++ {
        _, err = batch.Exec(
            "1234",
            "2345",
            "3.1415",
            "test",
            "test2",
            "[4, 5, 6]",
            "[1, 2, 3]",
            "2021-01-01",
            "2021-01-01 00:00:00",
        )
    }
    err = scope.Commit()
    if err != nil {
        fmt.Println(err)
    }
}

提示

将代码中的 {USER}、{PASSWORD}、{HOST}, {WAREHOUSE_NAME} 和 {DATABASE} 替换为您的连接信息。有关如何 获取连接信息， 请参阅连接到计算集群。

第 4 步。运行 main.go

$ go run main.go