SDK 使用说明
更新时间:2026-07-24
TSDB 专享版兼容 InfluxDB 3 V3 数据写入和查询接口。您可以使用开源 InfluxDB 3 客户端写入 Line Protocol 数据,并通过 SQL 查询数据。
SDK 用于数据读写。创建 Database、Table、Retention 和业务访问令牌时,请使用 CLI 工具或资源管理 API。
使用前准备
使用 SDK 前,请完成以下准备工作:
- 创建 TSDB 专享版集群,并确保应用所在网络可以访问集群。
- 获取集群访问地址。具体操作请参见连接地址与认证。
- 创建 Database。具体操作请参见管理 Database 与 Retention。
- 创建具有目标 Database 读写权限的业务访问令牌。具体操作请参见管理业务访问令牌。
选择 SDK
| 语言 | SDK | 使用文档 |
|---|---|---|
| Java | com.influxdb:influxdb3-java |
Java SDK |
| Python | influxdb3-python |
Python SDK |
| Go | github.com/InfluxCommunity/influxdb3-go/v2 |
Go SDK |
| JavaScript | @influxdata/influxdb3-client |
JavaScript SDK |
各语言页面中的安装命令使用与示例代码相匹配的 SDK 版本。
连接参数
初始化客户端时需要配置以下信息:
| 参数 | 说明 |
|---|---|
| 集群访问地址 | 集群详情页显示的明文 HTTP 访问地址,包括协议、主机名和端口。写入和查询使用同一个地址;当前不支持 HTTPS / TLS |
| Database | 写入和查询数据的目标 Database 名称 |
| 业务访问令牌 | 具有目标 Database 所需读写权限的令牌 |
SDK 会根据客户端配置访问相应的数据接口,无需在集群访问地址后手动拼接 API 路径。
写入和查询数据
TSDB 专享版使用 V3 写入接口。各语言示例已经包含启用 V3 写入所需的配置,复制示例时请保留该配置;缺少该配置时,SDK 会调用 TSDB 专享版不提供的 V2 写入接口导致写入失败,参见常见问题。
- 写入数据使用 Line Protocol。格式说明请参见使用 Line Protocol 写入数据。
- 查询数据使用 SQL,查询结果由 Flight 接口返回。具体说明请参见使用 SQL 与 Flight SQL 查询数据。
- SDK 查询不支持 InfluxQL。
首次向新的 measurement 写入数据时,服务端会自动创建对应的 Table,新表通常在约 5 秒后可以查询,实际时间可能受集群运行状态影响。因此,首次建表后请等待约 5 秒再查询。该等待只适用于首次写入创建 Table 的场景;向已有 Table 写入不受影响。
管理数据库资源
SDK 不用于管理 Database、Table、Retention 或业务访问令牌。如需管理这些资源,可以使用以下方式:
安全建议
- 不要在源代码中保存业务访问令牌,建议通过环境变量或密钥管理服务注入。
- 不要在日志中记录令牌、完整请求头或包含敏感数据的请求内容。
- JavaScript SDK 应在 Node.js 服务端使用,不要把业务访问令牌暴露在浏览器代码中。
- SDK 由开源社区维护。升级依赖前,请阅读相应版本的发布说明并在业务环境中完成兼容性检查。
评价此篇文章
