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

注記:

TiDB Cloud CLI はベータ版です。

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]使用します。

指示サブコマンド説明
認証ログイン、ログアウトログインとログアウト
サーバーレス (エイリアス: s)作成、削除、説明、一覧表示、更新、支出制限、リージョン、シェルTiDB サーバーレス クラスターを管理する
サーバーレスブランチ作成、削除、説明、一覧表示、シェルTiDB サーバーレスブランチを管理する
サーバーレスインポートキャンセル、説明、リスト、開始TiDB サーバーレスインポートタスクを管理する
サーバーレスエクスポート作成、説明、リスト、キャンセル、ダウンロードTiDB サーバーレスエクスポートタスクを管理する
あい
  • TiDBボットとチャット
    完了bash、フィッシュ、パワーシェル、zsh指定されたシェルの完了スクリプトを生成する
    設定作成、削除、説明、編集、リスト、設定、使用ユーザープロファイルを構成する
    プロジェクトリストプロジェクトの管理
    アップデート
  • CLIを最新バージョンに更新する
    ヘルプクラスター、完了、構成、ヘルプ、インポート、プロジェクト、更新任意のコマンドのヘルプをビュー

    コマンドモード

    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、--デバッグデバッグモードを有効にするいいえ非対話型モードと対話型モードの両方で動作します。

    フィードバック

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

    このページは役に立ちましたか?

    Playground
    新規
    登録なしで TiDB の機能をワンストップでインタラクティブに体験できます。
    製品
    TiDB Cloud
    TiDB
    価格
    PoC お問い合わせ
    エコシステム
    TiKV
    TiFlash
    OSS Insight
    © 2024 PingCAP. All Rights Reserved.
    Privacy Policy.