TiDB Cloud CLI クイックスタート
TiDB Cloudは、ターミナルから数行のコマンドでTiDB Cloudを操作できるコマンドラインインターフェース(CLI) ticloud
提供しています。例えば、 ticloud
使用して以下の操作を簡単に実行できます。
- クラスターを作成、削除、一覧表示します。
- クラスターにデータをインポートします。
- クラスターからデータをエクスポートします。
注記:
TiDB Cloud CLI はベータ版です。
始める前に
- TiDB Cloudアカウントをお持ちであること。お持ちでない場合は、 無料トライアルにサインアップ 。
インストール
macOS または Linux の場合、次のいずれかの方法でticloud
インストールできます。
スクリプト経由でインストールする(推奨)
curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | shTiUP経由でインストール
tiup install cloud手動でインストールする
リリースページからコンパイル済みのバイナリをダウンロードし、インストール先の場所にコピーします。
GitHub Actionsにインストール
GitHub Action で
ticloud
設定するには、setup-tidbcloud-cli
使用します。
MySQLコマンドラインクライアントがインストールされていない場合はインストールしてください。パッケージマネージャーからインストールできます。
Debian ベースのディストリビューション:
sudo apt-get install mysql-clientRPM ベースのディストリビューション:
sudo yum install mysqlmacOS:
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 は、コンポーネント名がcloud
のTiUPからも利用できます。
利用可能なすべてのコマンドをビュー:
tiup cloud --help
tiup cloud <command>
を付けてコマンドを実行します。例:
tiup cloud serverless create
TiUPによる最新バージョンへのアップデート:
tiup update cloud
次は何?
TiDB Cloud CLI のその他の機能については、 CLIリファレンスご覧ください。
フィードバック
TiDB Cloud CLI についてご質問やご提案がございましたら、お気軽に問題作成してください。また、皆様からの貢献も歓迎いたします。