📣TiDB Cloud BYOC、TiDB Cloud Filesystem 和 PostgreSQL-compatible TiDB Cloud Starter 全新发布,开放公测中。此页面由 AI 自动翻译,英文原文请见此处。

TiDB Cloud Filesystem SDK



TiDB Cloud Filesystem 使用 Drive9 workspace engine 来执行文件系统操作。TiDB Cloud Filesystem 是 PingCAP 在 TiDB Cloud 上提供的官方托管 Drive9 服务。Drive9 是由 PingCAP 拥有的开源社区项目,而 TiDB Cloud Filesystem 是其托管云服务。在 API 和 SDK layer,你将直接调用由 TiDB Cloud Filesystem 服务暴露的 drive9 endpoint。

Drive9 是一个开源项目(Apache 2.0),维护在 mem9-ai/drive9 仓库 中。除了 workspace engine 之外,该仓库还发布了多种编程语言的客户端 SDK。这些 SDK 及其文档都在该仓库中维护,因此本页列出的指南是 SDK 安装、配置和 API 细节的权威来源。

SDK 指南说明了客户端如何连接到 Drive9 server,包括如何提供 server URL 和 API key。

下表显示了应使用哪种 TiDB Cloud Filesystem 凭证。当 SDK 指南要求提供 API key 时,请使用 file system token。

TiDB Cloud Filesystem 对象Drive9 SDK/API 用法
TiDB Cloud API Key文件系统控制面操作
File System Token文件系统数据面操作

请为每个 TiDB Cloud Filesystem Region 使用以下 server URL。

TiDB Cloud Filesystem RegionDrive9 SDK/API 的 Server URLAPI Key
aws-us-east-1https://aws-us-east-1.drive9.aiFS token
aws-us-west-2https://aws-us-west-2.drive9.aiFS token
aws-ap-southeast-1https://aws-ap-southeast-1.drive9.aiFS token
gcp-us-east1https://gcp-us-east1.drive9.aiFS token
azure-centralushttps://azure-centralus.drive9.aiFS token
alicloud-ap-southeast-1https://alicloud-ap-southeast-1.drive9.aiFS token

始终将 SDK server URL 设置为你的文件系统所在 Region 的 endpoint。如果你未设置 server URL,大多数 SDK 会回退到 https://api.drive9.ai,但这不是 TiDB Cloud Filesystem 的 endpoint,并且会拒绝 TiDB Cloud Filesystem token。file system token 只能与其所属 Region 的 endpoint 一起使用。

可用的 SDK

语言仓库位置文档
TypeScriptclients/drive9-jsTypeScript SDK 集成指南
Gopkg/clientGo SDK 集成指南
Pythonclients/drive9-pydrive9-py README
Rustclients/drive9-rsdrive9-rs README
Kotlinclients/drive9-kotlindrive9-kotlin README
Swiftclients/drive9-swiftdrive9-swift README

这些 SDK 随 Drive9 项目一起开发和发布,因此其进度可能会领先于 TiDB Cloud Filesystem 服务。在你为 TiDB Cloud Filesystem 工作负载采用某个 SDK 之前,请先查看其文档,确认当前的 server endpoint、凭证以及支持的操作。

后续步骤

文档内容是否有帮助?