Skip to content

Commit 97bb328

Browse files
leto-bbqleto-bbq
authored
Update show queries columns in docs (#1180)
1 parent b4ce668 commit 97bb328

16 files changed

Lines changed: 124 additions & 88 deletions

File tree

‎src/UserGuide/Master/Table/Reference/System-Tables_apache.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,20 @@ IoTDB> select * from information_schema.regions
191191
| `elapsed_time` | FLOAT | ATTRIBUTE | Query execution duration (in seconds) |
192192
| `statement` | STRING | ATTRIBUTE | SQL statement of the query |
193193
| `user` | STRING | ATTRIBUTE | User who initiated the query |
194+
| `wait_time_in_server` | FLOAT | ATTRIBUTE | Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10) |
195+
| `client_ip` | STRING | ATTRIBUTE | IP address of the client that initiated the query (supported since V2.0.10) |
196+
| `timeout` | INT64 | ATTRIBUTE | Timeout of the query, in ms (supported since V2.0.10) |
194197

195198
* For regular users, the query results only display the queries executed by themselves; for administrators, all queries are displayed.
196199
* Query Example:
197200

198201
```SQL
199202
IoTDB> select * from information_schema.queries
200-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
201-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
202-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203-
|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1| 0.025|select * from information_schema.queries|root|
204-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
204+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
205+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
206+
|20260601_032216_00018_1|2026-06-01T11:22:16.815+08:00| 1| 0.014|select * from information_schema.queries|root| 0.0158324|127.0.0.1| 60000|
207+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
205208
```
206209

207210
### 2.5 COLUMNS

‎src/UserGuide/Master/Table/SQL-Manual/SQL-Maintenance-Statements_apache.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -459,12 +459,12 @@ showQueriesStatement
459459
**Example:**
460460

461461
```SQL
462-
IoTDB> SHOW QUERIES WHERE elapsed_time > 30
463-
+-----------------------+-----------------------------+-----------+------------+------------+----+
464-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
465-
+-----------------------+-----------------------------+-----------+------------+------------+----+
466-
|20250108_101015_00000_1|2025-01-08T18:10:15.935+08:00| 1| 32.283|show queries|root|
467-
+-----------------------+-----------------------------+-----------+------------+------------+----+
462+
IoTDB> SHOW QUERIES WHERE elapsed_time > 0.003
463+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
464+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
465+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
466+
|20260601_032051_00016_1|2026-06-01T11:20:51.130+08:00| 1| 0.017|SHOW QUERIES WHERE elapsed_time > 0.003|root| 0.0190219|127.0.0.1| 60000|
467+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
468468
```
469469

470470
### 5.2 Terminate Queries

‎src/UserGuide/Master/Table/User-Manual/Maintenance-commands_apache.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -289,21 +289,24 @@ showQueriesStatement
289289
- **elapsed_time**: Time elapsed since the query started (in seconds).
290290
- **statement**: The SQL statement being executed.
291291
- **user**: The user who initiated the query.
292+
- **wait_time_in_server**: Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10).
293+
- **client_ip**: IP address of the client that initiated the query (supported since V2.0.10).
294+
- **timeout**: Timeout of the query, in ms (supported since V2.0.10).
292295

293296
**Example**:
294297

295298
```SQL
296-
IoTDB> SHOW QUERIES WHERE elapsed_time > 30;
299+
IoTDB> SHOW QUERIES WHERE elapsed_time > 0.003
297300
```
298301

299302
**Result**:
300303

301304
```Plain
302-
+-----------------------+-----------------------------+-----------+------------+------------+----+
303-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
304-
+-----------------------+-----------------------------+-----------+------------+------------+----+
305-
|20250108_101015_00000_1|2025-01-08T18:10:15.935+08:00| 1| 32.283|show queries|root|
306-
+-----------------------+-----------------------------+-----------+------------+------------+----+
305+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
306+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
307+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
308+
|20260601_032051_00016_1|2026-06-01T11:20:51.130+08:00| 1| 0.017|SHOW QUERIES WHERE elapsed_time > 0.003|root| 0.0190219|127.0.0.1| 60000|
309+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
307310
```
308311

309312

‎src/UserGuide/Master/Tree/User-Manual/Maintenance-commands_apache.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ showQueriesStatement
195195
- **datanodeid**: ID of the DataNode executing the query.
196196
- **elapsedtime**: Time elapsed since the query started (in seconds).
197197
- **statement**: The SQL statement being executed.
198+
- **WaitTimeInServer**: Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10).
199+
- **ClientIp**: IP address of the client that initiated the query (supported since V2.0.10).
200+
- **Timeout**: Timeout of the query, in ms (supported since V2.0.10).
198201

