From 6440553b3170830f63d5bc73c2b8f341373a350f Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Tue, 30 Jan 2024 14:00:22 +0800 Subject: [PATCH] Update SHOW STATUS docs (#16171) (#16422) --- TOC.md | 1 + sql-statements/sql-statement-flush-status.md | 3 +- sql-statements/sql-statement-show-status.md | 89 ++++++++++--------- status-variables.md | 92 ++++++++++++++++++++ 4 files changed, 143 insertions(+), 42 deletions(-) create mode 100644 status-variables.md diff --git a/TOC.md b/TOC.md index c8dcaa0bed62..59da04930fb5 100644 --- a/TOC.md +++ b/TOC.md @@ -653,6 +653,7 @@ - [TiDB 分布式执行框架介绍](/tidb-distributed-execution-framework.md) - [TiDB 全局排序](/tidb-global-sort.md) - [系统变量](/system-variables.md) + - [服务器状态变量](/status-variables.md) - 配置文件参数 - [tidb-server](/tidb-configuration-file.md) - [tikv-server](/tikv-configuration-file.md) diff --git a/sql-statements/sql-statement-flush-status.md b/sql-statements/sql-statement-flush-status.md index 6bee687395cb..316a6fa35a8f 100644 --- a/sql-statements/sql-statement-flush-status.md +++ b/sql-statements/sql-statement-flush-status.md @@ -99,8 +99,9 @@ show status; ## MySQL 兼容性 -* `FLUSH STATUS` 语句仅用于提供 MySQL 兼容性。 +* `FLUSH STATUS` 语句与 MySQL 兼容。 ## 另请参阅 * [SHOW \[GLOBAL|SESSION\] STATUS](/sql-statements/sql-statement-show-status.md) +* [服务器状态变量](/status-variables.md) diff --git a/sql-statements/sql-statement-show-status.md b/sql-statements/sql-statement-show-status.md index 04215eb0d3e3..83f7534b6644 100644 --- a/sql-statements/sql-statement-show-status.md +++ b/sql-statements/sql-statement-show-status.md @@ -5,68 +5,75 @@ summary: TiDB 数据库中 SHOW [GLOBAL|SESSION] STATUS 的使用概况。 # SHOW [GLOBAL|SESSION] STATUS -`SHOW [GLOBAL|SESSION] STATUS` 语句用于提供 MySQL 兼容性，对 TiDB 没有作用。因为 TiDB 使用 Prometheus 和 Grafana 而非 `SHOW STATUS` 来进行集中度量收集。 +`SHOW [GLOBAL|SESSION] STATUS` 语句用于提供 MySQL 兼容性。对于大部分监控指标，TiDB 使用 Prometheus 和 Grafana 来集中收集，而不是使用 `SHOW STATUS`。 -## 语法图 - -**ShowStmt:** - -![ShowStmt](/media/sqlgram/ShowStmt.png) - -**ShowTargetFilterable:** - -![ShowTargetFilterable](/media/sqlgram/ShowTargetFilterable.png) +该语句输出中各变量的详细介绍，请参考[服务器状态变量](/status-variables.md)。 -**GlobalScope:** +## 语法图 -![GlobalScope](/media/sqlgram/GlobalScope.png) +```ebnf+diagram +ShowStatusStmt ::= + 'SHOW' Scope? 'STATUS' ShowLikeOrWhere? +Scope ::= + ( 'GLOBAL' | 'SESSION' ) +ShowLikeOrWhere ::= + "LIKE" SimpleExpr +| "WHERE" Expression +``` ## 示例 -{{< copyable "sql" >}} - ```sql -show status; +SHOW SESSION STATUS; ``` ``` -+--------------------+--------------------------------------+ -| Variable_name | Value | -+--------------------+--------------------------------------+ -| Ssl_cipher_list | | -| server_id | 93e2e07d-6bb4-4a1b-90b7-e035fae154fe | -| ddl_schema_version | 141 | -| Ssl_verify_mode | 0 | -| Ssl_version | | -| Ssl_cipher | | -+--------------------+--------------------------------------+ -6 rows in set (0.01 sec) ++-------------------------------+--------------------------------------+ +| Variable_name | Value | ++-------------------------------+--------------------------------------+ +| Compression | OFF | +| Compression_algorithm | | +| Compression_level | 0 | +| Ssl_cipher | | +| Ssl_cipher_list | | +| Ssl_server_not_after | | +| Ssl_server_not_before | | +| Ssl_verify_mode | 0 | +| Ssl_version | | +| Uptime | 1409 | +| ddl_schema_version | 116 | +| last_plan_binding_update_time | 0000-00-00 00:00:00 | +| server_id | 61160e73-ab80-40ff-8f33-27d55d475fd1 | ++-------------------------------+--------------------------------------+ +13 rows in set (0.00 sec) ``` -{{< copyable "sql" >}} - ```sql -show global status; +SHOW GLOBAL STATUS; ``` ``` -+--------------------+--------------------------------------+ -| Variable_name | Value | -+--------------------+--------------------------------------+ -| Ssl_cipher | | -| Ssl_cipher_list | | -| Ssl_verify_mode | 0 | -| Ssl_version | | -| server_id | 93e2e07d-6bb4-4a1b-90b7-e035fae154fe | -| ddl_schema_version | 141 | -+--------------------+--------------------------------------+ -6 rows in set (0.00 sec) ++-----------------------+--------------------------------------+ +| Variable_name | Value | ++-----------------------+--------------------------------------+ +| Ssl_cipher | | +| Ssl_cipher_list | | +| Ssl_server_not_after | | +| Ssl_server_not_before | | +| Ssl_verify_mode | 0 | +| Ssl_version | | +| Uptime | 1413 | +| ddl_schema_version | 116 | +| server_id | 61160e73-ab80-40ff-8f33-27d55d475fd1 | ++-----------------------+--------------------------------------+ +9 rows in set (0.00 sec) ``` ## MySQL 兼容性 -`SHOW [GLOBAL|SESSION] STATUS` 语句仅用于提供 MySQL 兼容性。 +`SHOW [GLOBAL|SESSION] STATUS` 语句与 MySQL 兼容。 ## 另请参阅 * [FLUSH STATUS](/sql-statements/sql-statement-flush-status.md) +* [服务器状态变量](/status-variables.md) \ No newline at end of file diff --git a/status-variables.md b/status-variables.md new file mode 100644 index 000000000000..83cb5d844b40 --- /dev/null +++ b/status-variables.md @@ -0,0 +1,92 @@ +--- +title: 服务器状态变量 +summary: 使用状态变量查看系统和会话状态 +--- + +# 服务器状态变量 + +服务器状态变量提供有关服务器全局状态和 TiDB 中当前会话状态的信息。大多数变量与 MySQL 兼容。 + +你可以使用 [SHOW GLOBAL STATUS](/sql-statements/sql-statement-show-status.md) 命令查看全局状态，使用 [SHOW SESSION STATUS](/sql-statements/sql-statement-show-status.md) 命令查看当前会话状态。 + +此外，[FLUSH STATUS](/sql-statements/sql-statement-flush-status.md) 命令与 MySQL 兼容。 + +## 变量参考 + +### Compression + +- 作用域：SESSION +- 类型：布尔值 +- MySQL 是否使用压缩协议。 + +### Compression_algorithm + +- 作用域：SESSION +- 类型：字符串 +- MySQL 协议使用的压缩算法。 + +### Compression_level + +- 作用域：SESSION +- 类型：整数型 +- MySQL 协议使用的压缩等级。 + +### Ssl_cipher + +- 作用域：SESSION | GLOBAL +- 类型：字符串 +- 正在使用的 TLS 加密套件. + +### Ssl_cipher_list + +- 作用域：SESSION | GLOBAL +- 类型：字符串 +- 服务器支持的 TLS 加密套件列表. + +### Ssl_server_not_after + +- 作用域：SESSION | GLOBAL +- 类型：日期 +- 服务器用于 TLS 连接的 X.509 证书的过期时间。 + +### Ssl_server_not_before + +- 作用域：SESSION | GLOBAL +- 类型：字符串 +- 服务器用于 TLS 连接的 X.509 证书的开始时间。 + +### Ssl_verify_mode + +- 作用域：SESSION | GLOBAL +- 类型：整数型 +- TLS 验证模式掩码。 + +### Ssl_version + +- 作用域：SESSION | GLOBAL +- 类型：字符串 +- TLS 协议使用的版本。 + +### Uptime + +- 作用域：SESSION | GLOBAL +- 类型：整数型 +- 服务器正常运行时间（秒）。 + +### ddl_schema_version + +- 作用域：SESSION | GLOBAL +- 类型：整数型 +- DDL schema 使用的版本。 + +### last_plan_binding_update_time New in v5.2.0 + +- 作用域：SESSION +- 类型：时间戳 +- 最后一次计划绑定更新的日期时间。 + +### server_id + +- 作用域：SESSION | GLOBAL +- 类型：字符串 +- 服务器的通用唯一识别码 (UUID)。 \ No newline at end of file