TiDB CloudCLI リファレンス

TiDB Cloud CLI はコマンド ライン インターフェイスであり、数行のコマンドで端末からTiDB Cloudを操作できるようになります。 TiDB Cloud CLI では、 TiDB Cloudクラスターの管理、クラスターへのデータのインポート、その他の操作の実行が簡単に行えます。

あなたが始める前に

必ず最初にTiDB Cloud CLI 環境をセットアップするを行ってください。 ticloud CLI をインストールすると、それを使用してコマンド ラインからTiDB Cloudクラスターを管理できるようになります。

利用可能なコマンド

次の表に、 TiDB Cloud CLI で使用できるコマンドを示します。

ターミナルでticloud CLI を使用するには、 ticloud [command] [subcommand]を実行します。 TiUP使用している場合は、代わりにtiup cloud [command] [subcommand]を使用してください。

コマンドモード

TiDB Cloud CLI は、簡単に使用できるようにいくつかのコマンドに対して 2 つのモードを提供します。

• インタラクティブモード

  フラグ ( ticloud config createなど) を指定せずにコマンドを実行すると、CLI によって入力を求めるプロンプトが表示されます。

• 非対話型モード

  コマンドの実行時に必要なすべての引数とフラグticloud config create --profile-name <profile-name> --public-key <public-key> --private-key <private-key>など) を指定する必要があります。

ユーザープロフィール

TiDB Cloud CLI の場合、ユーザー プロファイルは、プロファイル名、公開キー、秘密キーなど、ユーザーに関連付けられたプロパティのコレクションです。 TiDB Cloud CLI を使用するには、最初にユーザー プロファイルを作成する必要があります。

ユーザープロファイルを作成する

ユーザー プロファイルを作成するにはticloud config createを使用します。

すべてのユーザープロファイルをリストする

すべてのユーザー プロファイルをリストするにはticloud config listを使用します。

出力例は次のとおりです。

Profile Name
default (active)
dev
staging

この出力例では、ユーザー プロファイルdefaultが現在アクティブです。

ユーザープロフィールを説明する

ユーザー プロファイルのプロパティを取得するには、 ticloud config describeを使用します。

出力例は次のとおりです。

{
  "private-key": "xxxxxxx-xxx-xxxxx-xxx-xxxxx",
  "public-key": "Uxxxxxxx"
}

ユーザープロファイルでプロパティを設定する

ユーザー プロファイルのプロパティを設定するにはticloud config setを使用します。

別のユーザー プロファイルに切り替える

別のユーザー プロファイルに切り替えるにはticloud config useを使用します。

出力例は次のとおりです。

Current profile has been changed to default

設定ファイルを編集する

編集のために構成ファイルを開くには、 ticloud config editを使用します。

ユーザープロファイルを削除する

ユーザー プロファイルを削除するにはticloud config deleteを使用します。

グローバルフラグ

次の表に、 TiDB Cloud CLI のグローバル フラグを示します。

フィードバック

TiDB Cloud CLI に関して質問や提案がある場合は、お気軽に問題を作成してください。また、貢献も歓迎します。