From 7b3cc52b73bc255aa9d76627e4c023ff13148a90 Mon Sep 17 00:00:00 2001 From: leto-bbq Date: Thu, 5 Nov 2026 11:54:53 +0800 Subject: [PATCH] docs: document SHOW CREATE DATABASE and PIPE for V2.0.12 --- .../Database-Management_apache.md | 48 +++++++++++++++++-- .../Table/User-Manual/Data-Sync_apache.md | 47 +++++++++++++++++- .../Tree/User-Manual/Data-Sync_apache.md | 2 + .../Database-Management_apache.md | 48 +++++++++++++++++-- .../User-Manual/Data-Sync_apache.md | 47 +++++++++++++++++- .../latest/User-Manual/Data-Sync_apache.md | 2 + .../Database-Management_apache.md | 48 +++++++++++++++++-- .../Table/User-Manual/Data-Sync_apache.md | 47 +++++++++++++++++- .../Tree/User-Manual/Data-Sync_apache.md | 2 + .../Database-Management_apache.md | 48 +++++++++++++++++-- .../User-Manual/Data-Sync_apache.md | 47 +++++++++++++++++- .../latest/User-Manual/Data-Sync_apache.md | 2 + 12 files changed, 368 insertions(+), 20 deletions(-) diff --git a/src/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md b/src/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md index 84bd43950..550629c4a 100644 --- a/src/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md +++ b/src/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md @@ -166,7 +166,49 @@ SHOW DATABASES DETAILS; +------------------+-------+-----------------------+---------------------+---------------------+--------------------+-----------------------+------------------+---------------------+ ``` -### 2.5 Count Databases +### 2.5 View Database Creation Information + +Use this statement to obtain the `CREATE DATABASE` statement for a specified table-model database. This feature is supported since V2.0.12. + +**Syntax:** + +```SQL +SHOW CREATE DATABASE ; +``` + +**Result:** + +| **Column Name** | **Type** | **Description** | +| :---------------- | :------- | :----------------------------------------------------------------------------- | +| Database | TEXT | Database name. | +| Create Database | TEXT | A `CREATE DATABASE` statement that can be used to recreate the database. | + +**Notes:** + +1. The system database `information_schema` is not supported. Permission checks are the same as those for viewing or using a database. +2. The database name in the returned statement is always enclosed in double quotation marks. +3. When TTL is infinite, the output is `INF`; when TTL is finite, the numeric value is output. `time_partition_interval`, `max_schema_region_group_num`, and `max_data_region_group_num` use their effective values. +4. If the database does not exist, the statement returns an `Unknown database ` error. + +**Example:** + +View the creation information for the existing database `database1`: + +```SQL +SHOW CREATE DATABASE database1; +``` + +Result: + +```SQL ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| Database| Create Database| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +|database1|CREATE DATABASE "database1" WITH (ttl=31536000000,time_partition_interval=604800000,max_schema_region_group_num=1,max_data_region_group_num=7)| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.6 Count Databases Counts the total number of databases. This syntax is supported starting from V2.0.11. @@ -187,7 +229,7 @@ TimechoDB> COUNT DATABASES +-----+ ``` -### 2.6 Update a Database +### 2.7 Update a Database Modifies supported database properties. @@ -208,7 +250,7 @@ ALTER DATABASE database1 SET PROPERTIES TTL=31536000000; ALTER DATABASE database1 SET PROPERTIES MAX_SCHEMA_REGION_GROUP_NUM=2, MAX_DATA_REGION_GROUP_NUM=4; ``` -### 2.7 Delete a Database +### 2.8 Delete a Database Deletes a database. diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md index b05adcd81..bd52f4df5 100644 --- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md @@ -232,7 +232,50 @@ IoTDB> show pipe alldatapipe_realtime ``` -### 2.6 Modify a Task +### 2.6 View Task Creation Information + +Use this statement to obtain the creation statement for a specified synchronization task. This feature is supported since V2.0.12. + +**Syntax:** + +```SQL +SHOW CREATE PIPE ; +``` + +**Result:** + +| **Column Name** | **Type** | **Description** | +| :-------------- | :------- | :----------------------------------------------------------------------------- | +| Pipe | TEXT | Synchronization task name. | +| Create Pipe | TEXT | A `CREATE PIPE` statement that can be used to recreate the static task definition. | + +**Notes:** + +1. Only Pipes visible to the table model are returned. If the task does not exist or is not visible to the current user, a task-not-found or permission-related error is returned. +2. The Pipe name is always enclosed in double quotation marks. Property names and values are output as string literals, with single quotation marks escaped; properties are sorted stably by property name. +3. If `WITH SOURCE`, `WITH PROCESSOR`, or `WITH SINK` has no user-visible properties, the corresponding clause is omitted. +4. Properties with the `__system` or `__audit` prefix and system-injected authentication context are omitted. User-configured authentication properties required to recreate connection semantics are retained. +5. Only the static task definition is returned; runtime state, historical errors, remaining event count, and transmission progress are not included. + +**Example:** + +View the creation information for the existing task `table1_pipe_realtime`: + +```SQL +SHOW CREATE PIPE table1_pipe_realtime; +``` + +Result: + +```text ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pipe| Create Pipe| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|table1_pipe_realtime|CREATE PIPE "table1_pipe_realtime" WITH SOURCE ('database-name'='database1','end-time'='2024-11-28T11:00:00+08:00','history.enable'='false','mode.strict'='true','realtime.enable'='true','start-time'='2024-11-28T08:00:00+08:00','table-name'='table1') WITH SINK ('sink'='do-nothing-sink')| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.7 Modify a Task The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink. @@ -257,7 +300,7 @@ Example: ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668'); ``` -### 2.7 Synchronization Plugins +### 2.8 Synchronization Plugins To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system. diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md index 06bcfaea6..1aa47117a 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md @@ -81,6 +81,8 @@ By declaratively configuring the specific content of the three parts through SQL 1. The schema and auth synchronization functions have the following limitations: +- Since V2.0.12, the time series name at the sender can be modified after synchronization is established, and the synchronization link continues to run normally after the modification. + - When using schema synchronization, it is required that the consensus protocol for `Schema region` and `ConfigNode` must be the default ratis protocol. This means that the `iotdb-system.properties` configuration file should contain the settings `config_node_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus` and `schema_region_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`. If these are not specified, the default ratis protocol is used. - To prevent potential conflicts, please disable the automatic creation of schema on the receiving end when enabling schema synchronization. This can be done by setting the `enable_auto_create_schema` configuration in the `iotdb-system.properties` file to false. diff --git a/src/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md b/src/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md index 84bd43950..550629c4a 100644 --- a/src/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md +++ b/src/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md @@ -166,7 +166,49 @@ SHOW DATABASES DETAILS; +------------------+-------+-----------------------+---------------------+---------------------+--------------------+-----------------------+------------------+---------------------+ ``` -### 2.5 Count Databases +### 2.5 View Database Creation Information + +Use this statement to obtain the `CREATE DATABASE` statement for a specified table-model database. This feature is supported since V2.0.12. + +**Syntax:** + +```SQL +SHOW CREATE DATABASE ; +``` + +**Result:** + +| **Column Name** | **Type** | **Description** | +| :---------------- | :------- | :----------------------------------------------------------------------------- | +| Database | TEXT | Database name. | +| Create Database | TEXT | A `CREATE DATABASE` statement that can be used to recreate the database. | + +**Notes:** + +1. The system database `information_schema` is not supported. Permission checks are the same as those for viewing or using a database. +2. The database name in the returned statement is always enclosed in double quotation marks. +3. When TTL is infinite, the output is `INF`; when TTL is finite, the numeric value is output. `time_partition_interval`, `max_schema_region_group_num`, and `max_data_region_group_num` use their effective values. +4. If the database does not exist, the statement returns an `Unknown database ` error. + +**Example:** + +View the creation information for the existing database `database1`: + +```SQL +SHOW CREATE DATABASE database1; +``` + +Result: + +```SQL ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| Database| Create Database| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +|database1|CREATE DATABASE "database1" WITH (ttl=31536000000,time_partition_interval=604800000,max_schema_region_group_num=1,max_data_region_group_num=7)| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.6 Count Databases Counts the total number of databases. This syntax is supported starting from V2.0.11. @@ -187,7 +229,7 @@ TimechoDB> COUNT DATABASES +-----+ ``` -### 2.6 Update a Database +### 2.7 Update a Database Modifies supported database properties. @@ -208,7 +250,7 @@ ALTER DATABASE database1 SET PROPERTIES TTL=31536000000; ALTER DATABASE database1 SET PROPERTIES MAX_SCHEMA_REGION_GROUP_NUM=2, MAX_DATA_REGION_GROUP_NUM=4; ``` -### 2.7 Delete a Database +### 2.8 Delete a Database Deletes a database. diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md index 2650b2779..14e7d4c91 100644 --- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md @@ -232,7 +232,50 @@ IoTDB> show pipe alldatapipe_realtime ``` -### 2.6 Modify a Task +### 2.6 View Task Creation Information + +Use this statement to obtain the creation statement for a specified synchronization task. This feature is supported since V2.0.12. + +**Syntax:** + +```SQL +SHOW CREATE PIPE ; +``` + +**Result:** + +| **Column Name** | **Type** | **Description** | +| :-------------- | :------- | :----------------------------------------------------------------------------- | +| Pipe | TEXT | Synchronization task name. | +| Create Pipe | TEXT | A `CREATE PIPE` statement that can be used to recreate the static task definition. | + +**Notes:** + +1. Only Pipes visible to the table model are returned. If the task does not exist or is not visible to the current user, a task-not-found or permission-related error is returned. +2. The Pipe name is always enclosed in double quotation marks. Property names and values are output as string literals, with single quotation marks escaped; properties are sorted stably by property name. +3. If `WITH SOURCE`, `WITH PROCESSOR`, or `WITH SINK` has no user-visible properties, the corresponding clause is omitted. +4. Properties with the `__system` or `__audit` prefix and system-injected authentication context are omitted. User-configured authentication properties required to recreate connection semantics are retained. +5. Only the static task definition is returned; runtime state, historical errors, remaining event count, and transmission progress are not included. + +**Example:** + +View the creation information for the existing task `table1_pipe_realtime`: + +```SQL +SHOW CREATE PIPE table1_pipe_realtime; +``` + +Result: + +```text ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pipe| Create Pipe| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|table1_pipe_realtime|CREATE PIPE "table1_pipe_realtime" WITH SOURCE ('database-name'='database1','end-time'='2024-11-28T11:00:00+08:00','history.enable'='false','mode.strict'='true','realtime.enable'='true','start-time'='2024-11-28T08:00:00+08:00','table-name'='table1') WITH SINK ('sink'='do-nothing-sink')| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.7 Modify a Task The `ALTER PIPE` statement dynamically updates an existing PIPE and supports modifying or replacing the configuration of source, processor, and sink. @@ -257,7 +300,7 @@ Example: ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668'); ``` -### 2.7 Synchronization Plugins +### 2.8 Synchronization Plugins To make the architecture more flexible and adaptable to different synchronization scenarios, IoTDB supports plugin assembly in the synchronization task framework. The system provides some common pre-installed plugins, and you can also customize `processor` and `sink` plugins and load them into the IoTDB system. diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md index 06bcfaea6..1aa47117a 100644 --- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md @@ -81,6 +81,8 @@ By declaratively configuring the specific content of the three parts through SQL 1. The schema and auth synchronization functions have the following limitations: +- Since V2.0.12, the time series name at the sender can be modified after synchronization is established, and the synchronization link continues to run normally after the modification. + - When using schema synchronization, it is required that the consensus protocol for `Schema region` and `ConfigNode` must be the default ratis protocol. This means that the `iotdb-system.properties` configuration file should contain the settings `config_node_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus` and `schema_region_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`. If these are not specified, the default ratis protocol is used. - To prevent potential conflicts, please disable the automatic creation of schema on the receiving end when enabling schema synchronization. This can be done by setting the `enable_auto_create_schema` configuration in the `iotdb-system.properties` file to false. diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md index 7f3109620..e8e65c155 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management_apache.md @@ -167,7 +167,49 @@ SHOW DATABASES DETAILS; +------------------+-------+-----------------------+---------------------+---------------------+--------------------+-----------------------+------------------+---------------------+ ``` -### 2.5 统计数据库数量 +### 2.5 查看数据库的创建信息 + +用于获取指定表模型数据库的创建语句，自 V2.0.12 版本起支持该功能。 + +**语法：** + +```SQL +SHOW CREATE DATABASE ; +``` + +**返回结果：** + +| **列名** | **类型** | **含义** | +| :---------------- | :------- | :-------------------------------- | +| Database | TEXT | 数据库名称。 | +| Create Database | TEXT | 可用于重建数据库定义的 `CREATE DATABASE` 语句。 | + +**说明：** + +1. 不支持系统数据库 `information_schema`。权限检查与查看或使用数据库一致。 +2. 返回语句中的数据库名称统一使用双引号。 +3. TTL 为无限 TTL 时输出 `INF`，有限 TTL 输出数值；`time_partition_interval`、`max_schema_region_group_num` 和 `max_data_region_group_num` 输出实际生效值。 +4. 数据库不存在时，返回 `Unknown database ` 错误。 + +**示例：** + +查看已存在数据库 `database1` 的创建信息： + +```SQL +SHOW CREATE DATABASE database1; +``` + +结果： + +```SQL ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| Database| Create Database| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +|database1|CREATE DATABASE "database1" WITH (ttl=31536000000,time_partition_interval=604800000,max_schema_region_group_num=1,max_data_region_group_num=7)| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.6 统计数据库数量 用于统计数据库的总数。该语法自 V2.0.11 版本起支持。 @@ -188,7 +230,7 @@ TimechoDB> COUNT DATABASES +-----+ ``` -### 2.6 修改数据库 +### 2.7 修改数据库 用于修改数据库中的部分属性。 @@ -209,7 +251,7 @@ ALTER DATABASE database1 SET PROPERTIES TTL=31536000000; ALTER DATABASE database1 SET PROPERTIES MAX_SCHEMA_REGION_GROUP_NUM=2, MAX_DATA_REGION_GROUP_NUM=4; ``` -### 2.7 删除数据库 +### 2.8 删除数据库 用于删除数据库。 diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md index 262ef66f7..60b8c1725 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md @@ -231,7 +231,50 @@ IoTDB> show pipe alldatapipe_realtime ``` -### 2.6 修改任务 +### 2.6 查看任务的创建信息 + +用于获取指定同步任务的创建语句，自 V2.0.12 版本起支持该功能。 + +**语法：** + +```SQL +SHOW CREATE PIPE ; +``` + +**返回结果：** + +| **列名** | **类型** | **含义** | +| :------------ | :------- | :------------------------------- | +| Pipe | TEXT | 同步任务名称。 | +| Create Pipe | TEXT | 可用于重建任务静态定义的 `CREATE PIPE` 语句。 | + +**说明：** + +1. 仅返回表模型可见的 Pipe。任务不存在或当前用户不可见时，返回任务不存在或权限相关错误。 +2. Pipe 名称统一使用双引号；属性名和值以字符串字面量输出，并进行单引号转义，属性按属性名稳定排序。 +3. `WITH SOURCE`、`WITH PROCESSOR`、`WITH SINK` 中没有用户可见属性时，省略对应子句。 +4. 不输出 `__system`、`__audit` 前缀属性及系统自动注入的认证上下文；用户显式配置、用于重建连接语义的认证属性会保留。 +5. 仅返回任务静态定义，不包含运行状态、历史错误、剩余 event 数、传输进度等运行信息。 + +**示例：** + +查看已存在任务 `table1_pipe_realtime` 的创建信息： + +```SQL +SHOW CREATE PIPE table1_pipe_realtime; +``` + +返回结果如下： + +```text ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pipe| Create Pipe| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|table1_pipe_realtime|CREATE PIPE "table1_pipe_realtime" WITH SOURCE ('database-name'='database1','end-time'='2024-11-28T11:00:00+08:00','history.enable'='false','mode.strict'='true','realtime.enable'='true','start-time'='2024-11-28T08:00:00+08:00','table-name'='table1') WITH SINK ('sink'='do-nothing-sink')| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.7 修改任务 `ALTER PIPE` 语句用于动态更新已存在的 PIPE，支持修改或替换 source、processor 及 sink 的配置。 @@ -256,7 +299,7 @@ ALTER PIPE [IF EXISTS] ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668'); ``` -### 2.7 同步插件 +### 2.8 同步插件 为了使得整体架构更加灵活以匹配不同的同步场景需求，我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用，同时您也可以自定义 processor 插件 和 Sink 插件，并加载至 IoTDB 系统进行使用。查看系统中的插件（含自定义与内置插件）可以用以下语句： diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md index 0da6bb54c..7cf558095 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md @@ -80,6 +80,8 @@ 1. 元数据（schema）、权限（auth）同步功能存在如下限制： +- 自 V2.0.12 起，支持在同步建立后修改发送端的序列名，且修改后同步链路仍可正常运行。 + - 使用元数据同步时，要求`Schema region`、`ConfigNode` 的共识协议必须为默认的 ratis 协议，即`iotdb-system.properties`配置文件中是否包含`config_node_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`、`schema_region_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`，不包含即为默认值ratis 协议。 - 为了防止潜在的冲突，请在开启元数据同步时关闭接收端自动创建元数据功能。可通过修改 `iotdb-system.properties`配置文件中的`enable_auto_create_schema`配置项为 false，关闭元数据自动创建功能。 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md index 7f3109620..e8e65c155 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management_apache.md @@ -167,7 +167,49 @@ SHOW DATABASES DETAILS; +------------------+-------+-----------------------+---------------------+---------------------+--------------------+-----------------------+------------------+---------------------+ ``` -### 2.5 统计数据库数量 +### 2.5 查看数据库的创建信息 + +用于获取指定表模型数据库的创建语句，自 V2.0.12 版本起支持该功能。 + +**语法：** + +```SQL +SHOW CREATE DATABASE ; +``` + +**返回结果：** + +| **列名** | **类型** | **含义** | +| :---------------- | :------- | :-------------------------------- | +| Database | TEXT | 数据库名称。 | +| Create Database | TEXT | 可用于重建数据库定义的 `CREATE DATABASE` 语句。 | + +**说明：** + +1. 不支持系统数据库 `information_schema`。权限检查与查看或使用数据库一致。 +2. 返回语句中的数据库名称统一使用双引号。 +3. TTL 为无限 TTL 时输出 `INF`，有限 TTL 输出数值；`time_partition_interval`、`max_schema_region_group_num` 和 `max_data_region_group_num` 输出实际生效值。 +4. 数据库不存在时，返回 `Unknown database ` 错误。 + +**示例：** + +查看已存在数据库 `database1` 的创建信息： + +```SQL +SHOW CREATE DATABASE database1; +``` + +结果： + +```SQL ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| Database| Create Database| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +|database1|CREATE DATABASE "database1" WITH (ttl=31536000000,time_partition_interval=604800000,max_schema_region_group_num=1,max_data_region_group_num=7)| ++---------+----------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.6 统计数据库数量 用于统计数据库的总数。该语法自 V2.0.11 版本起支持。 @@ -188,7 +230,7 @@ TimechoDB> COUNT DATABASES +-----+ ``` -### 2.6 修改数据库 +### 2.7 修改数据库 用于修改数据库中的部分属性。 @@ -209,7 +251,7 @@ ALTER DATABASE database1 SET PROPERTIES TTL=31536000000; ALTER DATABASE database1 SET PROPERTIES MAX_SCHEMA_REGION_GROUP_NUM=2, MAX_DATA_REGION_GROUP_NUM=4; ``` -### 2.7 删除数据库 +### 2.8 删除数据库 用于删除数据库。 diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md index 1fa296f7d..ec523dd8b 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md @@ -231,7 +231,50 @@ IoTDB> show pipe alldatapipe_realtime ``` -### 2.6 修改任务 +### 2.6 查看任务的创建信息 + +用于获取指定同步任务的创建语句，自 V2.0.12 版本起支持该功能。 + +**语法：** + +```SQL +SHOW CREATE PIPE ; +``` + +**返回结果：** + +| **列名** | **类型** | **含义** | +| :------------ | :------- | :------------------------------- | +| Pipe | TEXT | 同步任务名称。 | +| Create Pipe | TEXT | 可用于重建任务静态定义的 `CREATE PIPE` 语句。 | + +**说明：** + +1. 仅返回表模型可见的 Pipe。任务不存在或当前用户不可见时，返回任务不存在或权限相关错误。 +2. Pipe 名称统一使用双引号；属性名和值以字符串字面量输出，并进行单引号转义，属性按属性名稳定排序。 +3. `WITH SOURCE`、`WITH PROCESSOR`、`WITH SINK` 中没有用户可见属性时，省略对应子句。 +4. 不输出 `__system`、`__audit` 前缀属性及系统自动注入的认证上下文；用户显式配置、用于重建连接语义的认证属性会保留。 +5. 仅返回任务静态定义，不包含运行状态、历史错误、剩余 event 数、传输进度等运行信息。 + +**示例：** + +查看已存在任务 `table1_pipe_realtime` 的创建信息： + +```SQL +SHOW CREATE PIPE table1_pipe_realtime; +``` + +返回结果如下： + +```text ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pipe| Create Pipe| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|table1_pipe_realtime|CREATE PIPE "table1_pipe_realtime" WITH SOURCE ('database-name'='database1','end-time'='2024-11-28T11:00:00+08:00','history.enable'='false','mode.strict'='true','realtime.enable'='true','start-time'='2024-11-28T08:00:00+08:00','table-name'='table1') WITH SINK ('sink'='do-nothing-sink')| ++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +``` + +### 2.7 修改任务 `ALTER PIPE` 语句用于动态更新已存在的 PIPE，支持修改或替换 source、processor 及 sink 的配置。 @@ -256,7 +299,7 @@ ALTER PIPE [IF EXISTS] ALTER PIPE A2B REPLACE SINK ('sink'='iotdb-thrift-sink', 'node-urls' = '127.0.0.1:6668'); ``` -### 2.7 同步插件 +### 2.8 同步插件 为了使得整体架构更加灵活以匹配不同的同步场景需求，我们支持在同步任务框架中进行插件组装。系统为您预置了一些常用插件可直接使用，同时您也可以自定义 processor 插件 和 Sink 插件，并加载至 IoTDB 系统进行使用。查看系统中的插件（含自定义与内置插件）可以用以下语句： diff --git a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md index 0da6bb54c..7cf558095 100644 --- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md @@ -80,6 +80,8 @@ 1. 元数据（schema）、权限（auth）同步功能存在如下限制： +- 自 V2.0.12 起，支持在同步建立后修改发送端的序列名，且修改后同步链路仍可正常运行。 + - 使用元数据同步时，要求`Schema region`、`ConfigNode` 的共识协议必须为默认的 ratis 协议，即`iotdb-system.properties`配置文件中是否包含`config_node_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`、`schema_region_consensus_protocol_class=org.apache.iotdb.consensus.ratis.RatisConsensus`，不包含即为默认值ratis 协议。 - 为了防止潜在的冲突，请在开启元数据同步时关闭接收端自动创建元数据功能。可通过修改 `iotdb-system.properties`配置文件中的`enable_auto_create_schema`配置项为 false，关闭元数据自动创建功能。