重要

現在表示されているページは、TiDBのアーカイブされたドキュメント (非更新) です。TiDBをご利用の場合、最新のLTS (Long Term Support) バージョンの使用を推奨します。

重要

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

TiUPの概要

TiDB 4.0 以降では、パッケージマネージャーとしての TiUP により、TiDB エコシステム内のさまざまなクラスターコンポーネントの管理がはるかに簡単になります。これで、たった 1 行の TiUP コマンドで任意のコンポーネントを実行できます。

TiUPをインストールする

Darwin と Linux オペレーティングシステムの両方で、1 つのコマンドで TiUP をインストールできます。

curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

このコマンドは、TiUP を$HOME/.tiupフォルダーにインストールします。インストールされたコンポーネントと、その操作によって生成されたデータもこのフォルダーに配置されます。このコマンドはまた、シェル.profileファイルのPATH環境変数に$HOME/.tiup/binを自動的に追加するため、TiUP を直接使用できます。

インストール後、TiUP のバージョンを確認できます。

tiup --version

ノート：
デフォルトでは、TiUP は使用状況の詳細を PingCAP と共有して、製品の改善方法を理解できるようにします。共有される内容と共有を無効にする方法の詳細については、テレメトリーを参照してください。

TiUPエコシステム紹介

TiUP は、TiDB エコシステムにおける単なるパッケージマネージャーではありません。その究極の使命は、独自のエコシステムを構築することにより、誰もが TiDB エコシステムツールをこれまで以上に簡単に使用できるようにすることです。これには、TiUP エコシステムを充実させるために追加のパッケージを導入する必要があります。

この一連の TiUP ドキュメントでは、これらのパッケージの機能と使用方法を紹介します。

TiUP エコシステムでは、TiUP 自体のヘルプ情報を取得する次のコマンドのように、任意のコマンドに--helpを追加することでヘルプ情報を取得できます。

tiup --help

TiUP is a command-line component management tool that can help to download and install
TiDB platform components to the local system. You can run a specific version of a component via
"tiup <component>[:version]". If no version number is specified, the latest version installed
locally will be used. If the specified component does not have any version installed locally,
the latest stable version will be downloaded from the repository.

Usage:
  tiup [flags] <command> [args...]
  tiup [flags] <component> [args...]

Available Commands:
  install     Install a specific version of a component
  list        List the available TiDB components or versions
  uninstall   Uninstall components or versions of a component
  update      Update tiup components to the latest version
  status      List the status of instantiated components
  clean       Clean the data of instantiated components
  mirror      Manage a repository mirror for TiUP components
  help        Help about any command or component

Components Manifest:
  use "tiup list" to fetch the latest components manifest

Flags:
  -B, --binary <component>[:version]   Print binary path of a specific version of a component <component>[:version]
                                       and the latest version installed will be selected if no version specified
      --binpath string                 Specify the binary path of component instance
  -h, --help                           help for tiup
      --skip-version-check             Skip the strict version check, by default a version must be a valid SemVer string
  -T, --tag string                     Specify a tag for component instance
  -v, --version                        version for tiup

Component instances with the same "tag" will share a data directory ($TIUP_HOME/data/$tag):
  $ tiup --tag mycluster playground

Examples:
  $ tiup playground                    # Quick start
  $ tiup playground nightly            # Start a playground with the latest nightly version
  $ tiup install <component>[:version] # Install a component of specific version
  $ tiup update --all                  # Update all installed components to the latest version
  $ tiup update --nightly              # Update all installed components to the nightly version
  $ tiup update --self                 # Update the "tiup" to the latest version
  $ tiup list                          # Fetch the latest supported components list
  $ tiup status                        # Display all running/terminated instances
  $ tiup clean <name>                  # Clean the data of running/terminated instance (Kill process if it's running)
  $ tiup clean --all                   # Clean the data of all running/terminated instances

Use "tiup [command] --help" for more information about a command.

出力は長いですが、注目できるのは次の 2 つの部分だけです。

利用可能なコマンド
- install: コンポーネントのインストールに使用
- list: 利用可能なコンポーネントのリストを表示するために使用されます
- uninstall: コンポーネントのアンインストールに使用
- update: コンポーネントのバージョンを更新するために使用されます
- status: コンポーネントの実行履歴を表示するために使用されます
- clean: コンポーネントの実行ログをクリアするために使用されます
- mirror: 公式ミラーからプライベートミラーを複製するために使用されます。
- help: ヘルプ情報を出力するために使用されます
利用可能なコンポーネント
- プレイグラウンド: TiDB クラスターをローカルで開始するために使用されます
- クライアント: ローカルマシンの TiDB クラスターに接続するために使用されます
- クラスター: 本番環境用の TiDB クラスターをデプロイするために使用されます
- ベンチ: データベースのストレステストに使用

ノート：
利用可能なコンポーネントの数は増え続けます。最新の対応コンポーネントを確認するには、 tiup listコマンドを実行します。
コンポーネントの利用可能なバージョンのリストも増え続けます。サポートされているコンポーネントの最新バージョンを確認するには、 tiup list <component>コマンドを実行します。

TiUP コマンドは TiUP の内部コードに実装され、パッケージ管理操作に使用されますが、TiUP コンポーネントは TiUP コマンドによってインストールされる独立したコンポーネントパッケージです。

たとえば、 tiup listコマンドを実行すると、TiUP は独自の内部コードを直接実行します。 tiup playgroundコマンドを実行すると、TiUP は最初に「playground」という名前のローカルパッケージがあるかどうかを確認し、ない場合、TiUP はミラーからパッケージをダウンロードして実行します。