- ドキュメント ホーム
- TiDBについて
- クイックスタート
- 発展させる
- 概要
- クイックスタート
- TiDB Cloud(開発者層) で TiDB クラスターを構築する
- TiDB の CRUD SQL
- TiDB でシンプルな CRUD アプリを構築する
- 応用例
- TiDB に接続する
- データベース スキーマの設計
- 書き込みデータ
- データの読み取り
- 取引
- 最適化
- トラブルシューティング
- 参照
- 書店のサンプル アプリケーション
- ガイドライン
- アーカイブされたドキュメント
- クラウドネイティブ開発環境
- サードパーティのサポート
- デプロイ
- 移行する
- 管理
- 監視と警告
- トラブルシューティング
- TiDB トラブルシューティング マップ
- 遅いクエリを特定する
- 遅いクエリを分析する
- SQL 診断
- Top SQLを使用して高価なクエリを特定する
- ログを使用して高価なクエリを特定する
- ステートメント要約表
- ホットスポットの問題のトラブルシューティング
- 増加した読み取りおよび書き込み遅延のトラブルシューティング
- クラスターのオンサイト情報の保存と復元
- クラスタ セットアップのトラブルシューティング
- 高いディスク I/O 使用率のトラブルシューティング
- ロック競合のトラブルシューティング
- TiFlash のトラブルシューティング
- オプティミスティック トランザクションでの書き込み競合のトラブルシューティング
- データとインデックス間の不一致のトラブルシューティング
- 性能チューニング
- チューニングガイド
- Configuration / コンフィグレーションのチューニング
- システムのチューニング
- ソフトウェアのチューニング
- Configuration / コンフィグレーション
- コプロセッサ キャッシュ
- SQL チューニング
- チュートリアル
- TiDB ツール
- 概要
- ユースケース
- ダウンロード
- TiUP
- ドキュメンテーション マップ
- 概要
- 用語と概念
- TiUP コンポーネントの管理
- FAQ
- トラブルシューティングガイド
- コマンドリファレンス
- 概要
- TiUP コマンド
- TiUP クラスタ コマンド
- 概要
- tiup cluster audit
- tiup cluster check
- tiup cluster clean
- tiup cluster deploy
- tiup cluster destroy
- tiup cluster disable
- tiup cluster display
- tiup cluster edit-config
- tiup cluster enable
- tiup cluster help
- tiup cluster import
- tiup cluster list
- tiup cluster patch
- tiup cluster prune
- tiup cluster reload
- tiup cluster rename
- tiup cluster replay
- tiup cluster restart
- tiup cluster scale-in
- tiup cluster scale-out
- tiup cluster start
- tiup cluster stop
- tiup cluster template
- tiup cluster upgrade
- TiUP DMコマンド
- TiDB クラスター トポロジ リファレンス
- DM クラスタ トポロジ リファレンス
- ミラー リファレンス ガイド
- TiUP コンポーネント
- PingCAPクリニック診断サービス
- TiDB Operator
- Dumpling
- TiDB Lightning
- TiDB データ移行
- バックアップと復元 (BR)
- Binlog
- TiCDC
- Dumpling
- 同期差分インスペクター
- ティスパーク
- 参照
- クラスタ アーキテクチャ
- 主な監視指標
- セキュリティ
- 権限
- SQL
- SQL 言語の構造と構文
- SQL ステートメント
ADD COLUMN
ADD INDEX
ADMIN
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
ADMIN SHOW TELEMETRY
ALTER DATABASE
ALTER INDEX
ALTER INSTANCE
ALTER PLACEMENT POLICY
ALTER TABLE
ALTER TABLE COMPACT
ALTER USER
ANALYZE TABLE
BACKUP
BATCH
BEGIN
CHANGE COLUMN
COMMIT
CHANGE DRAINER
CHANGE PUMP
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE PLACEMENT POLICY
CREATE ROLE
CREATE SEQUENCE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP [GLOBAL|SESSION] BINDING
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP PLACEMENT POLICY
DROP ROLE
DROP SEQUENCE
DROP STATS
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
FLASHBACK TABLE
FLUSH PRIVILEGES
FLUSH STATUS
FLUSH TABLES
GRANT <privileges>
GRANT <role>
INSERT
KILL [TIDB]
LOAD DATA
LOAD STATS
MODIFY COLUMN
PREPARE
RECOVER TABLE
RENAME INDEX
RENAME TABLE
REPLACE
RESTORE
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW ANALYZE STATUS
SHOW [BACKUPS|RESTORES]
SHOW [GLOBAL|SESSION] BINDINGS
SHOW BUILTINS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CONFIG
SHOW CREATE PLACEMENT POLICY
SHOW CREATE SEQUENCE
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW DRAINER STATUS
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEX [FROM|IN]
SHOW INDEXES [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW MASTER STATUS
SHOW PLACEMENT
SHOW PLACEMENT FOR
SHOW PLACEMENT LABELS
SHOW PLUGINS
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW PROFILES
SHOW PUMP STATUS
SHOW SCHEMAS
SHOW STATS_HEALTHY
SHOW STATS_HISTOGRAMS
SHOW STATS_META
SHOW STATUS
SHOW TABLE NEXT_ROW_ID
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [FULL] TABLES
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SHUTDOWN
SPLIT REGION
START TRANSACTION
TABLE
TRACE
TRUNCATE
UPDATE
USE
WITH
- データ型
- 関数と演算子
- クラスタ化インデックス
- 制約
- 生成された列
- SQL モード
- テーブル属性
- 取引
- ガベージ コレクション (GC)
- ビュー
- パーティショニング
- 一時テーブル
- キャッシュされたテーブル
- 文字セットと照合順序
- SQL の配置規則
- システム テーブル
mysql
- 情報_スキーマ
- 概要
ANALYZE_STATUS
CLIENT_ERRORS_SUMMARY_BY_HOST
CLIENT_ERRORS_SUMMARY_BY_USER
CLIENT_ERRORS_SUMMARY_GLOBAL
CHARACTER_SETS
CLUSTER_CONFIG
CLUSTER_HARDWARE
CLUSTER_INFO
CLUSTER_LOAD
CLUSTER_LOG
CLUSTER_SYSTEMINFO
COLLATIONS
COLLATION_CHARACTER_SET_APPLICABILITY
COLUMNS
DATA_LOCK_WAITS
DDL_JOBS
DEADLOCKS
ENGINES
INSPECTION_RESULT
INSPECTION_RULES
INSPECTION_SUMMARY
KEY_COLUMN_USAGE
METRICS_SUMMARY
METRICS_TABLES
PARTITIONS
PLACEMENT_POLICIES
PROCESSLIST
REFERENTIAL_CONSTRAINTS
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS
TIDB_HOT_REGIONS_HISTORY
TIDB_INDEXES
TIDB_SERVERS_INFO
TIDB_TRX
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
METRICS_SCHEMA
- UI
- TiDB ダッシュボード
- 概要
- 管理
- アクセス
- 概要ページ
- クラスター情報ページ
- Top SQLページ
- キー ビジュアライザー ページ
- メトリクス関係グラフ
- SQL ステートメントの分析
- スロークエリページ
- クラスタ診断
- 検索ログ ページ
- インスタンスのプロファイリング
- セッションの管理とConfiguration / コンフィグレーション
- FAQ
- CLI
- コマンド ライン フラグ
- Configuration / コンフィグレーションファイルのパラメーター
- システム変数
- ストレージ エンジン
- テレメトリー
- エラーコード
- テーブル フィルター
- トポロジ ラベルごとにレプリカをスケジュールする
- よくある質問
- リリースノート
- すべてのリリース
- リリースのタイムライン
- TiDB のバージョニング
- v6.1
- v6.0
- v5.4
- v5.3
- v5.2
- v5.1
- v5.0
- v4.0
- v3.1
- v3.0
- v2.1
- v2.0
- v1.0
- 用語集
TiUPの一般的な操作
このドキュメントでは、TiUPを使用してTiDBクラスタを操作および保守する場合の次の一般的な操作について説明します。
- クラスタリストをビューする
- クラスタを開始します
- クラスタのステータスをビューする
- 構成を変更する
- クラスタを停止します
- クラスタを破壊する
クラスタリストをビューする
TiUPクラスタコンポーネントを使用して、複数のTiDBクラスターを管理できます。 TiDBクラスタがデプロイされると、クラスタはTiUPクラスタリストに表示されます。
リストを表示するには、次のコマンドを実行します。
tiup cluster list
クラスタを開始します
TiDBクラスタのコンポーネントは、次の順序で開始されます。
PD>TiKV>Pump>TiDB>TiFlash>Drainer>TiCDC>プロメテウス>Grafana>Alertmanager
クラスタを開始するには、次のコマンドを実行します。
tiup cluster start ${cluster-name}
ノート:
${cluster-name}
をクラスタの名前に置き換えます。クラスタ名を忘れた場合は、tiup cluster list
を実行して確認してください。
コマンドに-R
つまたは-N
のパラメーターを追加することにより、一部のコンポーネントのみを開始できます。例えば:
このコマンドは、PDコンポーネントのみを開始します。
tiup cluster start ${cluster-name} -R pd
このコマンドは、
1.2.3.4
および1.2.3.5
ホスト上のPDコンポーネントのみを開始します。tiup cluster start ${cluster-name} -N 1.2.3.4:2379,1.2.3.5:2379
ノート:
-R
つまたは-N
のパラメーターを使用して指定されたコンポーネントを開始する場合は、開始順序が正しいことを確認してください。たとえば、TiKVコンポーネントの前にPDコンポーネントを開始します。そうしないと、起動が失敗する可能性があります。
クラスタのステータスをビューする
クラスタを起動した後、各コンポーネントのステータスをチェックして、それらが正常に機能していることを確認します。 TiUPはdisplay
コマンドを提供するため、コンポーネントのステータスを表示するためにすべてのマシンにログインする必要はありません。
tiup cluster display ${cluster-name}
構成を変更する
クラスタの稼働中にコンポーネントのパラメーターを変更する必要がある場合は、 edit-config
コマンドを実行します。詳細な手順は次のとおりです。
クラスタの構成ファイルを編集モードで開きます。
tiup cluster edit-config ${cluster-name}
パラメータを設定します。
構成がコンポーネントに対してグローバルに有効である場合は、
server_configs
を編集します。server_configs: tidb: log.slow-threshold: 300
構成が特定のノードで有効になる場合は、ノードの
config
で構成を編集します。tidb_servers: - host: 10.0.1.11 port: 4000 config: log.slow-threshold: 300
パラメータの形式については、 TiUPパラメータテンプレートを参照してください。
を使用し
.
構成アイテムの階層を表します。コンポーネントの構成パラメーターの詳細については、 TiDB
config.toml.example
、およびTiKVconfig.toml.example
を参照してPDconfig.toml.example
。reload
コマンドを実行して、構成をローリング更新し、対応するコンポーネントを再起動します。tiup cluster reload ${cluster-name} [-N <nodes>] [-R <roles>]
例
tidb-serverでトランザクションサイズ制限パラメーター( パフォーマンスモジュールのtxn-total-size-limit
)を1G
に設定する場合は、次のように構成を編集します。
server_configs:
tidb:
performance.txn-total-size-limit: 1073741824
次に、 tiup cluster reload ${cluster-name} -R tidb
コマンドを実行して、TiDBコンポーネントをローリングリスタートします。
ホットフィックスパッケージと交換してください
通常のアップグレードについては、 TiUPを使用してTiDBをアップグレードするを参照してください。ただし、デバッグなどの一部のシナリオでは、現在実行中のコンポーネントを一時パッケージに置き換える必要がある場合があります。これを実現するには、次のpatch
のコマンドを使用します。
tiup cluster patch --help
Replace the remote package with a specified package and restart the service
Usage:
cluster patch <cluster-name> <package-path> [flags]
Flags:
-h, --help help for patch
-N, --node strings Specify the nodes
--overwrite Use this package in the future scale-out operations
-R, --role strings Specify the role
--transfer-timeout int Timeout in seconds when transferring PD and TiKV store leaders (default 300)
Global Flags:
--native-ssh Use the system's native SSH client
--wait-timeout int Timeout of waiting the operation
--ssh-timeout int Timeout in seconds to connect host via SSH, ignored for operations that don't need an SSH connection. (default 5)
-y, --yes Skip all confirmations and assumes 'yes'
TiDBホットフィックスパッケージが/tmp/tidb-hotfix.tar.gz
に含まれていて、クラスタのすべてのTiDBパッケージを置き換える場合は、次のコマンドを実行します。
tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -R tidb
クラスタの1つのTiDBパッケージのみを置き換えることもできます。
tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -N 172.16.4.5:4000
クラスタの名前を変更します
クラスタをデプロイして開始した後、 tiup cluster rename
コマンドを使用してクラスタの名前を変更できます。
tiup cluster rename ${cluster-name} ${new-name}
ノート:
- クラスタの名前を変更する操作により、監視システム(PrometheusおよびGrafana)が再起動します。
- クラスタクラスタの一部のパネルがGrafanaに残る場合があります。手動で削除する必要があります。
クラスタを停止します
TiDBクラスタのコンポーネントは、次の順序で停止します(監視コンポーネントも停止します)。
Alertmanager> Grafana> Prometheus> TiCDC> Drainer > TiFlash> TiDB> Pump > TiKV> PD
クラスタを停止するには、次のコマンドを実行します。
tiup cluster stop ${cluster-name}
start
コマンドと同様に、 stop
コマンドは、 -R
または-N
個のパラメーターを追加することにより、一部のコンポーネントの停止をサポートします。例えば:
このコマンドは、TiDBコンポーネントのみを停止します。
tiup cluster stop ${cluster-name} -R tidb
このコマンドは、
1.2.3.4
および1.2.3.5
ホスト上のTiDBコンポーネントのみを停止します。tiup cluster stop ${cluster-name} -N 1.2.3.4:4000,1.2.3.5:4000
クラスタデータをクリーンアップする
クラスタデータをクリーンアップする操作は、すべてのサービスを停止し、データディレクトリまたはログディレクトリ、あるいはその両方をクリーンアップします。操作を元に戻すことはできませんので、注意して進めてください。
クラスタのすべてのサービスのデータをクリーンアップしますが、ログは保持します。
tiup cluster clean ${cluster-name} --data
クラスタのすべてのサービスのログをクリーンアップしますが、データは保持します。
tiup cluster clean ${cluster-name} --log
クラスタのすべてのサービスのデータとログをクリーンアップします。
tiup cluster clean ${cluster-name} --all
Prometheusを除くすべてのサービスのログとデータをクリーンアップします。
tiup cluster clean ${cluster-name} --all --ignore-role prometheus
172.16.13.11:9000
つのインスタンスを除くすべてのサービスのログとデータをクリーンアップします。tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.11:9000
172.16.13.12
ノードを除くすべてのサービスのログとデータをクリーンアップします。tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.12
クラスタを破壊する
破棄操作はサービスを停止し、データディレクトリとデプロイメントディレクトリをクリアします。操作を元に戻すことはできませんので、注意して進めてください。
tiup cluster destroy ${cluster-name}