Use ti db to manage TiDB Cloud Starter instances, branches, and SQL access. The CLI rejects instance-scoped operations when the target is not a TiDB Cloud Starter instance or its service plan cannot be verified.
A branch is a separate TiDB Cloud Starter instance that contains a diverged copy of data from its parent instance. Use branches to test changes in isolation without affecting the parent. For more information, see TiDB Cloud Branching.
| Command | Description |
|---|---|
create-db-cluster | Creates a TiDB Cloud Starter instance. |
list-db-clusters | Lists Starter instances in the effective region. |
describe-db-cluster | Describes a TiDB Cloud Starter instance. |
update-db-cluster | Updates a TiDB Cloud Starter instance. |
delete-db-cluster | Deletes a TiDB Cloud Starter instance. |
create-db-cluster-branch | Creates a branch for a TiDB Cloud Starter instance. |
list-db-cluster-branches | Lists branches for a TiDB Cloud Starter instance. |
describe-db-cluster-branch | Describes a branch for a TiDB Cloud Starter instance. |
delete-db-cluster-branch | Deletes a branch from a TiDB Cloud Starter instance. |
create-db-sql-users | Creates or repairs role-based SQL users. |
format-db-connection-string | Formats stored SQL credentials as a connection string. |
execute-sql-statement | Executes one SQL statement. |