TiDB Cloud CLI リファレンス (ベータ版)

注記：

現在、 TiDB Cloud CLIはベータ版であり、 TiDB Cloud Dedicatedクラスタには適用できません。

TiDB Cloud CLIはコマンドラインインターフェースであり、ターミナルから数行のコマンドを入力するだけでTiDB Cloudを操作できます。TiDB Cloud CLIを使用すると、 TiDB Cloud StarterおよびEssentialインスタンスを簡単に管理したり、インスタンスにデータをインポートしたり、その他の操作を実行したりできます。

始める前に

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

使用可能なコマンド

以下の表は、TiDB Cloud CLIで使用できるコマンドの一覧です。

ターミナルでticloud CLIを使用するには、 ticloud [command] [subcommand]を実行してください。TiUP 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 では、ユーザープロファイルとは、プロファイル名、公開鍵、秘密鍵、OAuth トークンなど、ユーザーに関連付けられたプロパティの集合です。TiDB Cloud CLI を使用するには、ユーザープロファイルが必要です。

TiDB Cloud APIキーを使用してユーザープロファイルを作成します。

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

OAuthトークンを使用してユーザープロファイルを作成します。

ticloud auth login使用して、現在のプロファイルに OAuth トークンを割り当てます。プロファイルが存在しない場合は、 defaultという名前のプロファイルが自動的に作成されます。

注記：

上記2つの方法では、 TiDB Cloud APIキーがOAuthトークンよりも優先されます。現在のプロファイルに両方が存在する場合は、APIキーが使用されます。

すべてのユーザープロファイルを一覧表示します

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 に関してご質問やご提案がありましたら、お気軽に問題ご報告ください。また、皆様からの貢献も歓迎いたします。