TiUPリファレンス

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

構文

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

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

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

オプション

- バイナリ

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

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

• データ型: BOOLEAN

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

注記：

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

--binパス

注記：

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

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

-T, --タグ

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

-v, --バージョン

TiUPバージョンを印刷します。

- ヘルプ

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

コマンドリスト

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

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

コンポーネントリスト

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