重要

古いバージョンの TiDB データベース (TiDB {{ curdocVersion }}) のドキュメントを表示しています。TiDBデータベースの最新の安定バージョンを使用することをお勧めします。

重要

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

TiUPコマンドでTiUPコンポーネントを管理する

次のTiUPコマンドを使用して、TiUPエコシステムのコンポーネントを管理できます。

list：コンポーネントリストを照会します。このTiUPコマンドを使用すると、インストールするすべてのオプションコンポーネントと、各コンポーネントのすべてのオプションバージョンを確認できます。
install：コンポーネントの特定のバージョンをインストールします。
update：コンポーネントを最新バージョンに更新します。
アンインストール：コンポーネントをアンインストールします。
status：実行中のコンポーネントのステータスをチェックします。
clean：コンポーネントがデプロイされているインスタンスをクリーンアップします。
help：ヘルプ情報を出力します。このコマンドに別のTiUPコマンドを追加すると、追加されたコマンドの使用法が出力されます。

このドキュメントでは、一般的なコンポーネント管理操作と対応するTiUPコマンドを紹介します。

コンポーネントリストをクエリする

tiup listコマンドを使用して、コンポーネントリストを照会できます。このコマンドのこの使用法は次のとおりです。

tiup list ：インストールできるコンポーネントを確認します。
tiup list ${component} ：特定のコンポーネントのどのバージョンをインストールできるかを確認します。

上記のコマンドで次のフラグを使用することもできます。

--installed ：特定のコンポーネントのどのコンポーネントまたはどのバージョンがローカルにインストールされているかを確認します。 --all ：非表示のコンポーネントを含むすべてのコンポーネントを表示します--verbose ：すべての列を表示します（インストールされているバージョンとサポートされているプラットフォームを含む）

例1：現在インストールされているすべてのコンポーネントを表示します。

tiup list --installed

例2：サーバーからインストール可能なすべてのバージョンのTiKVコンポーネントのリストを取得します。

tiup list tikv

コンポーネントをインストールする

tiup installコマンドを使用して、コンポーネントリストを照会できます。このコマンドのこの使用法は次のとおりです。

tiup install <component> ：指定されたコンポーネントの最新の安定バージョンをインストールします。
tiup install <component>:[version] ：指定されたコンポーネントの指定されたバージョンをインストールします。

例1：TiUPを使用して、最新の安定バージョンのTiDBをインストールします。

tiup install tidb

例2：TiUPを使用して、ナイトリーバージョンのTiDBをインストールします。

tiup install tidb:nightly

例3：TiUPを使用してTiKVv5.4.2をインストールします。

tiup install tikv:v5.4.2

コンポーネントをアップグレードする

コンポーネントの新しいバージョンが公開されたら、 tiup updateコマンドを使用してこのコンポーネントをアップグレードできます。このコマンドの使用法は、次のフラグを除いて、基本的にtiup installの使用法と同じです。

--all ：すべてのコンポーネントをアップグレードします。
--nightly ：ナイトリーバージョンにアップグレードします。
--self ：TiUP自体を最新バージョンにアップグレードします。
--force ：強制的に最新バージョンにアップグレードします。

例1：すべてのコンポーネントを最新バージョンにアップグレードします。

tiup update --all

例2：すべてのコンポーネントをナイトリーバージョンにアップグレードします。

tiup update --all --nightly

例3：TiUPを最新バージョンにアップグレードします。

tiup update --self

コンポーネントを操作する

インストールが完了したら、 tiup <component>コマンドを使用して対応するコンポーネントを起動できます。

tiup [flags] <component>[:version] [args...]

Flags:
  -T, --tag string                     Specifies the tag for the component instance.

このコマンドを使用するには、コンポーネント名とオプションのバージョンを指定する必要があります。バージョンが指定されていない場合は、このコンポーネントの最新の安定バージョン（インストール済み）が使用されます。

