TiDB Cloud Starter インスタンスを管理する

このドキュメントでは、TiDB Cloud CLI の ti db コマンドを使用して、ターミナルまたは自動化ワークフローから TiDB Cloud Starter インスタンス、ブランチ、および SQL アクセスを管理する方法について説明します。

前提条件

• TiDB Cloud CLI をインストールして設定する。
• TiDB Cloud Starter にアクセスできる認証情報を使用してプロファイルを設定します。

TiDB Cloud Starter インスタンスを作成する

TiDB Cloud Starter インスタンスを作成し、アクティブになるまで待機します。

ti db create-db-cluster --db-cluster-type starter --db-cluster-name app-db --wait

インスタンスを一覧表示する

有効なリージョン内の TiDB Cloud Starter インスタンスを一覧表示します。

ti db list-db-clusters --db-cluster-type starter --output text

TiDB Cloud Starter インスタンスの情報を取得するには、その ID を describe-db-cluster に渡します。

ブランチを管理する

インスタンスから開発ブランチを作成します。

ti db create-db-cluster-branch \
  --db-cluster-id "<instance-id>" \
  --db-cluster-branch-name dev \
  --wait

ブランチの一覧表示、詳細表示、および削除コマンドを使用して、そのライフサイクルを管理します。各コマンドの完全なオプションについては、ti db コマンドリファレンスを参照してください。

SQL アクセスを設定する

インスタンス用の読み取り専用、読み取り/書き込み、および管理者 SQL ユーザーを作成または修復します。

ti db create-db-sql-users --db-cluster-id "<instance-id>"

保存されている認証情報をアプリケーション向けに整形します。

ti db format-db-connection-string \
  --db-cluster-id "<instance-id>" \
  --read-only \
  --format env

SQL を実行する

明示的な SQL ロールを指定して 1 つのステートメントを実行します。

ti db execute-sql-statement \
  --db-cluster-id "<instance-id>" \
  --read-only \
  --sql "SELECT 1"

読み取り専用、読み取り/書き込み、および管理操作を分離するワークフローについては、明示的な SQL ロールで TiDB Cloud Starter をクエリするを参照してください。

インスタンスを削除する

インスタンスが不要になったら、それを削除し、削除が確認できるようになるまで待機します。

ti db delete-db-cluster --db-cluster-id "<instance-id>" --wait

次のステップ

• TiDB Cloud Starter CLI コマンドリファレンス
• 日次の TiDB Cloud CLI ワークフローを実行する