English | 简体中文
driver-go
是 TDengine 的官方 Go 语言连接器,实现了 Go 语言 database/sql
包的接口。Go 开发人员可以通过它开发存取
TDengine 集群数据的应用软件。
- 使用 GO Connector, 请参考 开发指南,包含了应用如何引入
driver-go
和数据写入、查询、无模式写入、参数绑定和数据订阅等示例。 - 其他参考信息请见 参考手册,包含了版本历史、数据类型、示例程序汇总、API 说明和常见问题等。
- 本 README 主要是为想自己贡献、编译、测试 Go Connector的开发者写的。如果要学习 TDengine,可以浏览 官方文档。
- 已安装 Go 1.14 或以上版本,并允许 CGO
export CGO_ENABLED=1
。 - 本地已经部署 TDengine,具体步骤请参考 部署服务端,且已经启动 taosd 与 taosAdapter。
不需要构建。
- 执行测试前确保已经安装 TDengine 服务端,并且已经启动 taosd 与 taosAdapter,数据库干净无数据。
- 项目目录下执行
go test ./...
运行测试,测试会连接到本地的 TDengine 服务器与 taosAdapter 进行测试。 - 输出结果
PASS
为测试通过,FAIL
为测试失败,查看详细信息需要执行go test -v ./...
。
在 *_test.go
文件中添加测试用例,确保测试用例覆盖到新增的代码。
性能测试还在开发中。
我们欢迎提交 GitHub Issue。 提交时请说明下面信息:
- 问题描述,是否必现。
- 驱动版本。
- 连接参数(不需要服务器地址、用户名和密码)。
- TDengine 版本。
我们欢迎开发者一起开发本项目,提交 PR 时请参考下面步骤:
- Fork 本项目,请参考 (how to fork a repo)。
- 从 main 分支创建一个新分支,请使用有意义的分支名称 (
git checkout -b my_branch
)。 - 修改代码,保证所有单元测试通过,并增加新的单元测试验证修改。
- 提交修改到远端分支 (
git push origin my_branch
)。 - 在 GitHub 上创建一个 Pull Request (how to create a pull request)。
- 提交 PR 后,可以通过 Pull Request 找到自己的 PR,点击对应链接进去可以看到自己 PR CI 是否通过,如果通过会显示 “All checks have passed”。无论 CI 是否通过,都可以点击 “Show all checks” -> “Details” 来查看详细用例日志。
- 提交 PR 后,如果 CI 通过,可以在 codecov 页面找到自己 PR 查看覆盖率。