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...]形式のコマンドでのみ使用できます。
--binpath
注記:
このオプションは、
tiup [flags] <component> [args...]形式のコマンドでのみ使用できます。
- 実行するコンポーネントのパスを指定します。コンポーネントの実行時にTiUPミラー内のバイナリファイルを使用しない場合は、このオプションを追加することで、カスタムパス内のバイナリファイルを使用するように指定できます。
- データ型:
STRING
-T, --タグ
- 起動するコンポーネントのタグを指定します。一部のコンポーネントは実行中にディスクstorageを使用する必要があり、 TiUP はこの実行のために一時的なstorageディレクトリを割り当てます。TiUPに固定のディレクトリを割り当てたい場合は、ディレクトリ名に
-T/--tag指定します。これにより、同じタグを持つ複数の実行で、同じファイルバッチの読み取りと書き込みが可能になります。 - データ型:
STRING
-v, --バージョン
TiUPバージョンを出力します。
- ヘルプ
ヘルプ情報を出力します。
コマンドリスト
TiUPには複数のコマンドがあり、これらのコマンドには複数のサブコマンドがあります。具体的なコマンドとその詳細な説明については、以下のリストにある対応するリンクをクリックしてください。
- インストール :コンポーネントをインストールします。
- リスト :コンポーネントリストを表示します。
- アンインストール :コンポーネントをアンインストールします。
- アップデート : インストールされているコンポーネントを更新します。
- 状態 :コンポーネントの実行ステータスを表示します。
- クリーン :コンポーネントのデータディレクトリをクリーンアップします。
- 鏡 : ミラーを管理します。
- テレメトリー : テレメトリを有効または無効にします。
- 完了 : TiUPコマンドを完了します。
- 環境 : TiUP関連の環境変数を表示します。
- ヘルプ : コマンドまたはコンポーネントのヘルプ情報を表示します。