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...]形式のコマンドでのみ使用できます。

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

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

ノート：
このオプションは、v1.3.0 以降非推奨です。

バージョン番号の有効性チェックをスキップします。デフォルトでは、指定されたバージョン番号はセマンティックバージョンのみです。
データ型: BOOLEAN
このオプションはデフォルトで無効になっており、デフォルト値はfalseです。このオプションを有効にするには、このオプションをコマンドに追加して、値trueを渡すか、値を何も渡さないようにします。

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

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

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

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