Apache Avatica/Phoenix SQL Driver 技术文档

1. 安装指南

1.1 使用 Go Modules 安装

要安装 Apache Avatica/Phoenix SQL Driver，可以使用 Go Modules 进行安装。执行以下命令：

$ go get github.com/apache/calcite-avatica-go

1.2 导入包

安装完成后，需要在代码中导入 database/sql 包和驱动包：

import "database/sql"
import _ "github.com/apache/calcite-avatica-go/v5"

2. 项目的使用说明

2.1 连接数据库

使用 sql.Open 方法连接到 Avatica 服务器。以下是一个简单的示例：

db, err := sql.Open("avatica", "http://localhost:8765")
if err != nil {
    log.Fatal(err)
}
defer db.Close()

2.2 执行查询

连接成功后，可以使用数据库连接对象执行 SQL 查询。例如：

rows, err := db.Query("SELECT COUNT(*) FROM test")
if err != nil {
    log.Fatal(err)
}
defer rows.Close()

3. 项目API使用文档

3.1 sql.Open 方法

sql.Open 方法用于打开一个数据库连接。它接受两个参数：

• 第一个参数是驱动名称，这里是 "avatica"。
• 第二个参数是数据源名称（DSN），通常是一个 URL，例如 "http://localhost:8765"。

3.2 db.Query 方法

db.Query 方法用于执行 SQL 查询。它返回一个 sql.Rows 对象，可以通过该对象遍历查询结果。

3.3 rows.Close 方法

rows.Close 方法用于关闭查询结果集，释放资源。

4. 项目安装方式

4.1 使用 Go Modules

推荐使用 Go Modules 进行安装，具体步骤如下：

1. 在项目根目录下初始化 Go Modules：

   $ go mod init your_project_name
   

2. 安装驱动：

   $ go get github.com/apache/calcite-avatica-go
   

3. 在代码中导入驱动包并使用。

4.2 手动下载源码

如果需要手动下载源码，可以访问 GitHub 项目页面 下载源码包，然后手动编译和安装。

5. 测试指南

5.1 运行测试

要运行项目的测试，可以参考 测试指南。通常需要安装 Docker 和 Docker Compose，然后执行以下命令：

$ docker compose run test

5.2 手动设置测试环境

如果需要手动设置测试环境，可以按照以下步骤操作：

1. 安装 Go 和 Docker。

2. 设置环境变量 HSQLDB_HOST 和 PHOENIX_HOST。

3. 选择测试套件并运行测试：

   $ export AVATICA_FLAVOR=HSQLDB
   $ go test -v ./...
   

6. 问题反馈

如果在使用过程中遇到问题，可以通过 Calcite's JIRA 提交问题，并选择 avatica-go 作为组件。