CLI を使用して TiDB Cloud Filesystem を使い始める
TiDB Cloud Filesystem は、アプリケーション、自動化、AI エージェント向けの永続的で共有可能なクラウドファイルシステムです。ファイルは、それを作成したマシンやプロセスとは独立して利用可能な状態が維持されるため、セッションや環境をまたいでワークスペースを再利用できます。
このクイックスタートガイドでは、TiDB Cloud CLI を使用してファイルシステムを作成し、ファイルを書き込み・読み取りし、必要に応じてローカルディレクトリとしてマウントする方法を説明します。
前提条件
開始する前に、TiDB Cloud コンソール の TiDB Cloud API Keys ページから TiDB Cloud API の公開キーと秘密キーを取得してください。これらのキーには、組織に対する Organization Owner アクセス権が必要です。
すでに誰かからファイルシステムトークンを受け取っている場合は、リソースの作成をスキップして、既存のファイルシステムにアクセスする に従ってください。
macOS および Linux では Bash または Zsh を、Windows では PowerShell を使用してください。チュートリアル全体を通して同じシェルを開いたままにしてください。エージェントがコマンドごとに新しいシェルを開始する場合は、環境変数と保存したパスの値を各シェルに渡してください。
ステップ 1. TiDB Cloud CLI をインストールする
使用するオペレーティングシステムを選択してください。
TiDB Cloud CLI をインストールします。
curl -fsSL https://github.com/tidbcloud/ti-cli/releases/latest/download/install.sh | sh -s -- --yestiをシェルで使えるようにし、バージョンを確認します。export PATH="$HOME/.ti/bin:$PATH" ti --version新しいターミナルでも
tiを使えるようにするには、シェルプロファイルに追加します。Zsh の場合は次のとおりです。echo 'export PATH="$HOME/.ti/bin:$PATH"' >> ~/.zshrcBash の場合は、同じ
export行をターミナルが使用する起動ファイルに追加してください。一般的には Linux では~/.bashrc、macOS では~/.bash_profileです。
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 -Yestiを現在の PowerShell セッションで使えるようにし、バージョンを確認します。$env:Path = "$HOME\.ti\bin;$env:Path" ti --version
Windows での永続的な PATH 設定やその他のインストール方法については、TiDB Cloud CLI のインストール、設定、および更新 を参照してください。
ステップ 2. TiDB Cloud CLI を設定する
ファイルの保存先として使用するサポートされるリージョンを選択します。たとえば aws-us-west-2 です。無料利用枠では、1 リージョンあたり 1 つのファイルシステムを作成できます。組織ですでに 1 つ作成済みの場合は、それを再利用するか、別のリージョンを選択するか、支払い方法を追加してください。
対話形式の設定を実行します。
ti configure次の情報を入力します。
- 選択したリージョン
- TiDB Cloud API の公開キーと秘密キー
CLI は認証情報とデフォルトリージョンをローカルに保存します。次のステップの作成コマンドでは、このリージョンが使用されます。
ステップ 3. ファイルシステムを作成して使用する
ファイルシステムを作成します。
ti fs create-file-system --display-name agent-workspace --wait次のステップで使用するため、返された
file_system_idをコピーしてください。CLI はファイルシステムのオーナートークンとリージョンをローカルに保存するため、同じマシンでは再度トークンを入力する必要はありません。新しいファイルシステムを選択します。
<file-system-id>を返されたfile_system_idに置き換えてください。export TI_FS_FILE_SYSTEM_ID="<file-system-id>"$env:TI_FS_FILE_SYSTEM_ID = "<file-system-id>"ディレクトリを作成し、サンプルファイルをアップロードして、読み戻します。
ti fs create-directory --path /quick-start printf 'Hello from TiDB Cloud Filesystem\n' | ti fs copy-file \ --from-stdin --to-remote /quick-start/hello.txt ti fs read-file --path /quick-start/hello.txtti fs create-directory --path /quick-start "Hello from TiDB Cloud Filesystem" | ti fs copy-file ` --from-stdin --to-remote /quick-start/hello.txt ti fs read-file --path /quick-start/hello.txtread-fileの想定出力は次のとおりです。Hello from TiDB Cloud Filesystemこれで、最初のファイルが TiDB Cloud Filesystem に保存されました。別の環境からアクセスするには、既存のファイルシステムにアクセスする を参照してください。別のユーザー、アプリケーション、またはエージェントにアクセス権を付与するには、ファイルシステムを共有する を参照してください。
ステップ 4. ファイルシステムをマウントする(オプション)
アプリケーションでローカルファイルパスが必要な場合は、ファイルシステムをマウントします。Windows ではマウントはサポートされていません。Windows を使用している場合、または CLI アクセスのみが必要な場合は、ステップ 5 に進んでください。
マウント用の空のローカルディレクトリを作成します。
mount_dir="$(mktemp -d "$HOME/ti-fs-quick-start.XXXXXX")"使用しているオペレーティングシステムに応じたコマンドで
/quick-startディレクトリをマウントします。このコマンドは、macOS に組み込まれている WebDAV サポートを使用します。
ti fs mount-file-system --remote-path /quick-start \ --mount-path "$mount_dir" --driver webdavLinux では
fuse3パッケージと/dev/fuseへのアクセスが必要です。必要に応じて、マウントコマンドを実行する前に FUSE ユーザースペースツールをインストールする を参照してください。ti fs mount-file-system --remote-path /quick-start \ --mount-path "$mount_dir" --driver fuseローカルパスを使ってファイルを読み取ります。
cat "$mount_dir/hello.txt"期待される出力:
Hello from TiDB Cloud Filesystem
書き込みの検証とトラブルシューティングについては、使用前にマウントを検証する を参照してください。
ステップ 5. サンプルをクリーンアップする(オプション)
ステップ 4 でディレクトリをマウントした場合は、それを使用しているアプリケーションを閉じてから、アンマウントし、空のローカルマウントディレクトリを削除します。
ti fs unmount-file-system --mount-path "$mount_dir"
rmdir "$mount_dir"
アンマウントに失敗した場合は、続行する前に 安全に終了する を参照してください。
サンプルディレクトリとそのファイルを削除します。このコマンドは、サポートされているすべてのオペレーティングシステムで動作します。
ti fs delete-file --path /quick-start --recursive
ファイルシステムとそのトークンは、再利用できる状態のまま残ります。ファイルシステム全体を削除するには、ファイルシステムを削除する を参照してください。
次のステップ
- 既存のファイルシステムにアクセスする では、ローカルに保存された認証情報を再利用したり、別の環境から接続したりできます。
- 自動化向けに設定する では、CI ジョブやエージェント用の CLI 認証情報を設定できます。
- TiDB Cloud Filesystem でファイルシステムを管理する では、ファイルシステムの確認と管理を行えます。
- ファイルシステムトークンの管理 では、ファイルシステムアクセス用トークンの作成、確認、管理を行えます。
- ファイルシステムをマウントする では、ローカルディレクトリを通じてそのファイルにアクセスできます。
- ファイルシステムを共有する では、同じファイルを別のマシン、ユーザー、アプリケーション、またはエージェントから利用できるようにできます。
- ファイルシステムのレイヤーとチェックポイントを管理する では、ファイル変更の分離、確認、適用を行えます。