This is an automated email from the ASF dual-hosted git repository.
critas pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new a95e1cae Add system tables in table model (#689)
a95e1cae is described below
commit a95e1caecee53781aae6b001b86415bad2938cd4
Author: leto-b <[email protected]>
AuthorDate: Thu Apr 3 17:30:44 2025 +0800
Add system tables in table model (#689)
* add system tables in table model
* add system tables in table model
* adjust sidebar and path
* adjust sidebar
---
src/.vuepress/sidebar/V2.0.x/en-Table.ts | 1 +
src/.vuepress/sidebar/V2.0.x/zh-Table.ts | 1 +
src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts | 1 +
src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts | 1 +
.../Master/Table/Reference/System-Tables.md | 326 ++++++++++++++++++++
.../Table/User-Manual/Maintenance-commands.md | 2 +
.../latest-Table/Reference/System-Tables.md | 326 ++++++++++++++++++++
.../User-Manual/Maintenance-commands.md | 2 +
.../Master/Table/Reference/System-Tables.md | 327 +++++++++++++++++++++
.../Table/User-Manual/Maintenance-statement.md | 2 +
.../latest-Table/Reference/System-Tables.md | 327 +++++++++++++++++++++
.../User-Manual/Maintenance-statement.md | 2 +
12 files changed, 1318 insertions(+)
diff --git a/src/.vuepress/sidebar/V2.0.x/en-Table.ts
b/src/.vuepress/sidebar/V2.0.x/en-Table.ts
index 52eb6909..6a97f9bb 100644
--- a/src/.vuepress/sidebar/V2.0.x/en-Table.ts
+++ b/src/.vuepress/sidebar/V2.0.x/en-Table.ts
@@ -193,6 +193,7 @@ export const enSidebar = {
{ text: 'Sample Data', link: 'Sample-Data' },
{ text: 'Config Manual', link: 'System-Config-Manual' },
{ text: 'Status Codes', link: 'Status-Codes' },
+ { text: 'System Tables', link: 'System-Tables' },
],
},
],
diff --git a/src/.vuepress/sidebar/V2.0.x/zh-Table.ts
b/src/.vuepress/sidebar/V2.0.x/zh-Table.ts
index 628f1d23..742a5312 100644
--- a/src/.vuepress/sidebar/V2.0.x/zh-Table.ts
+++ b/src/.vuepress/sidebar/V2.0.x/zh-Table.ts
@@ -183,6 +183,7 @@ export const zhSidebar = {
{ text: '示例数据', link: 'Sample-Data' },
{ text: '配置参数', link: 'System-Config-Manual' },
{ text: '状态码', link: 'Status-Codes' },
+ { text: '系统表', link: 'System-Tables' },
],
},
],
diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts
b/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts
index 78121912..4a98aaaa 100644
--- a/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts
+++ b/src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts
@@ -198,6 +198,7 @@ export const enSidebar = {
{ text: 'Sample Data', link: 'Sample-Data' },
{ text: 'Config Manual', link: 'System-Config-Manual' },
{ text: 'Status Codes', link: 'Status-Codes' },
+ { text: 'System Tables', link: 'System-Tables' },
],
},
],
diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts
b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts
index 705200aa..42308f4e 100644
--- a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts
+++ b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Table.ts
@@ -187,6 +187,7 @@ export const zhSidebar = {
{ text: '示例数据', link: 'Sample-Data' },
{ text: '配置参数', link: 'System-Config-Manual' },
{ text: '状态码', link: 'Status-Codes' },
+ { text: '系统表', link: 'System-Tables' },
],
},
],
diff --git a/src/UserGuide/Master/Table/Reference/System-Tables.md
b/src/UserGuide/Master/Table/Reference/System-Tables.md
new file mode 100644
index 00000000..6a123413
--- /dev/null
+++ b/src/UserGuide/Master/Table/Reference/System-Tables.md
@@ -0,0 +1,326 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# System Tables (V2.0.2)
+
+IoTDB has a built-in system database called `INFORMATION_SCHEMA`, which
contains a series of system tables for storing IoTDB runtime information (such
as currently executing SQL statements, etc.). Currently, the
`INFORMATION_SCHEMA` database only supports read operations.
+
+## 1. System Database
+
+* **Name**: `INFORMATION_SCHEMA`
+* **Commands**: Read-only, only supports `Show databases (DETAILS)` / `Show
Tables (DETAILS)` / `Use`. Other operations will result in an error: `"The
database 'information_schema' can only be queried."`
+* **Attributes**:` TTL=INF`, other attributes default to `null `
+* **SQL Example**:
+
+```sql
+IoTDB> show databases
++------------------+-------+-----------------------+---------------------+---------------------+
+|
Database|TTL(ms)|SchemaReplicationFactor|DataReplicationFactor|TimePartitionInterval|
++------------------+-------+-----------------------+---------------------+---------------------+
+|information_schema| INF| null| null|
null|
++------------------+-------+-----------------------+---------------------+---------------------+
+
+IoTDB> show tables from information_schema
++-------------+-------+
+| TableName|TTL(ms)|
++-------------+-------+
+| databases| INF|
+| tables| INF|
+| pipe_plugins| INF|
+|subscriptions| INF|
+| regions| INF|
+| columns| INF|
+| topics| INF|
+| queries| INF|
+| pipes| INF|
++-------------+-------+
+```
+
+## 2. System Tables
+
+* **Names**: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`,
`PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS` (detailed descriptions in
later sections)
+* **Operations**: Read-only, only supports `SELECT`, `COUNT/SHOW DEVICES`,
`DESC`. Any modifications to table structure or content are not allowed and
will result in an error: `"The database 'information_schema' can only be
queried." `
+* **Column Names**: System table column names are all lowercase by default
and separated by underscores (`_`).
+
+### 2.1 DATABASES
+
+* Contains information about all databases in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| --------------------------------- | ----------- | ------------- |
-------------------------------- |
+| `database` | STRING | TAG | Database name
|
+| `ttl(ms)` | STRING | ATTRIBUTE | Data retention time
|
+| `schema_replication_factor` | INT32 | ATTRIBUTE | Schema replica count
|
+| `data_replication_factor` | INT32 | ATTRIBUTE | Data replica count
|
+| `time_partition_interval` | INT64 | ATTRIBUTE | Time partition
interval |
+| `schema_region_group_num` | INT32 | ATTRIBUTE | Number of schema
region groups |
+| `data_region_group_num` | INT32 | ATTRIBUTE | Number of data
region groups |
+
+* Query Example:
+
+```sql
+IoTDB> select * from information_schema.databases
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|
database|ttl(ms)|schema_replication_factor|data_replication_factor|time_partition_interval|schema_region_group_num|data_region_group_num|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|information_schema| INF| null| null|
null| null| null|
+| database1| INF| 1| 1|
604800000| 0| 0|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+```
+
+### 2.2 TABLES
+
+* Contains information about all tables in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description |
+| ------------------ | ----------- | ------------- | --------------------- |
+| `database` | STRING | TAG | Database name |
+| `table_name` | STRING | TAG | Table name |
+| `ttl(ms)` | STRING | ATTRIBUTE | Data retention time |
+| `status` | STRING | ATTRIBUTE | Status |
+| `comment` | STRING | ATTRIBUTE | Description/comment |
+
+* Note: Possible values for `status`: `USING`, `PRE_CREATE`, `PRE_DELETE`.
For details, refer to the [View
Tables](../Basic-Concept/Table-Management.md#12-view-tables) in Table
Management documentation
+* Query Example:
+
+```sql
+IoTDB> select * from information_schema.tables
++------------------+-------------+-----------+------+-------+
+| database| table_name| ttl(ms)|status|comment|
++------------------+-------------+-----------+------+-------+
+|information_schema| databases| INF| USING| null|
+|information_schema| tables| INF| USING| null|
+|information_schema| pipe_plugins| INF| USING| null|
+|information_schema|subscriptions| INF| USING| null|
+|information_schema| regions| INF| USING| null|
+|information_schema| columns| INF| USING| null|
+|information_schema| topics| INF| USING| null|
+|information_schema| queries| INF| USING| null|
+|information_schema| pipes| INF| USING| null|
+| database1| table1|31536000000| USING| null|
++------------------+-------------+-----------+------+-------+
+```
+
+### 2.3 REGIONS
+
+* Contains information about all regions in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ------------------------- | ----------- | -------------
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `region_id` | INT32 | TAG | Region ID
|
+| `datanode_id` | INT32 | TAG | DataNode ID
|
+| `type` | STRING | ATTRIBUTE | Type
(`SchemaRegion`/`DataRegion`)
|
+| `status` | STRING | ATTRIBUTE | Status (`Running`,`Unknown`,
etc.)
|
+| `database` | STRING | ATTRIBUTE | Database name
|
+| `series_slot_num` | INT32 | ATTRIBUTE | Number of series slots
|
+| `time_slot_num` | INT64 | ATTRIBUTE | Number of time slots
|
+| `rpc_address` | STRING | ATTRIBUTE | RPC address
|
+| `rpc_port` | INT32 | ATTRIBUTE | RPC port
|
+| `internal_address` | STRING | ATTRIBUTE | Internal communication
address
|
+| `role` | STRING | ATTRIBUTE | Role (`Leader`/`Follower`)
|
+| `create_time` | TIMESTAMP | ATTRIBUTE | Creation time
|
+| `tsfile_size_bytes` | INT64 | ATTRIBUTE | - For**DataRegion with
statistics **: Total file size of TsFiles. <br>- For**DataRegion without
statistics**(Unknown):`-1`.<br>- For**SchemaRegion**:`null`. |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.regions
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+|region_id|datanode_id| type| status|
database|series_slot_num|time_slot_num|rpc_address|rpc_port|internal_address|
role| create_time|tsfile_size_bytes|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+| 0| 1|SchemaRegion|Running|database1| 12|
0| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:08.485+08:00| null|
+| 1| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3985|
+| 2| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3841|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+```
+
+### 2.4 QUERIES
+
+* Contains information about all currently executing queries in the cluster.
Can also be queried using the `SHOW QUERIES` syntax.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| -------------------- | ----------- | ------------- |
------------------------------------------------------------ |
+| `query_id` | STRING | TAG | Query ID
|
+| `start_time` | TIMESTAMP | ATTRIBUTE | Query start timestamp (precision
matches system precision) |
+| `datanode_id` | INT32 | ATTRIBUTE | DataNode ID that initiated the
query |
+| `elapsed_time` | FLOAT | ATTRIBUTE | Query execution duration (in
seconds) |
+| `statement` | STRING | ATTRIBUTE | SQL statement of the query
|
+| `user` | STRING | ATTRIBUTE | User who initiated the query
|
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.queries
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+| query_id|
start_time|datanode_id|elapsed_time|
statement|user|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1|
0.025|select * from information_schema.queries|root|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+```
+
+### 2.5 COLUMNS
+
+* Contains information about all columns in tables across the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description |
+| ------------------- | ----------- | ------------- | -------------------- |
+| `database` | STRING | TAG | Database name |
+| `table_name` | STRING | TAG | Table name |
+| `column_name` | STRING | TAG | Column name |
+| `datatype` | STRING | ATTRIBUTE | Column data type |
+| `category` | STRING | ATTRIBUTE | Column category |
+| `status` | STRING | ATTRIBUTE | Column status |
+| `comment` | STRING | ATTRIBUTE | Column description |
+
+Notes: Possible values for `status`: `USING`, `PRE_DELETE`. For details, refer
to [Viewing Table
Columns](../Basic-Concept/Table-Management.html#13-view-table-columns) in Table
Management documentation.
+> Users can only query tables for which they have select permissions .
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.columns where database = 'database1'
++---------+----------+------------+---------+---------+------+-------+
+| database|table_name| column_name| datatype| category|status|comment|
++---------+----------+------------+---------+---------+------+-------+
+|database1| table1| time|TIMESTAMP| TIME| USING| null|
+|database1| table1| region| STRING| TAG| USING| null|
+|database1| table1| plant_id| STRING| TAG| USING| null|
+|database1| table1| device_id| STRING| TAG| USING| null|
+|database1| table1| model_id| STRING|ATTRIBUTE| USING| null|
+|database1| table1| maintenance| STRING|ATTRIBUTE| USING| null|
+|database1| table1| temperature| FLOAT| FIELD| USING| null|
+|database1| table1| humidity| FLOAT| FIELD| USING| null|
+|database1| table1| status| BOOLEAN| FIELD| USING| null|
+|database1| table1|arrival_time|TIMESTAMP| FIELD| USING| null|
++---------+----------+------------+---------+---------+------+-------+
+```
+
+### 2.6 PIPES
+
+* Contains information about all pipes in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ----------------------------------- | ----------- | ------------- |
---------------------------------------------------------- |
+| `id` | STRING | TAG | Pipe name
|
+| `creation_time` | TIMESTAMP | ATTRIBUTE | Creation time
|
+| `state` | STRING | ATTRIBUTE | Pipe status
(`RUNNING`/`STOPPED`) |
+| `pipe_source` | STRING | ATTRIBUTE | Source plugin
parameters |
+| `pipe_processor` | STRING | ATTRIBUTE | Processor plugin
parameters |
+| `pipe_sink` | STRING | ATTRIBUTE | Sink plugin
parameters |
+| `exception_message` | STRING | ATTRIBUTE | Exception message
|
+| `remaining_event_count` | INT64 | ATTRIBUTE | Remaining event
count (`-1`if Unknown) |
+| `estimated_remaining_seconds` | DOUBLE | ATTRIBUTE | Estimated
remaining time in seconds (`-1`if Unknown) |
+
+* Query Example:
+
+```SQL
+select * from information_schema.pipes
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+| id| creation_time| state|
pipe_source|pipe_processor|
pipe_sink|exception_message|remaining_event_count|estimated_remaining_seconds|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+|tablepipe1|2025-03-31T12:25:24.040+08:00|RUNNING|{__system.sql-dialect=table,
source.password=******, source.username=root}| {}|{format=hybrid,
node-urls=192.168.xxx.xxx:6667, sink=iotdb-thrift-sink}| |
0| 0.0|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+```
+
+### 2.7 PIPE\_PLUGINS
+
+* Contains information about all PIPE plugins in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ------------------- | ----------- | ------------- |
----------------------------------------------------- |
+| `plugin_name` | STRING | TAG | Plugin name
|
+| `plugin_type` | STRING | ATTRIBUTE | Plugin type (`Builtin`/`External`)
|
+| `class_name` | STRING | ATTRIBUTE | Plugin's main class name
|
+| `plugin_jar` | STRING | ATTRIBUTE | Plugin's JAR file name (`null`for
builtin type) |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.pipe_plugins
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+| plugin_name|plugin_type|
class_name|plugin_jar|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+|IOTDB-THRIFT-SSL-SINK|
Builtin|org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftSslConnector|
null|
+| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.airgap.IoTDBAirGapConnector|
null|
+| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.donothing.DoNothingConnector|
null|
+| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.processor.donothing.DoNothingProcessor|
null|
+| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftConnector|
null|
+| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.extractor.iotdb.IoTDBExtractor|
null|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+```
+
+### 2.8 SUBSCRIPTIONS
+
+* Contains information about all data subscriptions in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ---------------------------- | ----------- | ------------- |
------------------------- |
+| `topic_name` | STRING | TAG | Subscription topic name |
+| `consumer_group_name` | STRING | TAG | Consumer group name |
+| `subscribed_consumers` | STRING | ATTRIBUTE | Subscribed consumers |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.subscriptions where topic_name =
'topic_1'
++----------+-------------------+--------------------------------+
+|topic_name|consumer_group_name| subscribed_consumers|
++----------+-------------------+--------------------------------+
+| topic_1| cg1|[c3, c4, c5, c6, c7, c0, c1, c2]|
++----------+-------------------+--------------------------------+
+```
+
+### 2.9 TOPICS
+
+* Contains information about all data subscription topics in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| --------------------- | ----------- | ------------- |
-------------------------------- |
+| `topic_name` | STRING | TAG | Subscription topic name |
+| `topic_configs` | STRING | ATTRIBUTE | Topic configuration parameters |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.topics
++----------+----------------------------------------------------------------+
+|topic_name| topic_configs|
++----------+----------------------------------------------------------------+
+| topic|{__system.sql-dialect=table, start-time=2025-01-10T17:05:38.282}|
++----------+----------------------------------------------------------------+
+```
+
+## 3. Permission Description
+
+* GRANT/REVOKE operations are not supported for the `information_schema`
database or any of its tables.
+* All users can view `information_schema` database details via the `SHOW
DATABASES` statement.
+* All users can list system tables via `SHOW TABLES FROM information_schema`.
+* All users can inspect system table structures using the `DESC` statement.
+* Currently, only the root user can query data from system tables via
`SELECT`—other users will receive empty result sets.
diff --git a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md
b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md
index ddf9e9ef..75ee2f6d 100644
--- a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md
+++ b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md
@@ -261,6 +261,8 @@ IoTDB> SHOW CURRENT_TIMESTAMP;
**Description**: Displays information about all currently executing queries.
+> For more details on how to use system tables, please refer to [System
Tables](../Reference/System-Tables.md)
+
**Syntax**:
```SQL
diff --git a/src/UserGuide/latest-Table/Reference/System-Tables.md
b/src/UserGuide/latest-Table/Reference/System-Tables.md
new file mode 100644
index 00000000..6a123413
--- /dev/null
+++ b/src/UserGuide/latest-Table/Reference/System-Tables.md
@@ -0,0 +1,326 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# System Tables (V2.0.2)
+
+IoTDB has a built-in system database called `INFORMATION_SCHEMA`, which
contains a series of system tables for storing IoTDB runtime information (such
as currently executing SQL statements, etc.). Currently, the
`INFORMATION_SCHEMA` database only supports read operations.
+
+## 1. System Database
+
+* **Name**: `INFORMATION_SCHEMA`
+* **Commands**: Read-only, only supports `Show databases (DETAILS)` / `Show
Tables (DETAILS)` / `Use`. Other operations will result in an error: `"The
database 'information_schema' can only be queried."`
+* **Attributes**:` TTL=INF`, other attributes default to `null `
+* **SQL Example**:
+
+```sql
+IoTDB> show databases
++------------------+-------+-----------------------+---------------------+---------------------+
+|
Database|TTL(ms)|SchemaReplicationFactor|DataReplicationFactor|TimePartitionInterval|
++------------------+-------+-----------------------+---------------------+---------------------+
+|information_schema| INF| null| null|
null|
++------------------+-------+-----------------------+---------------------+---------------------+
+
+IoTDB> show tables from information_schema
++-------------+-------+
+| TableName|TTL(ms)|
++-------------+-------+
+| databases| INF|
+| tables| INF|
+| pipe_plugins| INF|
+|subscriptions| INF|
+| regions| INF|
+| columns| INF|
+| topics| INF|
+| queries| INF|
+| pipes| INF|
++-------------+-------+
+```
+
+## 2. System Tables
+
+* **Names**: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`,
`PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS` (detailed descriptions in
later sections)
+* **Operations**: Read-only, only supports `SELECT`, `COUNT/SHOW DEVICES`,
`DESC`. Any modifications to table structure or content are not allowed and
will result in an error: `"The database 'information_schema' can only be
queried." `
+* **Column Names**: System table column names are all lowercase by default
and separated by underscores (`_`).
+
+### 2.1 DATABASES
+
+* Contains information about all databases in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| --------------------------------- | ----------- | ------------- |
-------------------------------- |
+| `database` | STRING | TAG | Database name
|
+| `ttl(ms)` | STRING | ATTRIBUTE | Data retention time
|
+| `schema_replication_factor` | INT32 | ATTRIBUTE | Schema replica count
|
+| `data_replication_factor` | INT32 | ATTRIBUTE | Data replica count
|
+| `time_partition_interval` | INT64 | ATTRIBUTE | Time partition
interval |
+| `schema_region_group_num` | INT32 | ATTRIBUTE | Number of schema
region groups |
+| `data_region_group_num` | INT32 | ATTRIBUTE | Number of data
region groups |
+
+* Query Example:
+
+```sql
+IoTDB> select * from information_schema.databases
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|
database|ttl(ms)|schema_replication_factor|data_replication_factor|time_partition_interval|schema_region_group_num|data_region_group_num|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|information_schema| INF| null| null|
null| null| null|
+| database1| INF| 1| 1|
604800000| 0| 0|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+```
+
+### 2.2 TABLES
+
+* Contains information about all tables in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description |
+| ------------------ | ----------- | ------------- | --------------------- |
+| `database` | STRING | TAG | Database name |
+| `table_name` | STRING | TAG | Table name |
+| `ttl(ms)` | STRING | ATTRIBUTE | Data retention time |
+| `status` | STRING | ATTRIBUTE | Status |
+| `comment` | STRING | ATTRIBUTE | Description/comment |
+
+* Note: Possible values for `status`: `USING`, `PRE_CREATE`, `PRE_DELETE`.
For details, refer to the [View
Tables](../Basic-Concept/Table-Management.md#12-view-tables) in Table
Management documentation
+* Query Example:
+
+```sql
+IoTDB> select * from information_schema.tables
++------------------+-------------+-----------+------+-------+
+| database| table_name| ttl(ms)|status|comment|
++------------------+-------------+-----------+------+-------+
+|information_schema| databases| INF| USING| null|
+|information_schema| tables| INF| USING| null|
+|information_schema| pipe_plugins| INF| USING| null|
+|information_schema|subscriptions| INF| USING| null|
+|information_schema| regions| INF| USING| null|
+|information_schema| columns| INF| USING| null|
+|information_schema| topics| INF| USING| null|
+|information_schema| queries| INF| USING| null|
+|information_schema| pipes| INF| USING| null|
+| database1| table1|31536000000| USING| null|
++------------------+-------------+-----------+------+-------+
+```
+
+### 2.3 REGIONS
+
+* Contains information about all regions in the cluster.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ------------------------- | ----------- | -------------
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `region_id` | INT32 | TAG | Region ID
|
+| `datanode_id` | INT32 | TAG | DataNode ID
|
+| `type` | STRING | ATTRIBUTE | Type
(`SchemaRegion`/`DataRegion`)
|
+| `status` | STRING | ATTRIBUTE | Status (`Running`,`Unknown`,
etc.)
|
+| `database` | STRING | ATTRIBUTE | Database name
|
+| `series_slot_num` | INT32 | ATTRIBUTE | Number of series slots
|
+| `time_slot_num` | INT64 | ATTRIBUTE | Number of time slots
|
+| `rpc_address` | STRING | ATTRIBUTE | RPC address
|
+| `rpc_port` | INT32 | ATTRIBUTE | RPC port
|
+| `internal_address` | STRING | ATTRIBUTE | Internal communication
address
|
+| `role` | STRING | ATTRIBUTE | Role (`Leader`/`Follower`)
|
+| `create_time` | TIMESTAMP | ATTRIBUTE | Creation time
|
+| `tsfile_size_bytes` | INT64 | ATTRIBUTE | - For**DataRegion with
statistics **: Total file size of TsFiles. <br>- For**DataRegion without
statistics**(Unknown):`-1`.<br>- For**SchemaRegion**:`null`. |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.regions
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+|region_id|datanode_id| type| status|
database|series_slot_num|time_slot_num|rpc_address|rpc_port|internal_address|
role| create_time|tsfile_size_bytes|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+| 0| 1|SchemaRegion|Running|database1| 12|
0| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:08.485+08:00| null|
+| 1| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3985|
+| 2| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3841|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+```
+
+### 2.4 QUERIES
+
+* Contains information about all currently executing queries in the cluster.
Can also be queried using the `SHOW QUERIES` syntax.
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| -------------------- | ----------- | ------------- |
------------------------------------------------------------ |
+| `query_id` | STRING | TAG | Query ID
|
+| `start_time` | TIMESTAMP | ATTRIBUTE | Query start timestamp (precision
matches system precision) |
+| `datanode_id` | INT32 | ATTRIBUTE | DataNode ID that initiated the
query |
+| `elapsed_time` | FLOAT | ATTRIBUTE | Query execution duration (in
seconds) |
+| `statement` | STRING | ATTRIBUTE | SQL statement of the query
|
+| `user` | STRING | ATTRIBUTE | User who initiated the query
|
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.queries
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+| query_id|
start_time|datanode_id|elapsed_time|
statement|user|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1|
0.025|select * from information_schema.queries|root|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+```
+
+### 2.5 COLUMNS
+
+* Contains information about all columns in tables across the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description |
+| ------------------- | ----------- | ------------- | -------------------- |
+| `database` | STRING | TAG | Database name |
+| `table_name` | STRING | TAG | Table name |
+| `column_name` | STRING | TAG | Column name |
+| `datatype` | STRING | ATTRIBUTE | Column data type |
+| `category` | STRING | ATTRIBUTE | Column category |
+| `status` | STRING | ATTRIBUTE | Column status |
+| `comment` | STRING | ATTRIBUTE | Column description |
+
+Notes: Possible values for `status`: `USING`, `PRE_DELETE`. For details, refer
to [Viewing Table
Columns](../Basic-Concept/Table-Management.html#13-view-table-columns) in Table
Management documentation.
+> Users can only query tables for which they have select permissions .
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.columns where database = 'database1'
++---------+----------+------------+---------+---------+------+-------+
+| database|table_name| column_name| datatype| category|status|comment|
++---------+----------+------------+---------+---------+------+-------+
+|database1| table1| time|TIMESTAMP| TIME| USING| null|
+|database1| table1| region| STRING| TAG| USING| null|
+|database1| table1| plant_id| STRING| TAG| USING| null|
+|database1| table1| device_id| STRING| TAG| USING| null|
+|database1| table1| model_id| STRING|ATTRIBUTE| USING| null|
+|database1| table1| maintenance| STRING|ATTRIBUTE| USING| null|
+|database1| table1| temperature| FLOAT| FIELD| USING| null|
+|database1| table1| humidity| FLOAT| FIELD| USING| null|
+|database1| table1| status| BOOLEAN| FIELD| USING| null|
+|database1| table1|arrival_time|TIMESTAMP| FIELD| USING| null|
++---------+----------+------------+---------+---------+------+-------+
+```
+
+### 2.6 PIPES
+
+* Contains information about all pipes in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ----------------------------------- | ----------- | ------------- |
---------------------------------------------------------- |
+| `id` | STRING | TAG | Pipe name
|
+| `creation_time` | TIMESTAMP | ATTRIBUTE | Creation time
|
+| `state` | STRING | ATTRIBUTE | Pipe status
(`RUNNING`/`STOPPED`) |
+| `pipe_source` | STRING | ATTRIBUTE | Source plugin
parameters |
+| `pipe_processor` | STRING | ATTRIBUTE | Processor plugin
parameters |
+| `pipe_sink` | STRING | ATTRIBUTE | Sink plugin
parameters |
+| `exception_message` | STRING | ATTRIBUTE | Exception message
|
+| `remaining_event_count` | INT64 | ATTRIBUTE | Remaining event
count (`-1`if Unknown) |
+| `estimated_remaining_seconds` | DOUBLE | ATTRIBUTE | Estimated
remaining time in seconds (`-1`if Unknown) |
+
+* Query Example:
+
+```SQL
+select * from information_schema.pipes
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+| id| creation_time| state|
pipe_source|pipe_processor|
pipe_sink|exception_message|remaining_event_count|estimated_remaining_seconds|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+|tablepipe1|2025-03-31T12:25:24.040+08:00|RUNNING|{__system.sql-dialect=table,
source.password=******, source.username=root}| {}|{format=hybrid,
node-urls=192.168.xxx.xxx:6667, sink=iotdb-thrift-sink}| |
0| 0.0|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+```
+
+### 2.7 PIPE\_PLUGINS
+
+* Contains information about all PIPE plugins in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ------------------- | ----------- | ------------- |
----------------------------------------------------- |
+| `plugin_name` | STRING | TAG | Plugin name
|
+| `plugin_type` | STRING | ATTRIBUTE | Plugin type (`Builtin`/`External`)
|
+| `class_name` | STRING | ATTRIBUTE | Plugin's main class name
|
+| `plugin_jar` | STRING | ATTRIBUTE | Plugin's JAR file name (`null`for
builtin type) |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.pipe_plugins
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+| plugin_name|plugin_type|
class_name|plugin_jar|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+|IOTDB-THRIFT-SSL-SINK|
Builtin|org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftSslConnector|
null|
+| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.airgap.IoTDBAirGapConnector|
null|
+| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.donothing.DoNothingConnector|
null|
+| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.processor.donothing.DoNothingProcessor|
null|
+| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftConnector|
null|
+| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.extractor.iotdb.IoTDBExtractor|
null|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+```
+
+### 2.8 SUBSCRIPTIONS
+
+* Contains information about all data subscriptions in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| ---------------------------- | ----------- | ------------- |
------------------------- |
+| `topic_name` | STRING | TAG | Subscription topic name |
+| `consumer_group_name` | STRING | TAG | Consumer group name |
+| `subscribed_consumers` | STRING | ATTRIBUTE | Subscribed consumers |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.subscriptions where topic_name =
'topic_1'
++----------+-------------------+--------------------------------+
+|topic_name|consumer_group_name| subscribed_consumers|
++----------+-------------------+--------------------------------+
+| topic_1| cg1|[c3, c4, c5, c6, c7, c0, c1, c2]|
++----------+-------------------+--------------------------------+
+```
+
+### 2.9 TOPICS
+
+* Contains information about all data subscription topics in the cluster
+* Table structure is as follows:
+
+| Column Name | Data Type | Column Type | Description
|
+| --------------------- | ----------- | ------------- |
-------------------------------- |
+| `topic_name` | STRING | TAG | Subscription topic name |
+| `topic_configs` | STRING | ATTRIBUTE | Topic configuration parameters |
+
+* Query Example:
+
+```SQL
+IoTDB> select * from information_schema.topics
++----------+----------------------------------------------------------------+
+|topic_name| topic_configs|
++----------+----------------------------------------------------------------+
+| topic|{__system.sql-dialect=table, start-time=2025-01-10T17:05:38.282}|
++----------+----------------------------------------------------------------+
+```
+
+## 3. Permission Description
+
+* GRANT/REVOKE operations are not supported for the `information_schema`
database or any of its tables.
+* All users can view `information_schema` database details via the `SHOW
DATABASES` statement.
+* All users can list system tables via `SHOW TABLES FROM information_schema`.
+* All users can inspect system table structures using the `DESC` statement.
+* Currently, only the root user can query data from system tables via
`SELECT`—other users will receive empty result sets.
diff --git a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md
b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md
index ddf9e9ef..75ee2f6d 100644
--- a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md
+++ b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md
@@ -261,6 +261,8 @@ IoTDB> SHOW CURRENT_TIMESTAMP;
**Description**: Displays information about all currently executing queries.
+> For more details on how to use system tables, please refer to [System
Tables](../Reference/System-Tables.md)
+
**Syntax**:
```SQL
diff --git a/src/zh/UserGuide/Master/Table/Reference/System-Tables.md
b/src/zh/UserGuide/Master/Table/Reference/System-Tables.md
new file mode 100644
index 00000000..63d87127
--- /dev/null
+++ b/src/zh/UserGuide/Master/Table/Reference/System-Tables.md
@@ -0,0 +1,327 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# 系统表 (V2.0.2)
+
+IoTDB 内置系统数据库 `INFORMATION_SCHEMA`,其中包含一系列系统表,用于存储 IoTDB 运行时信息(如当前正在执行的 SQL
语句等)。目前`INFORMATION_SCHEMA`数据库只支持读操作。
+
+## 1. 系统库
+
+* 名称:`INFORMATION_SCHEMA`
+* 指令:只读,只支持 `Show databases (DETAILS) ``/ Show Tables (DETAILS) /
Use`,其余操作将会报错:`"The database 'information_schema' can only be queried"`
+* 属性:`TTL=INF`,其余属性默认为`null`
+* SQL示例:
+
+```sql
+IoTDB> show databases
++------------------+-------+-----------------------+---------------------+---------------------+
+|
Database|TTL(ms)|SchemaReplicationFactor|DataReplicationFactor|TimePartitionInterval|
++------------------+-------+-----------------------+---------------------+---------------------+
+|information_schema| INF| null| null|
null|
++------------------+-------+-----------------------+---------------------+---------------------+
+
+IoTDB> show tables from information_schema
++-------------+-------+
+| TableName|TTL(ms)|
++-------------+-------+
+| databases| INF|
+| tables| INF|
+| pipe_plugins| INF|
+|subscriptions| INF|
+| regions| INF|
+| columns| INF|
+| topics| INF|
+| queries| INF|
+| pipes| INF|
++-------------+-------+
+```
+
+## 2. 系统表
+
+* 名称:`DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`,
`PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`(详细介绍见后面小节)
+* 操作:只读,只支持`SELECT`, `COUNT/SHOW DEVICES`, `DESC`,不支持对于表结构 /
内容的任意修改,如果修改将会报错:`"The database 'information_schema' can only be queried"`
+* 列名:系统表的列名均默认为小写,且用`_`分隔
+
+### 2.1 DATABASES 表
+
+* 包含集群中所有数据库的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ----------------------------- | ---------- | ----------- | ---------------- |
+| database | STRING | TAG | 数据库名称 |
+| ttl(ms) | STRING | ATTRIBUTE | 数据保留时间 |
+| schema\_replication\_factor | INT32 | ATTRIBUTE | 元数据副本数 |
+| data\_replication\_factor | INT32 | ATTRIBUTE | 数据副本数 |
+| time\_partition\_interval | INT64 | ATTRIBUTE | 时间分区间隔 |
+| schema\_region\_group\_num | INT32 | ATTRIBUTE | 元数据分区数量 |
+| data\_region\_group\_num | INT32 | ATTRIBUTE | 数据分区数量 |
+
+* 查询示例:
+
+```sql
+IoTDB> select * from information_schema.databases
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|
database|ttl(ms)|schema_replication_factor|data_replication_factor|time_partition_interval|schema_region_group_num|data_region_group_num|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|information_schema| INF| null| null|
null| null| null|
+| database1| INF| 1| 1|
604800000| 0| 0|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+```
+
+### 2.2 TABLES 表
+
+* 包含集群中所有表的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ------------- | ---------- | ----------- | -------------- |
+| database | STRING | TAG | 数据库名称 |
+| table\_name | STRING | TAG | 表名称 |
+| ttl(ms) | STRING | ATTRIBUTE | 数据保留时间 |
+| status | STRING | ATTRIBUTE | 状态 |
+| comment | STRING | ATTRIBUTE | 注释 |
+
+* 说明:status
可能为`USING`/`PRE_CREATE`/`PRE_DELETE`,具体见表管理中[查看表](../Basic-Concept/Table-Management.md#12-查看表)的相关描述
+* 查询示例:
+
+```sql
+IoTDB> select * from information_schema.tables
++------------------+-------------+-----------+------+-------+
+| database| table_name| ttl(ms)|status|comment|
++------------------+-------------+-----------+------+-------+
+|information_schema| databases| INF| USING| null|
+|information_schema| tables| INF| USING| null|
+|information_schema| pipe_plugins| INF| USING| null|
+|information_schema|subscriptions| INF| USING| null|
+|information_schema| regions| INF| USING| null|
+|information_schema| columns| INF| USING| null|
+|information_schema| topics| INF| USING| null|
+|information_schema| queries| INF| USING| null|
+|information_schema| pipes| INF| USING| null|
+| database1| table1|31536000000| USING| null|
++------------------+-------------+-----------+------+-------+
+```
+
+### 2.3 REGIONS 表
+
+* 包含集群中所有`Region`的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明
|
+| --------------------- | ----------- | ----------- |
-----------------------------------------------------------------------------------------------------------
|
+| region\_id | INT32 | TAG | region ID
|
+| datanode\_id | INT32 | TAG | dataNode ID
|
+| type | STRING | ATTRIBUTE | 类型(SchemaRegion / DataRegion)
|
+| status | STRING | ATTRIBUTE | 状态(Running/Unknown 等)
|
+| database | STRING | ATTRIBUTE | database 名字
|
+| series\_slot\_num | INT32 | ATTRIBUTE | series slot 个数
|
+| time\_slot\_num | INT64 | ATTRIBUTE | time slot 个数
|
+| rpc\_address | STRING | ATTRIBUTE | Rpc 地址
|
+| rpc\_port | INT32 | ATTRIBUTE | Rpc 端口
|
+| internal\_address | STRING | ATTRIBUTE | 内部通讯地址
|
+| role | STRING | ATTRIBUTE | Leader / Follower
|
+| create\_time | TIMESTAMP | ATTRIBUTE | 创建时间
|
+| tsfile\_size\_bytes | INT64 | ATTRIBUTE | 可统计的 DataRegion:含有 TsFile
的总文件大小;不可统计的 DataRegion(Unknown):-1;SchemaRegion:null; |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.regions
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+|region_id|datanode_id| type| status|
database|series_slot_num|time_slot_num|rpc_address|rpc_port|internal_address|
role| create_time|tsfile_size_bytes|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+| 0| 1|SchemaRegion|Running|database1| 12|
0| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:08.485+08:00| null|
+| 1| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3985|
+| 2| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3841|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+```
+
+### 2.4 QUERIES 表
+
+* 包含集群中所有正在执行的查询的信息。也可以使用 `SHOW QUERIES`语法去查询。
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| --------------- | ----------- | ----------- |
------------------------------------------------ |
+| query\_id | STRING | TAG | ID
|
+| start\_time | TIMESTAMP | ATTRIBUTE | 查询开始的时间戳,时间戳精度与系统精度保持一致 |
+| datanode\_id | INT32 | ATTRIBUTE | 发起查询的DataNode ID
|
+| elapsed\_time | FLOAT | ATTRIBUTE | 查询执行耗时,单位是秒 |
+| statement | STRING | ATTRIBUTE | 查询sql
|
+| user | STRING | ATTRIBUTE | 发起查询的用户
|
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.queries
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+| query_id|
start_time|datanode_id|elapsed_time|
statement|user|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1|
0.025|select * from information_schema.queries|root|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+```
+
+### 2.5 COLUMNS 表
+
+* 包含集群中所有表中列的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| -------------- | ---------- | ----------- | -------------- |
+| database | STRING | TAG | 数据库名称 |
+| table\_name | STRING | TAG | 表名称 |
+| column\_name | STRING | TAG | 列名称 |
+| datatype | STRING | ATTRIBUTE | 列的数值类型 |
+| category | STRING | ATTRIBUTE | 列类型 |
+| status | STRING | ATTRIBUTE | 列状态 |
+| comment | STRING | ATTRIBUTE | 列注释 |
+
+说明: status
可能为`USING`/`PRE_DELETE`,具体见表管理中[查看表的列](../Basic-Concept/Table-Management.html#13-查看表的列)的相关描述
+
+> 用户只能查出自己有展示权限的 table
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.columns where database = 'database1'
++---------+----------+------------+---------+---------+------+-------+
+| database|table_name| column_name| datatype| category|status|comment|
++---------+----------+------------+---------+---------+------+-------+
+|database1| table1| time|TIMESTAMP| TIME| USING| null|
+|database1| table1| region| STRING| TAG| USING| null|
+|database1| table1| plant_id| STRING| TAG| USING| null|
+|database1| table1| device_id| STRING| TAG| USING| null|
+|database1| table1| model_id| STRING|ATTRIBUTE| USING| null|
+|database1| table1| maintenance| STRING|ATTRIBUTE| USING| null|
+|database1| table1| temperature| FLOAT| FIELD| USING| null|
+|database1| table1| humidity| FLOAT| FIELD| USING| null|
+|database1| table1| status| BOOLEAN| FIELD| USING| null|
+|database1| table1|arrival_time|TIMESTAMP| FIELD| USING| null|
++---------+----------+------------+---------+---------+------+-------+
+```
+
+### 2.6 PIPES 表
+
+* 包含集群中所有 PIPE 的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明
|
+| ------------------------------- | ----------- | ----------- |
--------------------------------------- |
+| id | STRING | TAG | Pipe 名称
|
+| creation\_time | TIMESTAMP | ATTRIBUTE | 创建时间
|
+| state | STRING | ATTRIBUTE | Pipe
状态(RUNNING/STOPPED) |
+| pipe\_source | STRING | ATTRIBUTE | source 插件参数
|
+| pipe\_processor | STRING | ATTRIBUTE | processor 插件参数
|
+| pipe\_sink | STRING | ATTRIBUTE | source 插件参数
|
+| exception\_message | STRING | ATTRIBUTE | Exception 信息
|
+| remaining\_event\_count | INT64 | ATTRIBUTE | 剩余 event 数量,如果
Unknown 则为 -1 |
+| estimated\_remaining\_seconds | DOUBLE | ATTRIBUTE | 预估剩余时间,如果 Unknown 则为
-1 |
+
+* 查询示例:
+
+```SQL
+select * from information_schema.pipes
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+| id| creation_time| state|
pipe_source|pipe_processor|
pipe_sink|exception_message|remaining_event_count|estimated_remaining_seconds|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+|tablepipe1|2025-03-31T12:25:24.040+08:00|RUNNING|{__system.sql-dialect=table,
source.password=******, source.username=root}| {}|{format=hybrid,
node-urls=192.168.xxx.xxx:6667, sink=iotdb-thrift-sink}| |
0| 0.0|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+```
+
+### 2.7 PIPE\_PLUGINS 表
+
+* 包含集群中所有PIPE插件的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| -------------- | ---------- | ----------- |
----------------------------------------------- |
+| plugin\_name | STRING | TAG | 插件名称
|
+| plugin\_type | STRING | ATTRIBUTE | 插件类型(Builtin/External)
|
+| class\_name | STRING | ATTRIBUTE | 插件的主类名
|
+| plugin\_jar | STRING | ATTRIBUTE | 插件的 jar 包名称,若为 builtin 类型则为 null |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.pipe_plugins
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+| plugin_name|plugin_type|
class_name|plugin_jar|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+|IOTDB-THRIFT-SSL-SINK|
Builtin|org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftSslConnector|
null|
+| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.airgap.IoTDBAirGapConnector|
null|
+| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.donothing.DoNothingConnector|
null|
+| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.processor.donothing.DoNothingProcessor|
null|
+| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftConnector|
null|
+| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.extractor.iotdb.IoTDBExtractor|
null|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+```
+
+### 2.8 SUBSCRIPTIONS 表
+
+* 包含集群中所有数据订阅的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ----------------------- | ---------- | ----------- | -------------- |
+| topic\_name | STRING | TAG | 订阅主题名称 |
+| consumer\_group\_name | STRING | TAG | 消费者组名称 |
+| subscribed\_consumers | STRING | ATTRIBUTE | 订阅的消费者 |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.subscriptions where topic_name =
'topic_1'
++----------+-------------------+--------------------------------+
+|topic_name|consumer_group_name| subscribed_consumers|
++----------+-------------------+--------------------------------+
+| topic_1| cg1|[c3, c4, c5, c6, c7, c0, c1, c2]|
++----------+-------------------+--------------------------------+
+```
+
+### 2.9 TOPICS 表
+
+* 包含集群中所有数据订阅主题的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ---------------- | ---------- | ----------- | -------------- |
+| topic\_name | STRING | TAG | 订阅主题名称 |
+| topic\_configs | STRING | ATTRIBUTE | 订阅主题配置 |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.topics
++----------+----------------------------------------------------------------+
+|topic_name| topic_configs|
++----------+----------------------------------------------------------------+
+| topic|{__system.sql-dialect=table, start-time=2025-01-10T17:05:38.282}|
++----------+----------------------------------------------------------------+
+```
+
+## 3. 权限说明
+
+* 不支持通过`GRANT/REVOKE`语句对 `information_schema` 数据库及其下任何表进行权限操作
+* 支持任意用户通过`show databases`语句查看`information_schema`数据库相关信息
+* 支持任意用户通过`show tables from information_schema` 语句查看所有系统表相关信息
+* 支持任意用户通过`desc`语句查看任意系统表
+* 目前只支持 `root `用户通过`select`语句从系统表中查询数据,其他用户查询时展示空结果集
diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md
b/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md
index 2474f934..ef23b3cd 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md
@@ -262,6 +262,8 @@ IoTDB> SHOW CURRENT_TIMESTAMP
**含义**:用于显示所有正在执行的查询信息。
+> 更多系统表使用方法请参考[系统表](../Reference/System-Tables.md)
+
#### 语法:
```SQL
diff --git a/src/zh/UserGuide/latest-Table/Reference/System-Tables.md
b/src/zh/UserGuide/latest-Table/Reference/System-Tables.md
new file mode 100644
index 00000000..63d87127
--- /dev/null
+++ b/src/zh/UserGuide/latest-Table/Reference/System-Tables.md
@@ -0,0 +1,327 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# 系统表 (V2.0.2)
+
+IoTDB 内置系统数据库 `INFORMATION_SCHEMA`,其中包含一系列系统表,用于存储 IoTDB 运行时信息(如当前正在执行的 SQL
语句等)。目前`INFORMATION_SCHEMA`数据库只支持读操作。
+
+## 1. 系统库
+
+* 名称:`INFORMATION_SCHEMA`
+* 指令:只读,只支持 `Show databases (DETAILS) ``/ Show Tables (DETAILS) /
Use`,其余操作将会报错:`"The database 'information_schema' can only be queried"`
+* 属性:`TTL=INF`,其余属性默认为`null`
+* SQL示例:
+
+```sql
+IoTDB> show databases
++------------------+-------+-----------------------+---------------------+---------------------+
+|
Database|TTL(ms)|SchemaReplicationFactor|DataReplicationFactor|TimePartitionInterval|
++------------------+-------+-----------------------+---------------------+---------------------+
+|information_schema| INF| null| null|
null|
++------------------+-------+-----------------------+---------------------+---------------------+
+
+IoTDB> show tables from information_schema
++-------------+-------+
+| TableName|TTL(ms)|
++-------------+-------+
+| databases| INF|
+| tables| INF|
+| pipe_plugins| INF|
+|subscriptions| INF|
+| regions| INF|
+| columns| INF|
+| topics| INF|
+| queries| INF|
+| pipes| INF|
++-------------+-------+
+```
+
+## 2. 系统表
+
+* 名称:`DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`,
`PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`(详细介绍见后面小节)
+* 操作:只读,只支持`SELECT`, `COUNT/SHOW DEVICES`, `DESC`,不支持对于表结构 /
内容的任意修改,如果修改将会报错:`"The database 'information_schema' can only be queried"`
+* 列名:系统表的列名均默认为小写,且用`_`分隔
+
+### 2.1 DATABASES 表
+
+* 包含集群中所有数据库的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ----------------------------- | ---------- | ----------- | ---------------- |
+| database | STRING | TAG | 数据库名称 |
+| ttl(ms) | STRING | ATTRIBUTE | 数据保留时间 |
+| schema\_replication\_factor | INT32 | ATTRIBUTE | 元数据副本数 |
+| data\_replication\_factor | INT32 | ATTRIBUTE | 数据副本数 |
+| time\_partition\_interval | INT64 | ATTRIBUTE | 时间分区间隔 |
+| schema\_region\_group\_num | INT32 | ATTRIBUTE | 元数据分区数量 |
+| data\_region\_group\_num | INT32 | ATTRIBUTE | 数据分区数量 |
+
+* 查询示例:
+
+```sql
+IoTDB> select * from information_schema.databases
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|
database|ttl(ms)|schema_replication_factor|data_replication_factor|time_partition_interval|schema_region_group_num|data_region_group_num|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+|information_schema| INF| null| null|
null| null| null|
+| database1| INF| 1| 1|
604800000| 0| 0|
++------------------+-------+-------------------------+-----------------------+-----------------------+-----------------------+---------------------+
+```
+
+### 2.2 TABLES 表
+
+* 包含集群中所有表的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ------------- | ---------- | ----------- | -------------- |
+| database | STRING | TAG | 数据库名称 |
+| table\_name | STRING | TAG | 表名称 |
+| ttl(ms) | STRING | ATTRIBUTE | 数据保留时间 |
+| status | STRING | ATTRIBUTE | 状态 |
+| comment | STRING | ATTRIBUTE | 注释 |
+
+* 说明:status
可能为`USING`/`PRE_CREATE`/`PRE_DELETE`,具体见表管理中[查看表](../Basic-Concept/Table-Management.md#12-查看表)的相关描述
+* 查询示例:
+
+```sql
+IoTDB> select * from information_schema.tables
++------------------+-------------+-----------+------+-------+
+| database| table_name| ttl(ms)|status|comment|
++------------------+-------------+-----------+------+-------+
+|information_schema| databases| INF| USING| null|
+|information_schema| tables| INF| USING| null|
+|information_schema| pipe_plugins| INF| USING| null|
+|information_schema|subscriptions| INF| USING| null|
+|information_schema| regions| INF| USING| null|
+|information_schema| columns| INF| USING| null|
+|information_schema| topics| INF| USING| null|
+|information_schema| queries| INF| USING| null|
+|information_schema| pipes| INF| USING| null|
+| database1| table1|31536000000| USING| null|
++------------------+-------------+-----------+------+-------+
+```
+
+### 2.3 REGIONS 表
+
+* 包含集群中所有`Region`的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明
|
+| --------------------- | ----------- | ----------- |
-----------------------------------------------------------------------------------------------------------
|
+| region\_id | INT32 | TAG | region ID
|
+| datanode\_id | INT32 | TAG | dataNode ID
|
+| type | STRING | ATTRIBUTE | 类型(SchemaRegion / DataRegion)
|
+| status | STRING | ATTRIBUTE | 状态(Running/Unknown 等)
|
+| database | STRING | ATTRIBUTE | database 名字
|
+| series\_slot\_num | INT32 | ATTRIBUTE | series slot 个数
|
+| time\_slot\_num | INT64 | ATTRIBUTE | time slot 个数
|
+| rpc\_address | STRING | ATTRIBUTE | Rpc 地址
|
+| rpc\_port | INT32 | ATTRIBUTE | Rpc 端口
|
+| internal\_address | STRING | ATTRIBUTE | 内部通讯地址
|
+| role | STRING | ATTRIBUTE | Leader / Follower
|
+| create\_time | TIMESTAMP | ATTRIBUTE | 创建时间
|
+| tsfile\_size\_bytes | INT64 | ATTRIBUTE | 可统计的 DataRegion:含有 TsFile
的总文件大小;不可统计的 DataRegion(Unknown):-1;SchemaRegion:null; |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.regions
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+|region_id|datanode_id| type| status|
database|series_slot_num|time_slot_num|rpc_address|rpc_port|internal_address|
role| create_time|tsfile_size_bytes|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+| 0| 1|SchemaRegion|Running|database1| 12|
0| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:08.485+08:00| null|
+| 1| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3985|
+| 2| 1| DataRegion|Running|database1| 6|
6| 0.0.0.0| 6667|
127.0.0.1|Leader|2025-03-31T11:19:09.156+08:00| 3841|
++---------+-----------+------------+-------+---------+---------------+-------------+-----------+--------+----------------+------+-----------------------------+-----------------+
+```
+
+### 2.4 QUERIES 表
+
+* 包含集群中所有正在执行的查询的信息。也可以使用 `SHOW QUERIES`语法去查询。
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| --------------- | ----------- | ----------- |
------------------------------------------------ |
+| query\_id | STRING | TAG | ID
|
+| start\_time | TIMESTAMP | ATTRIBUTE | 查询开始的时间戳,时间戳精度与系统精度保持一致 |
+| datanode\_id | INT32 | ATTRIBUTE | 发起查询的DataNode ID
|
+| elapsed\_time | FLOAT | ATTRIBUTE | 查询执行耗时,单位是秒 |
+| statement | STRING | ATTRIBUTE | 查询sql
|
+| user | STRING | ATTRIBUTE | 发起查询的用户
|
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.queries
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+| query_id|
start_time|datanode_id|elapsed_time|
statement|user|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+|20250331_023242_00011_1|2025-03-31T10:32:42.360+08:00| 1|
0.025|select * from information_schema.queries|root|
++-----------------------+-----------------------------+-----------+------------+----------------------------------------+----+
+```
+
+### 2.5 COLUMNS 表
+
+* 包含集群中所有表中列的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| -------------- | ---------- | ----------- | -------------- |
+| database | STRING | TAG | 数据库名称 |
+| table\_name | STRING | TAG | 表名称 |
+| column\_name | STRING | TAG | 列名称 |
+| datatype | STRING | ATTRIBUTE | 列的数值类型 |
+| category | STRING | ATTRIBUTE | 列类型 |
+| status | STRING | ATTRIBUTE | 列状态 |
+| comment | STRING | ATTRIBUTE | 列注释 |
+
+说明: status
可能为`USING`/`PRE_DELETE`,具体见表管理中[查看表的列](../Basic-Concept/Table-Management.html#13-查看表的列)的相关描述
+
+> 用户只能查出自己有展示权限的 table
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.columns where database = 'database1'
++---------+----------+------------+---------+---------+------+-------+
+| database|table_name| column_name| datatype| category|status|comment|
++---------+----------+------------+---------+---------+------+-------+
+|database1| table1| time|TIMESTAMP| TIME| USING| null|
+|database1| table1| region| STRING| TAG| USING| null|
+|database1| table1| plant_id| STRING| TAG| USING| null|
+|database1| table1| device_id| STRING| TAG| USING| null|
+|database1| table1| model_id| STRING|ATTRIBUTE| USING| null|
+|database1| table1| maintenance| STRING|ATTRIBUTE| USING| null|
+|database1| table1| temperature| FLOAT| FIELD| USING| null|
+|database1| table1| humidity| FLOAT| FIELD| USING| null|
+|database1| table1| status| BOOLEAN| FIELD| USING| null|
+|database1| table1|arrival_time|TIMESTAMP| FIELD| USING| null|
++---------+----------+------------+---------+---------+------+-------+
+```
+
+### 2.6 PIPES 表
+
+* 包含集群中所有 PIPE 的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明
|
+| ------------------------------- | ----------- | ----------- |
--------------------------------------- |
+| id | STRING | TAG | Pipe 名称
|
+| creation\_time | TIMESTAMP | ATTRIBUTE | 创建时间
|
+| state | STRING | ATTRIBUTE | Pipe
状态(RUNNING/STOPPED) |
+| pipe\_source | STRING | ATTRIBUTE | source 插件参数
|
+| pipe\_processor | STRING | ATTRIBUTE | processor 插件参数
|
+| pipe\_sink | STRING | ATTRIBUTE | source 插件参数
|
+| exception\_message | STRING | ATTRIBUTE | Exception 信息
|
+| remaining\_event\_count | INT64 | ATTRIBUTE | 剩余 event 数量,如果
Unknown 则为 -1 |
+| estimated\_remaining\_seconds | DOUBLE | ATTRIBUTE | 预估剩余时间,如果 Unknown 则为
-1 |
+
+* 查询示例:
+
+```SQL
+select * from information_schema.pipes
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+| id| creation_time| state|
pipe_source|pipe_processor|
pipe_sink|exception_message|remaining_event_count|estimated_remaining_seconds|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+|tablepipe1|2025-03-31T12:25:24.040+08:00|RUNNING|{__system.sql-dialect=table,
source.password=******, source.username=root}| {}|{format=hybrid,
node-urls=192.168.xxx.xxx:6667, sink=iotdb-thrift-sink}| |
0| 0.0|
++----------+-----------------------------+-------+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------+-----------------+---------------------+---------------------------+
+```
+
+### 2.7 PIPE\_PLUGINS 表
+
+* 包含集群中所有PIPE插件的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| -------------- | ---------- | ----------- |
----------------------------------------------- |
+| plugin\_name | STRING | TAG | 插件名称
|
+| plugin\_type | STRING | ATTRIBUTE | 插件类型(Builtin/External)
|
+| class\_name | STRING | ATTRIBUTE | 插件的主类名
|
+| plugin\_jar | STRING | ATTRIBUTE | 插件的 jar 包名称,若为 builtin 类型则为 null |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.pipe_plugins
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+| plugin_name|plugin_type|
class_name|plugin_jar|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+|IOTDB-THRIFT-SSL-SINK|
Builtin|org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftSslConnector|
null|
+| IOTDB-AIR-GAP-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.airgap.IoTDBAirGapConnector|
null|
+| DO-NOTHING-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.donothing.DoNothingConnector|
null|
+| DO-NOTHING-PROCESSOR| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.processor.donothing.DoNothingProcessor|
null|
+| IOTDB-THRIFT-SINK| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.connector.iotdb.thrift.IoTDBThriftConnector|
null|
+| IOTDB-SOURCE| Builtin|
org.apache.iotdb.commons.pipe.agent.plugin.builtin.extractor.iotdb.IoTDBExtractor|
null|
++---------------------+-----------+-------------------------------------------------------------------------------------------------+----------+
+```
+
+### 2.8 SUBSCRIPTIONS 表
+
+* 包含集群中所有数据订阅的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ----------------------- | ---------- | ----------- | -------------- |
+| topic\_name | STRING | TAG | 订阅主题名称 |
+| consumer\_group\_name | STRING | TAG | 消费者组名称 |
+| subscribed\_consumers | STRING | ATTRIBUTE | 订阅的消费者 |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.subscriptions where topic_name =
'topic_1'
++----------+-------------------+--------------------------------+
+|topic_name|consumer_group_name| subscribed_consumers|
++----------+-------------------+--------------------------------+
+| topic_1| cg1|[c3, c4, c5, c6, c7, c0, c1, c2]|
++----------+-------------------+--------------------------------+
+```
+
+### 2.9 TOPICS 表
+
+* 包含集群中所有数据订阅主题的信息
+* 表结构如下表所示:
+
+| 列名 | 数据类型 | 列类型 | 说明 |
+| ---------------- | ---------- | ----------- | -------------- |
+| topic\_name | STRING | TAG | 订阅主题名称 |
+| topic\_configs | STRING | ATTRIBUTE | 订阅主题配置 |
+
+* 查询示例:
+
+```SQL
+IoTDB> select * from information_schema.topics
++----------+----------------------------------------------------------------+
+|topic_name| topic_configs|
++----------+----------------------------------------------------------------+
+| topic|{__system.sql-dialect=table, start-time=2025-01-10T17:05:38.282}|
++----------+----------------------------------------------------------------+
+```
+
+## 3. 权限说明
+
+* 不支持通过`GRANT/REVOKE`语句对 `information_schema` 数据库及其下任何表进行权限操作
+* 支持任意用户通过`show databases`语句查看`information_schema`数据库相关信息
+* 支持任意用户通过`show tables from information_schema` 语句查看所有系统表相关信息
+* 支持任意用户通过`desc`语句查看任意系统表
+* 目前只支持 `root `用户通过`select`语句从系统表中查询数据,其他用户查询时展示空结果集
diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md
b/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md
index 2474f934..ef23b3cd 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md
@@ -262,6 +262,8 @@ IoTDB> SHOW CURRENT_TIMESTAMP
**含义**:用于显示所有正在执行的查询信息。
+> 更多系统表使用方法请参考[系统表](../Reference/System-Tables.md)
+
#### 语法:
```SQL