コンポーネントを起動する前に、TiUPはそのディレクトリを作成し、このコンポーネントを操作用のディレクトリに配置します。コンポーネントはこのディレクトリにすべてのデータを生成します。このディレクトリの名前は、コンポーネントの動作時に指定されたタグ名です。タグが指定されていない場合、タグ名はランダムに生成されます。この作業ディレクトリは、インスタンスが終了すると自動的に削除されます。

同じコンポーネントを複数回起動して前の作業ディレクトリを再利用する場合は、 --tagを使用して、コンポーネントの起動時に同じ名前を指定できます。タグを指定すると、インスタンスの終了時に作業ディレクトリが自動的に削除されないため、作業ディレクトリを再利用できます。

例1：TiDBv5.4.2を操作します。

tiup tidb:v5.4.2

例2：TiKVが動作するタグを指定します。

tiup --tag=experiment tikv

コンポーネントの動作ステータスを照会する

tiup statusコマンドを使用して、コンポーネントの動作ステータスを確認できます。

tiup status

このコマンドを実行すると、インスタンスのリストが1行に1つずつ表示されます。リストには次の列が含まれています。

Name ：インスタンスのタグ名。
Component ：インスタンスのコンポーネント名。
PID ：オペレーティングインスタンスのプロセスID。
Status ：インスタンスのステータス。 RUNNINGは、インスタンスが動作していることを意味します。 TERMは、インスタンスが終了することを意味します。
Created Time ：インスタンスの開始時刻。
Directory ：インスタンスの作業ディレクトリ--tagを使用して指定できます。
Binary ：インスタンスの実行可能プログラム--binpathを使用して指定できます。
Args ：オペレーティングインスタンスの引数。

コンポーネントインスタンスをクリーンアップする

tiup cleanコマンドを使用して、コンポーネントインスタンスをクリーンアップし、作業ディレクトリを削除できます。クリーニングの前にインスタンスがまだ動作している場合は、関連するプロセスが最初に強制終了されます。コマンドの使用法は次のとおりです。

tiup clean [tag] [flags]

次のフラグがサポートされています。

--all ：すべてのインスタンス情報をクリーンアップします。

上記のコマンドで、 tagはクリーンアップされるインスタンスタグです。 --allを使用すると、タグは渡されません。

例1： experimentのタグ名でコンポーネントインスタンスをクリーンアップします。

tiup clean experiment

例2：すべてのコンポーネントインスタンスをクリーンアップします。

tiup clean --all

コンポーネントをアンインストールする

TiUPを使用してインストールされたコンポーネントは、ローカルディスクスペースを占有します。古いバージョンのコンポーネントをあまり多く保持したくない場合は、コンポーネントのどのバージョンが現在インストールされているかを確認してから、このコンポーネントをアンインストールできます。

tiup uninstallコマンドを使用して、コンポーネントのすべてのバージョンまたは特定のバージョンをアンインストールできます。このコマンドは、すべてのコンポーネントのアンインストールもサポートしています。コマンドの使用法は次のとおりです。

tiup uninstall [component][:version] [flags]

このコマンドでは、次のフラグがサポートされています。

--all ：すべてのコンポーネントまたはバージョンをアンインストールします。
--self ：TiUP自体をアンインストールします。

componentはアンインストールするコンポーネントです。 versionはアンインストールするバージョンです。 tiup uninstallコマンドでは、 componentとversionの両方を無視できます。これら2つのいずれかを無視する場合は、 --allフラグを追加する必要があります。

バージョンが無視される場合、 --allを追加すると、このコンポーネントのすべてのバージョンがアンインストールされます。
バージョンとコンポーネントの両方が無視される場合、 --allを追加すると、すべてのバージョンのすべてのコンポーネントがアンインストールされます。

例1：TiDBv5.4.2をアンインストールします。

tiup uninstall tidb:v5.4.2

例2：すべてのバージョンのTiKVをアンインストールします。

tiup uninstall tikv --all

例3：インストールされているすべてのコンポーネントをアンインストールします。

tiup uninstall --all