TiDB Cloud CLI (ti) 概述
TiDB Cloud CLI (ti) 是一个用于管理 TiDB Cloud Starter 实例和 TiDB Cloud Filesystems 的 CLI。它同时适用于交互式使用和自动化场景,并且默认提供结构化的 JSON 输出。
TiDB Cloud Filesystem
TiDB Cloud Filesystem 是一个面向 AI agent 和自动化工作负载设计的无服务器分布式文件系统。它提供持久、可共享的文件命名空间,并且独立于访问它的本地机器、沙箱或 CI runner 持续可用,因此非常适合持久化存储、共享工作区以及 AI agent 工作流。
何时使用 TiDB Cloud CLI (ti)
当你希望通过终端、脚本、CI 作业或 AI agent 环境来管理 TiDB Cloud 时,请使用 TiDB Cloud CLI (ti)。
对于可视化、引导式工作流,请使用 TiDB Cloud console。对于 TiDB Cloud Essential 或 ti 不支持的操作,请使用 ticloud。
TiDB Cloud CLI 管理的内容
TiDB Cloud CLI 涵盖以下功能领域:
- TiDB Cloud Starter
- 实例和分支生命周期操作
- SQL 用户和连接信息
- SQL 语句执行
- TiDB Cloud Filesystem
- Filesystem 生命周期和文件操作
- FUSE 和 WebDAV 挂载
- 层、packs 和 Git 工作区
- Journals 和 vaults
- CLI 配置
- Profiles、regions 和本地凭证
- CLI 更新
- 输出格式化和 JMESPath 查询
大多数资源命令遵循两级命令模型:
ti <command-group> <operation>
例如,ti db list-db-clusters --db-cluster-type starter、ti fs copy-file 和 ti fs-journal verify-journal。
你还可以使用顶层命令 ti configure 和 ti update 来配置和维护 CLI。
ti 与 ticloud 的区别
TiDB Cloud 当前提供两个作用域不同的 CLI:ti 和 ticloud。
ti 专为 TiDB Cloud Starter 的自动化以及 TiDB Cloud Filesystems 管理而设计,而 ticloud 继续支持 TiDB Cloud Essential 以及 ti 中尚不可用的其他 TiDB Cloud 操作。
ti 并不替代 ticloud。请根据你需要的资源和操作选择 CLI:
- 对于新的 TiDB Cloud Starter 自动化工作流,如果
ti支持你需要的操作,请使用ti。 - 对于管理 TiDB Cloud Filesystems,请使用
ti。 - 如果你已有用于 TiDB Cloud Starter 或 TiDB Cloud Essential 的
ticloud工作流,可以继续使用它们。 - 对于 TiDB Cloud Essential 或
ti中不可用的操作(例如数据导入、数据导出和审计日志操作),请使用ticloud。
后续步骤
如果你是第一次使用 TiDB Cloud CLI,请先阅读快速开始,安装 ti、配置 profile,并完成一个基础的 TiDB Cloud Starter 或 Filesystem 工作流。
然后根据你的目标继续阅读:
- 管理 TiDB Cloud Starter 实例
- 管理 TiDB Cloud Filesystems
- 按照端到端工作流操作:从运行日常 TiDB Cloud CLI 工作流或在 Agent Sandbox 中使用 TiDB Cloud Filesystem开始
- 查找特定命令:查看 TiDB Cloud CLI 命令参考
- 查看 TiDB Cloud CLI 的新功能:查看 TiDB Cloud CLI (
ti) Release Notes - 报告问题:在 TiDB Cloud CLI GitHub repository 中创建 issue。