199202
**Example**:
200203

@@ -205,11 +208,11 @@ IoTDB> SHOW QUERIES WHERE elapsedtime > 0.003
205208
**Result**:
206209

207210
```SQL
208-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
209-
| Time| QueryId|DataNodeId|ElapsedTime| Statement|
210-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
211-
|2025-05-09T15:16:01.293+08:00|20250509_071601_00015_1| 1| 0.006|SHOW QUERIES WHERE elapsedtime > 0.003|
212-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
211+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
212+
| Time| QueryId|DataNodeId|ElapsedTime| Statement|WaitTimeInServer| ClientIp|Timeout|
213+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
214+
|2026-06-01T11:13:39.057+08:00|20260601_031339_00003_1| 1| 0.074|SHOW QUERIES WHERE elapsedtime > 0.003| 0.0736961|127.0.0.1| 60000|
215+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
213216
```
214217

215218
### 1.6 Viewing Region Information

‎src/UserGuide/latest-Table/Reference/System-Tables_apache.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,20 @@ IoTDB> select * from information_schema.regions
191191
| `elapsed_time` | FLOAT | ATTRIBUTE | Query execution duration (in seconds) |
192192
| `statement` | STRING | ATTRIBUTE | SQL statement of the query |
193193
| `user` | STRING | ATTRIBUTE | User who initiated the query |
194+
| `wait_time_in_server` | FLOAT | ATTRIBUTE | Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10) |
195+
| `client_ip` | STRING | ATTRIBUTE | IP address of the client that initiated the query (supported since V2.0.10) |
196+
| `timeout` | INT64 | ATTRIBUTE | Timeout of the query, in ms (supported since V2.0.10) |
194197

195198
* For regular users, the query results only display the queries executed by themselves; for administrators, all queries are displayed.
196199
* Query Example:
197200

198201
```SQL
199202
IoTDB> select * from information_schema.queries
200-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
201-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
202-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203-
|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1| 0.025|select * from information_schema.queries|root|
204-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
204+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
205+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
206+
|20260601_032216_00018_1|2026-06-01T11:22:16.815+08:00| 1| 0.014|select * from information_schema.queries|root| 0.0158324|127.0.0.1| 60000|
207+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
205208
```
206209

207210
### 2.5 COLUMNS

‎src/UserGuide/latest-Table/SQL-Manual/SQL-Maintenance-Statements_apache.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -459,12 +459,12 @@ showQueriesStatement
459459
**Example:**
460460

461461
```SQL
462-
IoTDB> SHOW QUERIES WHERE elapsed_time > 30
463-
+-----------------------+-----------------------------+-----------+------------+------------+----+
464-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
465-
+-----------------------+-----------------------------+-----------+------------+------------+----+
466-
|20250108_101015_00000_1|2025-01-08T18:10:15.935+08:00| 1| 32.283|show queries|root|
467-
+-----------------------+-----------------------------+-----------+------------+------------+----+
462+
IoTDB> SHOW QUERIES WHERE elapsed_time > 0.003
463+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
464+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
465+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
466+
|20260601_032051_00016_1|2026-06-01T11:20:51.130+08:00| 1| 0.017|SHOW QUERIES WHERE elapsed_time > 0.003|root| 0.0190219|127.0.0.1| 60000|
467+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
468468
```
469469

470470
### 5.2 Terminate Queries

‎src/UserGuide/latest-Table/User-Manual/Maintenance-commands_apache.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -289,21 +289,24 @@ showQueriesStatement
289289
- **elapsed_time**: Time elapsed since the query started (in seconds).
290290
- **statement**: The SQL statement being executed.
291291
- **user**: The user who initiated the query.
292+
- **wait_time_in_server**: Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10).
293+
- **client_ip**: IP address of the client that initiated the query (supported since V2.0.10).
294+
- **timeout**: Timeout of the query, in ms (supported since V2.0.10).
292295

293296
**Example**:
294297

295298
```SQL
296-
IoTDB> SHOW QUERIES WHERE elapsed_time > 30;
299+
IoTDB> SHOW QUERIES WHERE elapsed_time > 0.003
297300
```
298301

299302
**Result**:
300303

301304
```Plain
302-
+-----------------------+-----------------------------+-----------+------------+------------+----+
303-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
304-
+-----------------------+-----------------------------+-----------+------------+------------+----+
305-
|20250108_101015_00000_1|2025-01-08T18:10:15.935+08:00| 1| 32.283|show queries|root|
306-
+-----------------------+-----------------------------+-----------+------------+------------+----+
305+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
306+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
307+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
308+
|20260601_032051_00016_1|2026-06-01T11:20:51.130+08:00| 1| 0.017|SHOW QUERIES WHERE elapsed_time > 0.003|root| 0.0190219|127.0.0.1| 60000|
309+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
307310
```
308311

