重要
このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

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>はコンポーネント名を表します。サポートされているコンポーネントのリストについては、以下のコンポーネントリストを参照してください。

オプション

-B、-binary

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

    • tiup -B/--binary <component>を実行すると、最新の安定したインストール済み<component>コンポーネントのパスが印刷されます。 <component>がインストールされていない場合、エラーが返されます。
    • tiup -B/--binary <component>:<version>を実行すると、インストールされている<component>コンポーネントの<version>のパスが出力されます。この<version>が出力されない場合、エラーが返されます。
  • データ型: BOOLEAN

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

ノート:

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

--binpath

ノート:

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

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

--skip-version-check

ノート:

このオプションは、v1.3.0以降非推奨になりました。

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

-T、-tag

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

-v、-version

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

- ヘルプ

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

コマンドリスト

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

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

コンポーネントリスト

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