TiUPリファレンス

TiUP は、 TiDB エコシステムのパッケージ マネージャーとして機能します。 TiDB、PD、TiKV などの TiDB エコシステムのコンポーネントを管理します。

構文

tiup [flags] <command> [args...]        # Executes a command
# or
tiup [flags] <component> [args...]      # Runs a component

--helpコマンドを使用して、特定のコマンドの情報を取得できます。各コマンドの概要には、そのパラメーターとその使用法が表示されます。必須パラメーターは山括弧で示され、オプションのパラメーターは角括弧で示されます。

<command>コマンド名を表します。サポートされているコマンドのリストについては、以下のコマンド一覧を参照してください。 <component>コンポーネント名を表します。サポートされているコンポーネントのリストについては、以下のコンポーネントリストを参照してください。

オプション

- バイナリ

• このオプションを有効にすると、指定したバイナリ ファイル パスが出力されます。

  • tiup --binary <component>を実行すると、インストールされた最新の安定した<component>コンポーネントのパスが表示されます。 <component>がインストールされていない場合は、エラーが返されます。
  • tiup --binary <component>:<version>を実行すると、インストールされた<component>コンポーネントの<version>パスが表示されます。この<version>が出力されない場合、エラーが返されます。

• データ型: BOOLEAN

• このオプションはデフォルトで無効になっており、デフォルト値はfalseです。このオプションを有効にするには、このオプションをコマンドに追加して、値true渡すか、値を何も渡さないようにします。

ノート：

このオプションは、 tiup [flags] <component> [args...]形式のコマンドでのみ使用できます。

--binpath

ノート：

このオプションは、 tiup [flags] <component> [args...]形式のコマンドでのみ使用できます。

• 実行するコンポーネントのパスを指定します。コンポーネント実行時にTiUPミラーのバイナリファイルを使用したくない場合、このオプションを追加することでカスタムパスのバイナリファイルを使用するように指定できます。
• データ型: STRING

-T, --タグ

• 開始するコンポーネントのタグを指定します。一部のコンポーネントは実行中にディスクstorageを使用する必要があり、 TiUP はこの実行のために一時的なstorageディレクトリを割り当てます。 TiUPに固定ディレクトリを割り当てる場合は、 -T/--tagを使用してディレクトリの名前を指定できます。これにより、同じファイルのバッチを同じタグで複数の実行で読み書きできるようになります。
• データ型: STRING

-v, --version

TiUP のバージョンを出力します。

- ヘルプ

ヘルプ情報を出力します。

コマンド一覧

TiUPには複数のコマンドがあり、これらのコマンドには複数のサブコマンドがあります。特定のコマンドとその詳細な説明については、以下のリストの対応するリンクをクリックしてください。

• インストール :コンポーネントをインストールします。
• リスト :コンポーネントリストを表示します。
• アンインストール :コンポーネントをアンインストールします。
• アップデート : インストールされたコンポーネントを更新します。
• スターテス :コンポーネントの実行ステータスを示します。
• 綺麗 :コンポーネントのデータ ディレクトリを消去します。
• 鏡 : ミラーを管理します。
• テレメトリー : テレメトリを有効または無効にします。
• 完了 : TiUPコマンドを完了します。
• 環境 : TiUP関連の環境変数を表示します。
• ヘルプ : コマンドまたはコンポーネントのヘルプ情報を表示します。

コンポーネントリスト

• 集まる :本番環境で TiDB クラスターを管理します。
• dm :本番環境で TiDB データ移行 (DM) クラスターを管理します。