309312

‎src/UserGuide/latest/User-Manual/Maintenance-commands_apache.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ showQueriesStatement
195195
- **datanodeid**: ID of the DataNode executing the query.
196196
- **elapsedtime**: Time elapsed since the query started (in seconds).
197197
- **statement**: The SQL statement being executed.
198+
- **WaitTimeInServer**: Cumulative time that the client request waits in the server for results to be returned, in seconds (supported since V2.0.10).
199+
- **ClientIp**: IP address of the client that initiated the query (supported since V2.0.10).
200+
- **Timeout**: Timeout of the query, in ms (supported since V2.0.10).
198201

199202
**Example**:
200203

@@ -205,11 +208,11 @@ IoTDB> SHOW QUERIES WHERE elapsedtime > 0.003
205208
**Result**:
206209

207210
```SQL
208-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
209-
| Time| QueryId|DataNodeId|ElapsedTime| Statement|
210-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
211-
|2025-05-09T15:16:01.293+08:00|20250509_071601_00015_1| 1| 0.006|SHOW QUERIES WHERE elapsedtime > 0.003|
212-
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+
211+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
212+
| Time| QueryId|DataNodeId|ElapsedTime| Statement|WaitTimeInServer| ClientIp|Timeout|
213+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
214+
|2026-06-01T11:13:39.057+08:00|20260601_031339_00003_1| 1| 0.074|SHOW QUERIES WHERE elapsedtime > 0.003| 0.0736961|127.0.0.1| 60000|
215+
+-----------------------------+-----------------------+----------+-----------+--------------------------------------+----------------+---------+-------+
213216
```
214217

215218
### 1.6 Viewing Region Information

‎src/zh/UserGuide/Master/Table/Reference/System-Tables_apache.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,20 @@ IoTDB> select * from information_schema.regions
191191
| elapsed\_time | FLOAT | ATTRIBUTE | 查询执行耗时，单位是秒 |
192192
| statement | STRING | ATTRIBUTE | 查询sql |
193193
| user | STRING | ATTRIBUTE | 发起查询的用户 |
194+
| wait\_time\_in\_server | FLOAT | ATTRIBUTE | 客户端请求在 server 等待结果返回的累计耗时，单位 s（V2.0.10 起支持） |
195+
| client\_ip | STRING | ATTRIBUTE | 发起查询的客户端 ip（V2.0.10 起支持） |
196+
| timeout | INT64 | ATTRIBUTE | 该查询的超时时间，单位 ms（V2.0.10 起支持） |
194197

195198
* 普通用户查询结果仅显示自身执行的查询；管理员显示全部。
196199
* 查询示例：
197200

198201
```SQL
199202
IoTDB> select * from information_schema.queries
200-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
201-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
202-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203-
|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1| 0.025|select * from information_schema.queries|root|
204-
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
203+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
204+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
205+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
206+
|20260601_032216_00018_1|2026-06-01T11:22:16.815+08:00| 1| 0.014|select * from information_schema.queries|root| 0.0158324|127.0.0.1| 60000|
207+
+-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+-------------------+---------+-------+
205208
```
206209

207210
### 2.5 COLUMNS 表

‎src/zh/UserGuide/Master/Table/SQL-Manual/SQL-Maintenance-Statements_apache.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -458,12 +458,12 @@ showQueriesStatement
458458
**示例：**
459459

460460
```SQL
461-
IoTDB> SHOW QUERIES WHERE elapsed_time > 30
462-
+-----------------------+-----------------------------+-----------+------------+------------+----+
463-
| query_id| start_time|datanode_id|elapsed_time| statement|user|
464-
+-----------------------+-----------------------------+-----------+------------+------------+----+
465-
|20250108_101015_00000_1|2025-01-08T18:10:15.935+08:00| 1| 32.283|show queries|root|
466-
+-----------------------+-----------------------------+-----------+------------+------------+----+
461+
IoTDB> SHOW QUERIES WHERE elapsed_time > 0.003
462+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
463+
| query_id| start_time|datanode_id|elapsed_time| statement|user|wait_time_in_server|client_ip|timeout|
464+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
465+
|20260601_032051_00016_1|2026-06-01T11:20:51.130+08:00| 1| 0.017|SHOW QUERIES WHERE elapsed_time > 0.003|root| 0.0190219|127.0.0.1| 60000|
466+
+-----------------------+-----------------------------+-----------+------------+---------------------------------------+----+-------------------+---------+-------+
467467
```
468468

469469
### 5.2 主动终止查询

0 commit comments

Comments
 (0)