TiDB Cloud CLI リファレンス（ベータ版）
注記：
現在、 TiDB Cloud CLI はベータ版であり、 TiDB Cloud Dedicated クラスターには適用されません。
TiDB Cloud CLIは、数行のコマンドでターミナルからTiDB Cloudを操作できるコマンドラインインターフェースです。TiDB TiDB Cloud CLIでは、 TiDB Cloudクラスタの管理、クラスタへのデータのインポート、その他多くの操作を簡単に実行できます。
始める前に
最初にTiDB Cloud CLI環境をセットアップする必ず実行してください。3 CLI ticloudインストールしたら、それを使用してコマンドラインからTiDB Cloudクラスターを管理できます。
利用可能なコマンド
次の表は、TiDB Cloud CLI で使用できるコマンドの一覧です。
ターミナルでticloud CLI を使用するには、 ticloud [command] [subcommand]実行してください。 TiUP使用している場合は、代わりにtiup cloud [command] [subcommand]実行してください。
| 指示 | サブコマンド | 説明 |
|---|---|---|
| 認証 | ログイン、ログアウト、whoami | ログインとログアウト |
| サーバーレス（別名: s） | 作成、削除、説明、一覧表示、更新、支出制限、リージョン、シェル | TiDB Cloud Starter またはTiDB Cloud Essential クラスターを管理する |
| サーバーレスブランチ | 作成、削除、説明、一覧表示、シェル | TiDB Cloud Starter またはTiDB Cloud Essential クラスターのブランチを管理する |
| サーバーレスインポート | キャンセル、説明、リスト、開始 | TiDB Cloud Starter またはTiDB Cloud Essential クラスターのインポート タスクを管理します |
| サーバーレスエクスポート | 作成、説明、リスト、キャンセル、ダウンロード | TiDB Cloud Starter またはTiDB Cloud Essential クラスターのエクスポート タスクを管理します |
| サーバーレスSQLユーザー | 作成、リスト、削除、更新 | TiDB Cloud Starter またはTiDB Cloud Essential クラスターの SQL ユーザーを管理します |
| サーバーレス監査ログ | config、describe、filter-rule（別名:filter）、download | TiDB Cloud Starter またはTiDB Cloud Essential クラスターのデータベース監査ログを管理します |
| 愛 | TiDBボットとチャット | |
| 完了 | bash、fish、powershell、zsh | 指定されたシェルの補完スクリプトを生成する |
| 設定 | 作成、削除、説明、編集、一覧表示、設定、使用 | ユーザープロファイルを構成する |
| プロジェクト | リスト | プロジェクトの管理 |
| アップグレード | CLIを最新バージョンに更新する | |
| ヘルプ | 認証、構成、サーバーレス、AI、プロジェクト、アップグレード、ヘルプ、完了 | 任意のコマンドのヘルプをビュー |
コマンドモード
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 TiDB Cloud CLI を使用するには、ユーザープロファイルが必要です。
TiDB Cloud APIキーを使用してユーザープロファイルを作成する
ticloud config create使用してユーザー プロファイルを作成します。
OAuthトークンを使用してユーザープロファイルを作成する
現在のプロファイルにOAuthトークンを割り当てるには、 ticloud auth login使用します。プロファイルが存在しない場合は、 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 のグローバル フラグを示しています。
| フラグ | 説明 | 必須 | 注記 |
|---|---|---|---|
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用されるアクティブなユーザー プロファイルを指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグモードを有効にする | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
フィードバック
TiDB Cloud CLI についてご質問やご提案がございましたら、お気軽に問題作成してください。また、皆様からの貢献も歓迎いたします。