📣
TiDB Cloud Premium はパブリックプレビュー中です。エンタープライズワークロード向けの無制限のスケーリング、即時の弾力性、高度なセキュリティを提供します。このページは自動翻訳されたものです。原文はこちらからご覧ください。
AI
開発者
ベストプラクティス
API

TiDB Cloud CLI を使い始める

TiDB Cloud CLI (ti) は、TiDB Cloud Starter インスタンスおよび TiDB Cloud Filesystem 内のファイルシステム を管理するためのコマンドラインツールです。対話的な利用と自動化の両方をサポートしており、コマンドのデフォルト出力形式は JSON です。

このガイドでは、TiDB Cloud CLI (ti) のインストールと設定を行い、その後 TiDB Cloud Starter または TiDB Cloud Filesystem を使った基本的なワークフローを完了する方法を説明します。CLI の概要、機能、サポートされるワークフローについては、TiDB Cloud CLI (ti) の概要 を参照してください。

前提条件

開始する前に、TiDB Cloud コンソール の TiDB Cloud API Keys ページから TiDB Cloud API public キーと private キーを取得してください。これらのキーには、組織に対する Organization Owner アクセス権が必要です。

Step 1. TiDB Cloud CLI をインストールする

お使いのオペレーティングシステムに応じて、以下の手順で TiDB Cloud CLI をインストールします。

    1. macOS または Linux で、次のコマンドを実行して TiDB Cloud CLI をインストールします。

      curl -fsSL https://github.com/tidbcloud/ti-cli/releases/latest/download/install.sh | sh -s -- --yes

    2. 現在のシェルで ti を使えるようにし、確認します。

      export PATH="$HOME/.ti/bin:$PATH"
ti --version

    3. 新しいターミナルでも ti を使えるようにするため、export PATH="$HOME/.ti/bin:$PATH" をシェルプロファイルに追加します。

      たとえば、zsh を使用している場合は、次のコマンドを実行します。

      echo 'export PATH="$HOME/.ti/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

    1. Windows PowerShell で、次のコマンドを実行して TiDB Cloud CLI をインストールします。

      $script = "$env:TEMP\install-ti.ps1"
iwr https://github.com/tidbcloud/ti-cli/releases/latest/download/install.ps1 -OutFile $script
powershell -ExecutionPolicy Bypass -File $script -Yes

    2. 現在の PowerShell セッションで ti を使えるようにし、確認します。

      $env:Path = "$HOME\.ti\bin;$env:Path"
ti --version

    3. 新しい PowerShell セッションでも ti を使えるようにするため、ユーザーの PATH に $HOME\.ti\bin を追加します。

      $tiBin = "$HOME\.ti\bin"
[Environment]::SetEnvironmentVariable("Path", "$tiBin;$([Environment]::GetEnvironmentVariable('Path', 'User'))", "User")

    Step 2. TiDB Cloud CLI を設定する

    1. 対話型設定を実行します。

      ti configure

    2. 次の情報を入力します。

      • CLI 操作のデフォルトリージョン。リージョンコード（aws-us-west-2 など）で指定します。TiDB Cloud CLI がサポートするリージョンの一覧については、サポートされるリージョン を参照してください。
      • TiDB Cloud API public キーと private キー。

    3. 読み取り専用コマンドを実行し、保存した認証情報を使用して CLI が TiDB Cloud にアクセスできることを確認します。

      ti fs list-file-systems

      出力例:

      {
  "region_code": "aws-us-west-2",
  "file_systems": []
}

    Step 3. ワークフローを選択する

    ニーズに応じて、以下のいずれかのワークフローに進みます。

    オプション A: TiDB Cloud Filesystem

    TiDB Cloud Filesystem は、ローカルマシン、CI ジョブ、サンドボックス、その他の一時的な環境で利用できる、永続的かつ共有可能なクラウドファイルシステムです。

    以下の例では、ある環境でファイルシステムを作成し、同じ環境または別の環境からそれにアクセスする方法を示します。たとえば、AI エージェントのサンドボックス（タスクの後に破棄される可能性がある一時的な環境）からアクセスできます。

    1. ローカルマシン、または TiDB Cloud API 認証情報が設定された別の環境で、ファイルシステムを作成し、そのオーナートークンを取得します。

      export TI_FS_TOKEN="$(ti fs create-file-system --display-name agent-workspace --wait --query fs_token --output text --region aws-us-west-2)"

    2. ファイルシステムを使用する環境で、前の手順のオーナートークンを TI_FS_TOKEN として設定し、次のようにファイルシステムをローカルパスにマウントします。この環境は、ファイルシステムを作成した同じマシン、別のマシン、または AI エージェントのサンドボックスのいずれでもかまいません。

      # export TI_FS_TOKEN="<owner-token>" # 手順 1 とは別の環境で続行する場合は、ここで手順 1 で取得した TI_FS_TOKEN を渡します。
mkdir ~/mnt-test
ti fs mount-file-system --mount-path ~/mnt-test --region aws-us-west-2
echo 'Hello from TiDB Cloud Filesystem' >> ~/mnt-test/hello.txt
ls -l ~/mnt-test/hello.txt

      マウント後は、標準的なローカルファイル操作を使用してファイルを扱うことができます。

    3. その環境でマウントしたファイルシステムの使用が終わったら、アンマウントします。

      ti fs unmount-file-system --mount-path ~/mnt-test --region aws-us-west-2

      アンマウントするとローカルマウントは削除されますが、ファイルは TiDB Cloud Filesystem に残り、同じ環境または別の環境から再度アクセスできます。

    オプション B: TiDB Cloud Starter

    1. TiDB Cloud Starter インスタンスを作成し、その ID を保存します。

      export TI_DB_CLUSTER_ID="$(ti db create-db-cluster \
  --db-cluster-type starter \
  --db-cluster-name quickstart-db \
  --wait \
  --query id \
  --output text)"

    2. SQL ユーザーを作成し、読み取り専用クエリを実行して接続を確認します。

      ti db create-db-sql-users \
  --db-cluster-id "$TI_DB_CLUSTER_ID"

ti db execute-sql-statement \
  --db-cluster-id "$TI_DB_CLUSTER_ID" \
  --read-only \
  --sql "SELECT 1 AS ready" \
  --output text

      ti db execute-sql-statement コマンドは、HTTPS SQL API を介してクエリを実行します。出力には ready = 1 が含まれます。

    3. 接続文字列を生成します。

      export DATABASE_URL="$(ti db format-db-connection-string \
  --db-cluster-id "$TI_DB_CLUSTER_ID" \
  --read-write --query connection_string \
  --output text)"

    次のステップ

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