TiDB Cloud CLI (ticloud) クイックスタート
TiDB Cloud は、ターミナルから数行のコマンドで TiDB Cloud Starter および Essential とやり取りできるコマンドラインインターフェイス (CLI) ticloudを提供しています。たとえば、 ticloudを使用して、次の操作を実行できます。
- TiDB Cloud StarterまたはEssentialインスタンスの作成、削除、一覧表示を行います。
- TiDB Cloud StarterまたはEssentialインスタンスにデータをインポートします。
- TiDB Cloud StarterまたはEssentialインスタンスからデータをエクスポートします。
始める前に
- TiDB Cloudアカウントを持っていること。お持ちでない場合は、無料トライアルに登録する。
インストール
macOS または Linux の場合、 ticloudは次のいずれかの方法を使用してインストールできます。
スクリプト経由でインストールする(推奨)
curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | shTiUP経由でインストール
tiup install cloud手動でインストール
リリースページからコンパイル済みのバイナリをダウンロードし、インストール先の任意の場所にコピーしてください。
GitHub Actionsにインストールする
GitHub Actions で
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を起動するには、 mysql.exeを含むディレクトリが PATH 環境変数に含まれている必要があります。
クイックスタート
TiDB Cloud Starterは、 TiDB Cloudを始めるための最適な方法です。このセクションでは、 TiDB Cloud CLIを使用してTiDB Cloud Starterインスタンスを作成する方法を学びます。
TiDB Cloudでユーザープロファイルを作成するか、ログインしてください。
TiDB Cloud CLI を使用して TiDB Cloud Starterインスタンスを作成する前に、ユーザープロファイルを作成するか、 TiDB Cloudにログインする必要があります。
TiDB Cloud APIキーを使用してユーザープロファイルを作成します。
ticloud config createTiDB Cloudに認証情報を使用してログインしてください。
ticloud auth loginログインが成功すると、現在のプロファイルにOAuthトークンが割り当てられます。プロファイルが存在しない場合は、
defaultという名前のプロファイルにトークンが割り当てられます。
TiDB Cloud Starterインスタンスを作成する
TiDB Cloud Starterインスタンスを作成するには、次のコマンドを入力し、CLIプロンプトに従って必要な情報を入力してください。
ticloud serverless create
TiDB Cloud CLIを使用する
利用可能なすべてのコマンドを確認します。
ticloud --help
最新バージョンを使用していることを確認してください。
ticloud version
そうでない場合は、最新バージョンにアップデートしてください。
ticloud update
TiUP経由でTiDB Cloud CLIを使用する
TiDB Cloud CLI はTiUPからも利用可能で、コンポーネント名はcloudです。
利用可能なすべてのコマンドを確認します。
tiup cloud --help
tiup cloud <command>を使用してコマンドを実行します。例:
tiup cloud serverless create
TiUPによる最新バージョンへのアップデート:
tiup update cloud
次は?
TiDB Cloud CLI の機能をさらに詳しく調べるには、 CLIリファレンスを確認してください。
フィードバック
TiDB Cloud CLI に関してご質問やご提案がありましたら、お気軽にissueを作成してください。また、皆様からの貢献も歓迎いたします。