TiDB CloudCLI クイック スタート

TiDB Cloud は、数行のコマンドで端末からTiDB Cloudと対話するためのコマンドライン インターフェイス (CLI) ticloudを提供します。たとえば、 ticloudを使用して次の操作を簡単に実行できます。

  • クラスターを作成、削除、および一覧表示します。
  • クラスターにデータをインポートします。
  • クラスターからデータをエクスポートします。

注記:

TiDB Cloud CLI はベータ版です。

始める前に

インストール

  • macOS/Linux
  • Windows

macOS または Linux の場合、次のいずれかの方法でticloudインストールできます。

  • スクリプト経由でインストールする(推奨)

    curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh
  • TiUP経由でインストール

    tiup install cloud
  • 手動でインストールする

    リリースページからコンパイル済みバイナリをダウンロードし、インストール先の場所にコピーします。

  • GitHub Actionsにインストール

    GitHub Action でticloud設定するには、 setup-tidbcloud-cli使用します。

MySQL コマンドライン クライアントがない場合はインストールしてください。パッケージ マネージャーを使用してインストールできます。

  • Debian ベースのディストリビューション:

    sudo apt-get install mysql-client
  • RPM ベースのディストリビューション:

    sudo yum install mysql
  • macOS:

    brew install mysql-client

Windows の場合、次のいずれかの方法でticloudインストールできます。

  • 手動でインストールする

    リリースページからコンパイル済みバイナリをダウンロードし、インストール先の場所にコピーします。

  • GitHub Actionsにインストール

    GitHub Actions でticloud設定するには、 setup-tidbcloud-cli使用します。

MySQL コマンドライン クライアントがインストールされていない場合はインストールしてください。インストール方法についてはWindows 用 MySQL インストーラの手順を参照してください。Windows でticloud connectを起動するには、PATH 環境変数にmysql.exe含むディレクトリが含まれている必要があります。

クイックスタート

TiDB Cloudサーバーレス TiDB Cloudを使い始めるのに最適な方法です。このセクションでは、 TiDB Cloud CLI を使用してTiDB Cloud Serverless クラスターを作成する方法を学習します。

ユーザープロファイルを作成するか、 TiDB Cloudにログインします

TiDB Cloud CLI を使用してクラスターを作成する前に、ユーザー プロファイルを作成するか、 TiDB Cloudにログインする必要があります。

  • TiDB CloudAPI キーでユーザープロファイルを作成します:

    ticloud config create
  • 認証を使用してTiDB Cloudにログインします。

    ticloud auth login

    ログインに成功すると、OAuth トークンが現在のプロファイルに割り当てられます。プロファイルが存在しない場合は、トークンはdefaultという名前のプロファイルに割り当てられます。

注記:

前述の 2 つの方法では、 TiDB Cloud API キーが OAuth トークンよりも優先されます。両方が利用可能な場合は、API キーが使用されます。

TiDB Cloud Serverless クラスターを作成する

TiDB Cloud Serverless クラスターを作成するには、次のコマンドを入力し、CLI プロンプトに従って必要な情報を入力します。

ticloud serverless create

TiDB CloudCLIを使用する

利用可能なすべてのコマンドをビュー:

ticloud --help

最新バージョンを使用していることを確認してください:

ticloud version

そうでない場合は、最新バージョンに更新してください。

ticloud update

TiUP経由でTiDB Cloud CLI を使用する

TiDB Cloud CLI は、コンポーネント名がcloudTiUPからも利用できます。

利用可能なすべてのコマンドをビュー:

tiup cloud --help

tiup cloud <command>でコマンドを実行します。例:

tiup cloud serverless create

TiUPによる最新バージョンへのアップデート:

tiup update cloud

次は何か

TiDB Cloud CLI のその他の機能については、 CLI リファレンスご覧ください。

フィードバック

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

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