diff --git a/src/zh/UserGuide/Master/Table/API/Programming-JDBC_apache.md b/src/zh/UserGuide/Master/Table/API/Programming-JDBC_apache.md index c5a1db5e0..7963e19c1 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-JDBC_apache.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-JDBC_apache.md @@ -21,7 +21,7 @@ # JDBC接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互，允许用户通过Java程序执行SQL语句来管理数据库和时间序列数据。它支持数据库的连接、创建、查询、更新和删除操作，以及时间序列数据的批量插入和查询。 @@ -29,7 +29,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 对于Java应用，我们推荐使用Java 原生接口。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -48,7 +48,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 功能说明 @@ -68,7 +68,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 | ResultSet.next() | 移动到结果集的下一行 | 无 | boolean: 是否成功移动到下一行 | | ResultSet.getString(int columnIndex) | 获取指定列的字符串值 | columnIndex: 列索引（从1开始） | String: 列的字符串值 | -## 4 示例代码 +## 4. 示例代码 **注意：使用表模型，必须在 url 中指定 sql_dialect 参数为 table。** diff --git a/src/zh/UserGuide/Master/Table/API/Programming-JDBC_timecho.md b/src/zh/UserGuide/Master/Table/API/Programming-JDBC_timecho.md index c5b57096e..cbca0f5da 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-JDBC_timecho.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-JDBC_timecho.md @@ -21,7 +21,7 @@ # JDBC接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互，允许用户通过Java程序执行SQL语句来管理数据库和时间序列数据。它支持数据库的连接、创建、查询、更新和删除操作，以及时间序列数据的批量插入和查询。 @@ -29,7 +29,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 对于Java应用，我们推荐使用Java 原生接口。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -48,7 +48,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 功能说明 @@ -68,7 +68,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 | ResultSet.next() | 移动到结果集的下一行 | 无 | boolean: 是否成功移动到下一行 | | ResultSet.getString(int columnIndex) | 获取指定列的字符串值 | columnIndex: 列索引（从1开始） | String: 列的字符串值 | -## 4 示例代码 +## 4. 示例代码 **注意：使用表模型，必须在 url 中指定 sql_dialect 参数为 table。** diff --git a/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md b/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md index e390a4be8..212bb59cc 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md @@ -21,11 +21,11 @@ # Java Session原生接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接口，可以直接组装时序对象进行写入，无需拼装 SQL。推荐使用连接池，多线程并行操作数据库。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -44,7 +44,7 @@ IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 ITableSession接口 @@ -348,7 +348,7 @@ public class TableSessionBuilder { } ``` -## 4 客户端连接池 +## 4. 客户端连接池 ### 4.1 ITableSessionPool 接口 @@ -627,7 +627,7 @@ public class TableSessionPoolBuilder { } ``` -## 5 示例代码 +## 5. 示例代码 Session 示例代码：[src/main/java/org/apache/iotdb/TableModelSessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/TableModelSessionExample.java) diff --git a/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md b/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md index e97273103..05acee956 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md @@ -21,11 +21,11 @@ # Java Session原生接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接口，可以直接组装时序对象进行写入，无需拼装 SQL。推荐使用连接池，多线程并行操作数据库。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -44,7 +44,7 @@ IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 ITableSession接口 @@ -348,7 +348,7 @@ public class TableSessionBuilder { } ``` -## 4 客户端连接池 +## 4. 客户端连接池 ### 4.1 ITableSessionPool 接口 @@ -627,7 +627,7 @@ public class TableSessionPoolBuilder { } ``` -## 5 示例代码 +## 5. 示例代码 Session 示例代码：[src/main/java/org/apache/iotdb/TableModelSessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/TableModelSessionExample.java) diff --git a/src/zh/UserGuide/Master/Table/API/Programming-Python-Native-API.md b/src/zh/UserGuide/Master/Table/API/Programming-Python-Native-API.md index 28f92880a..05e5e0a15 100644 --- a/src/zh/UserGuide/Master/Table/API/Programming-Python-Native-API.md +++ b/src/zh/UserGuide/Master/Table/API/Programming-Python-Native-API.md @@ -21,7 +21,7 @@ # Python 原生接口 -## 1 使用方式 +## 1. 使用方式 安装依赖包: @@ -29,7 +29,7 @@ pip3 install apache-iotdb ``` -## 2 读写操作 +## 2. 读写操作 ### 2.1 TableSession @@ -168,7 +168,7 @@ class TableSessionConfig(object): 在使用完 TableSession 后，务必调用 close 方法来释放资源。 -## 3 客户端连接池 +## 3. 客户端连接池 ### 3.1 TableSessionPool @@ -287,7 +287,7 @@ class TableSessionPoolConfig(object): """ ``` -## 4 示例代码 +## 4. 示例代码 Session示例代码:[iotdb/blob/master/iotdb-client/client-py/table_model_session_example.py](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/table_model_session_example.py) diff --git a/src/zh/UserGuide/Master/Table/API/RestServiceV1.md b/src/zh/UserGuide/Master/Table/API/RestServiceV1.md index ba4062ca8..268961e83 100644 --- a/src/zh/UserGuide/Master/Table/API/RestServiceV1.md +++ b/src/zh/UserGuide/Master/Table/API/RestServiceV1.md @@ -23,7 +23,7 @@ IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 -## 1 开启 RESTful 服务 +## 1. 开启 RESTful 服务 Restful 服务默认情况是关闭的，开启 restful 功能需要找到 IoTDB 安装目录下的`conf/iotdb-system.properties`文件，将 `enable_rest_service` 设置为 `true` ，然后重启 datanode 进程。 @@ -31,7 +31,7 @@ Restful 服务默认情况是关闭的，开启 restful 功能需要找到 IoTDB enable_rest_service=true ``` -## 2 鉴权 +## 2. 鉴权 除了检活接口 `/ping`，restful服务使用了基础（basic）鉴权，每次 URL 请求都需要在 header 中携带 `'Authorization':'Basic' + base64.encode(username + ':' + password)`。 @@ -57,7 +57,7 @@ Authorization : Basic cm9vdDpyb290 {"code":800,"message":"INIT_AUTH_ERROR"} ``` -## 3 接口定义 +## 3. 接口定义 ### 3.1 ping @@ -251,7 +251,7 @@ curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290" -X ``` -## 4 配置 +## 4. 配置 配置文件位于 `iotdb-system.properties` 中。 diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md index ff3ff2727..f55d381db 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md @@ -21,7 +21,7 @@ # 常见概念 -## 1 数据模型相关概念 +## 1. 数据模型相关概念 ### 1.1 数据模型（sql_dialect） @@ -48,7 +48,7 @@ IoTDB 支持两种时序数据模型（SQL语法），管理的对象均为设 IoTDB 在数据编码后，使用压缩技术进一步压缩二进制数据，提升存储效率。IoTDB 支持多种压缩方法，详细信息请查看：[压缩和编码](../Technical-Insider/Encoding-and-Compression.md)。 -## 2 分布式相关概念 +## 2. 分布式相关概念 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： @@ -89,7 +89,7 @@ IoTDB 集群包括三种节点（进程）：ConfigNode（管理节点），Data | 数据 | data_replication_factor | 1 | 2 | -## 3 部署相关概念 +## 3. 部署相关概念 IoTDB 有两种运行模式：单机模式、集群模式。 diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md index 1a4de58e5..33a7b567f 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md @@ -21,7 +21,7 @@ # 常见概念 -## 1 数据模型相关概念 +## 1. 数据模型相关概念 ### 1.1 数据模型（sql_dialect） @@ -48,7 +48,7 @@ IoTDB 支持两种时序数据模型（SQL语法），管理的对象均为设 IoTDB 在数据编码后，使用压缩技术进一步压缩二进制数据，提升存储效率。IoTDB 支持多种压缩方法，详细信息请查看：[压缩和编码](../Technical-Insider/Encoding-and-Compression.md)。 -## 2 分布式相关概念 +## 2. 分布式相关概念 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： @@ -89,7 +89,7 @@ IoTDB 集群包括三种节点（进程）：ConfigNode（管理节点），Data | 数据 | data_replication_factor | 1 | 2 | -## 3 部署相关概念 +## 3. 部署相关概念 IoTDB 有三种运行模式：单机模式、集群模式和双活模式。 diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md index 377f3182c..e690f1311 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -23,11 +23,11 @@ 本章节主要介绍如何将时序数据应用场景转化为IoTDB时序建模。 -## 1 时序数据模型 +## 1. 时序数据模型 在构建IoTDB建模方案前，需要先了解时序数据和时序数据模型，详细内容见此页面：[时序数据模型](../Background-knowledge/Navigating_Time_Series_Data.md) -## 2 IoTDB 的两种时序模型 +## 2. IoTDB 的两种时序模型 IoTDB 提供了两种数据建模方式——树模型和表模型，其特点分别如下： @@ -80,7 +80,7 @@ IoTDB 提供了两种数据建模方式——树模型和表模型，其特点 - 在通过客户端工具 Cli 或 SDK 建立数据库连接时，需要通过 sql_dialect 参数指定使用的模型语法（默认使用树语法进行操作）。 -## 3 应用场景 +## 3. 应用场景 应用场景主要包括两类： diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md index 5a41c8909..d5c424bc7 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -23,11 +23,11 @@ 本章节主要介绍如何将时序数据应用场景转化为IoTDB时序建模。 -## 1 时序数据模型 +## 1. 时序数据模型 在构建IoTDB建模方案前，需要先了解时序数据和时序数据模型，详细内容见此页面：[时序数据模型](../Background-knowledge/Navigating_Time_Series_Data.md) -## 2 IoTDB 的两种时序模型 +## 2. IoTDB 的两种时序模型 IoTDB 提供了两种数据建模方式——树模型和表模型，其特点分别如下： @@ -80,7 +80,7 @@ IoTDB 提供了两种数据建模方式——树模型和表模型，其特点 - 在通过客户端工具 Cli 或 SDK 建立数据库连接时，需要通过 sql_dialect 参数指定使用的模型语法（默认使用树语法进行操作）。 -## 3 应用场景 +## 3. 应用场景 应用场景主要包括三类： diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Type.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Type.md index 4e043651a..35f8a971e 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Type.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Data-Type.md @@ -21,7 +21,7 @@ # 数据类型 -## 1 基本数据类型 +## 1. 基本数据类型 IoTDB 支持以下十种数据类型： @@ -70,7 +70,7 @@ CREATE TIMESERIES root.vehicle.d0.s0 WITH DATATYPE=FLOAT, ENCODING=RLE, 'MAX_POI | TIMESTAMP | INT32 INT64 TIMESTAMP | | DATE | DATE | -## 2 时间戳类型 +## 2. 时间戳类型 时间戳是一个数据到来的时间点，其中包括绝对时间戳和相对时间戳。 diff --git a/src/zh/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md b/src/zh/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md index 49d9edfb2..f965eb055 100644 --- a/src/zh/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/zh/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md @@ -20,7 +20,7 @@ --> # 时序数据模型 -## 1 什么叫时序数据？ +## 1. 什么叫时序数据？ 万物互联的今天，物联网场景、工业场景等各类场景都在进行数字化转型，人们通过在各类设备上安装传感器对设备的各类状态进行采集。如电机采集电压、电流，风机的叶片转速、角速度、发电功率；车辆采集经纬度、速度、油耗；桥梁的振动频率、挠度、位移量等。传感器的数据采集，已经渗透在各个行业中。 @@ -33,7 +33,7 @@ 传感器产生的海量时序数据是各行各业数字化转型的基础，因此我们对时序数据的模型梳理主要围绕设备、传感器展开。 -## 2 时序数据中的关键概念有哪些？ +## 2. 时序数据中的关键概念有哪些？ 时序数据中主要涉及的概念如下。 diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management.md index 09ffa43b4..be6b7972a 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Database-Management.md @@ -21,7 +21,7 @@ # 数据库管理 -## 1 数据库管理 +## 1. 数据库管理 ### 1.1 创建数据库 diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Delete-Data.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Delete-Data.md index fdd45cc15..dce9c095c 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Delete-Data.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Delete-Data.md @@ -21,7 +21,7 @@ # 数据删除 -## 1 数据删除： +## 1. 数据删除： 数据删除可以通过 delete 语句来完成，其中可以通过指定标签和时间的过滤条件来删除部分数据。 @@ -92,7 +92,7 @@ DELETE FROM table1 DELETE FROM table1 WHERE model_id = 'B' ``` -## 2 设备删除： +## 2. 设备删除： 当一个设备写入后，在 IoTDB 中即保留了其元数据，数据删除语句无法删除设备的元数据，可以使用设备删除语句删除设备的所有数据和元数据。 diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Query-Data.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Query-Data.md index 40180ce77..0468da5a5 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Query-Data.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Query-Data.md @@ -21,7 +21,7 @@ # 数据查询 -## 1 语法概览 +## 1. 语法概览 ```SQL SELECT ⟨select_list⟩ @@ -47,13 +47,13 @@ IoTDB 查询语法提供以下子句： - OFFSET 子句：用于指定查询结果的起始位置，即跳过前 OFFSET 行。与 LIMIT 子句配合使用。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) - LIMIT 子句：限制查询结果的行数，通常与 OFFSET 子句一起使用以实现分页功能。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) -## 2 子句执行顺序 +## 2. 子句执行顺序 ![](/img/%E5%AD%90%E5%8F%A5%E6%89%A7%E8%A1%8C%E9%A1%BA%E5%BA%8F01.png) -## 3 常见查询示例 +## 3. 常见查询示例 ### 3.1 示例数据 diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md b/src/zh/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md index 79d484945..38ea245f5 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md @@ -21,7 +21,7 @@ # 过期自动删除（TTL） -## 1 概览 +## 1. 概览 IoTDB支持表级的数据自动过期删除（TTL）设置，允许系统自动定期删除旧数据，以有效控制磁盘空间并维护高性能查询和低内存占用。TTL默认以毫秒为单位，数据过期后不可查询且禁止写入，但物理删除会延迟至压缩时。需注意，TTL变更可能导致短暂数据可查询性变化。 @@ -31,7 +31,7 @@ IoTDB支持表级的数据自动过期删除（TTL）设置，允许系统自动 2. TTL变更可能影响数据的可查询性。 3. 系统最终会移除过期数据，但存在延迟。 -## 2 设置 TTL +## 2. 设置 TTL 在表模型中，IoTDB 的 TTL 是按照表的粒度生效的。可以直接在表上设置 TTL，或者在数据库级别设置 TTL。当在数据库级别设置了TTL时，在创建新表的过程中，系统会自动采用这个TTL值作为新表的默认设置，但每个表仍然可以独立地被设置或覆盖该值。 @@ -89,7 +89,7 @@ use db CREATE TABLE test3 ("场站" string id, "温度" int32) with (ttl='INF') ``` -## 3 取消 TTL +## 3. 取消 TTL 取消 TTL 设置，可以修改表的 TTL 设置为 'INF'。目前，IoTDB 不支持修改数据库的 TTL。 @@ -97,7 +97,7 @@ CREATE TABLE test3 ("场站" string id, "温度" int32) with (ttl='INF') ALTER TABLE tableB set properties TTL='INF' ``` -## 4 查看 TTL 信息 +## 4. 查看 TTL 信息 使用 "SHOW DATABASES" 和 "SHOW TABLES" 命令可以直接显示数据库和表的 TTL 详情。数据库和表管理语句详情可见：[数据库管理](../Basic-Concept/Database-Management.md)、[表管理](../Basic-Concept/Table-Management.md) diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Table-Management.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Table-Management.md index 9b6dede6a..c2b59707a 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Table-Management.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Table-Management.md @@ -21,7 +21,7 @@ # 表管理 -## 1 表管理 +## 1. 表管理 ### 1.1 创建表 diff --git a/src/zh/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md b/src/zh/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md index 5f4ece0b5..4e9da1282 100644 --- a/src/zh/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md +++ b/src/zh/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md @@ -21,7 +21,7 @@ # 数据写入&更新 -## 1 数据写入 +## 1. 数据写入 ### 1.1 语法 @@ -178,7 +178,7 @@ values - 如果在 SQL 语句中引用了表中不存在的列，IoTDB 将返回错误码 `COLUMN_NOT_EXIST(616)`。 - 如果写入的数据类型与表中列的数据类型不一致，将报错 `DATA_TYPE_MISMATCH(507)`。 -## 2 数据更新 +## 2. 数据更新 ### 2.1 语法 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 1dae9129e..34c25defb 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -26,7 +26,7 @@ -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 @@ -52,12 +52,12 @@ 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考：[监控面板部署](./Monitoring-panel-deployment.md) -## 2 准备步骤 +## 2. 准备步骤 1. 准备IoTDB数据库安装包 ：apache-iotdb-{version}-all-bin.zip（安装包获取见：[链接](../Deployment-and-Maintenance/IoTDB-Package_apache.md)） 2. 按环境要求配置好操作系统环境（系统环境配置见：[链接](../Deployment-and-Maintenance/Environment-Requirements.md)） -## 3 安装步骤 +## 3. 安装步骤 假设现在有3台linux服务器，IP地址和服务角色分配如下： @@ -160,7 +160,7 @@ cd sbin ![](/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -## 4 节点维护步骤 +## 4. 节点维护步骤 ### 4.1 ConfigNode节点维护 @@ -187,7 +187,7 @@ sbin/start-confignode.bat #### 4.1.2 移除ConfigNode节点 -首先通过CLI连接集群，通过`show confignodes`确认想要移除ConfigNode的NodeID： +首先通过CLI连接集群，通过`show confignodes`确认想要移除ConfigNode的内部地址与端口号： ```shell IoTDB> show confignodes @@ -202,9 +202,18 @@ Total line number = 3 It costs 0.030s ``` -然后使用SQL将ConfigNode移除，SQL命令： +然后使用脚本将DataNode移除。脚本命令： + ```Bash -remove confignode [confignode_id] +# Linux / MacOS +sbin/remove-confignode.sh [confignode_id] +或 +./sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] + +#Windows +sbin/remove-confignode.bat [confignode_id] +或 +./sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode节点维护 @@ -234,7 +243,7 @@ sbin/start-datanode.bat #### 4.2.2 移除DataNode节点 -首先通过CLI连接集群，通过`show datanodes`确认想要移除的DataNode的NodeID： +首先通过CLI连接集群，通过`show datanodes`确认想要移除的DataNode的RPC地址与端口号： ```Bash IoTDB> show datanodes @@ -249,12 +258,17 @@ Total line number = 3 It costs 0.110s ``` -然后使用SQL将DataNode移除，SQL命令： +然后使用脚本将DataNode移除。脚本命令： + ```Bash -remove datanode [datanode_id] +# Linux / MacOS +sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] + +#Windows +sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` -## 5 常见问题 +## 5. 常见问题 1. Confignode节点启动失败 - 步骤 1: 请查看启动日志，检查是否修改了某些首次启动后不可改的参数。 @@ -283,7 +297,7 @@ remove datanode [datanode_id] ```shell cd /data/iotdb rm -rf data logs ``` -## 6 附录 +## 6. 附录 ### 6.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index f5570a99d..7be498f0e 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -26,7 +26,7 @@ -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 @@ -52,12 +52,12 @@ 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考：[监控面板部署](./Monitoring-panel-deployment.md) -## 2 准备步骤 +## 2. 准备步骤 1. 准备IoTDB数据库安装包 ：timechodb-{version}-bin.zip（安装包获取见：[链接](./IoTDB-Package_timecho.md)） 2. 按环境要求配置好操作系统环境（系统环境配置见：[链接](./Environment-Requirements.md)） -## 3 安装步骤 +## 3. 安装步骤 假设现在有3台linux服务器，IP地址和服务角色分配如下： @@ -220,7 +220,7 @@ cd sbin ![](/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -## 4 节点维护步骤 +## 4. 节点维护步骤 ### 4.1 ConfigNode节点维护 @@ -247,7 +247,7 @@ sbin/start-confignode.bat #### 4.1.2 移除ConfigNode节点 -首先通过CLI连接集群，通过`show confignodes`确认想要移除ConfigNode的NodeID： +首先通过CLI连接集群，通过`show confignodes`确认想要移除ConfigNode的内部地址与端口号： ```shell IoTDB> show confignodes @@ -262,9 +262,18 @@ Total line number = 3 It costs 0.030s ``` -然后使用SQL将ConfigNode移除，SQL命令： +然后使用脚本将DataNode移除。脚本命令： + ```Bash -remove confignode [confignode_id] +# Linux / MacOS +sbin/remove-confignode.sh [confignode_id] +或 +./sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] + +#Windows +sbin/remove-confignode.bat [confignode_id] +或 +./sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode节点维护 @@ -294,7 +303,7 @@ sbin/start-datanode.bat #### 4.2.2 移除DataNode节点 -首先通过CLI连接集群，通过`show datanodes`确认想要移除的DataNode的NodeID： +首先通过CLI连接集群，通过`show datanodes`确认想要移除的DataNode的RPC地址与端口号： ```Bash IoTDB> show datanodes @@ -309,12 +318,17 @@ Total line number = 3 It costs 0.110s ``` -然后使用SQL将DataNode移除，SQL命令： +然后使用脚本将DataNode移除。脚本命令： + ```Bash -remove datanode [datanode_id] +# Linux / MacOS +sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] + +#Windows +sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` -## 5 常见问题 +## 5. 常见问题 1. 部署过程中多次提示激活失败 - 使用 `ls -al` 命令：使用 `ls -al` 命令检查安装包根目录的所有者信息是否为当前用户。 @@ -346,7 +360,7 @@ remove datanode [datanode_id] ```shell cd /data/iotdb rm -rf data logs ``` -## 6 附录 +## 6. 附录 ### 6.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md index fe6133025..cf3cf0af0 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md @@ -20,7 +20,7 @@ --> # 资源规划 -## 1 CPU +## 1. CPU @@ -82,7 +82,7 @@
-## 2 内存 +## 2. 内存 @@ -144,7 +144,7 @@
-## 3 存储(磁盘) +## 3. 存储(磁盘) ### 3.1 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） @@ -190,11 +190,11 @@ - 简版计算公式：1000 * 100 * 12 * 86400 * 365 * 3 / 10 / 1024 / 1024 / 1024 / 1024 = 11T ### 3.2 存储配置 1000w 点位以上或查询负载较大，推荐配置 SSD。 -## 4 网络（网卡） +## 4. 网络（网卡） 在写入吞吐不超过1000万点/秒时，需配置千兆网卡；当写入吞吐超过 1000万点/秒时，需配置万兆网卡。 | **写入吞吐（数据点/秒）** | **网卡速率** | | ------------------- | ------------- | | <1000万 | 1Gbps（千兆） | | >=1000万 | 10Gbps（万兆） | -## 5 其他说明 +## 5. 其他说明 IoTDB 具有集群秒级扩容能力，扩容节点数据可不迁移，因此您无需担心按现有数据情况估算的集群能力有限，未来您可在需要扩容时为集群加入新的节点。 \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_apache.md index 984b5fb3d..f6a913807 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_apache.md @@ -22,7 +22,7 @@ IoTDB 有两种运行模式：单机模式、集群模式。 -## 1 单机模式 +## 1. 单机模式 IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； @@ -30,7 +30,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限或对高可用要求不高的场景，例如边缘端服务器。 - **部署方法**：[单机版部署](../Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md) -## 2 集群模式 +## 2. 集群模式 IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 个 DataNode，即3C3D；当部分节点出现故障时，剩余节点仍然能对外提供服务，保证数据库服务的高可用性，且可随节点增加提升数据库性能。 @@ -38,7 +38,7 @@ IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 - **适用场景**：需要提供高可用和可靠性的企业级应用场景。 - **部署方法**：[集群版部署](../Deployment-and-Maintenance/Cluster-Deployment_apache.md) -## 3 特点总结 +## 3. 特点总结 | 维度 | 单机模式 | 集群模式 | | ------------ | ---------------------------- | ------------------------ | diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_timecho.md index d4a78a6b5..d49674d07 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_timecho.md @@ -22,7 +22,7 @@ IoTDB 有三种运行模式：单机模式、集群模式和双活模式。 -## 1 单机模式 +## 1. 单机模式 IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； @@ -30,7 +30,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限或对高可用要求不高的场景，例如边缘端服务器。 - **部署方法**：[单机版部署](../Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md) -## 2 双活模式 +## 2. 双活模式 双活版部署为 TimechoDB 企业版功能，是指两个独立的实例进行双向同步，能同时对外提供服务。当一台停机重启后，另一个实例会将缺失数据断点续传。 @@ -40,7 +40,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限（仅有两台服务器），但希望获得高可用能力。 - **部署方法**：[双活版部署](../Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md) -## 3 集群模式 +## 3. 集群模式 IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 个 DataNode，即3C3D；当部分节点出现故障时，剩余节点仍然能对外提供服务，保证数据库服务的高可用性，且可随节点增加提升数据库性能。 @@ -48,7 +48,7 @@ IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 - **适用场景**：需要提供高可用和可靠性的企业级应用场景。 - **部署方法**：[集群版部署](../Deployment-and-Maintenance/Cluster-Deployment_timecho.md) -## 4 特点总结 +## 4. 特点总结 | 维度 | 单机模式 | 双活模式 | 集群模式 | | ------------ | ---------------------------- | ------------------------ | ------------------------ | diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_apache.md index 0d9e90aee..f0a0a79be 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_apache.md @@ -20,7 +20,7 @@ --> # Docker部署 -## 1 环境准备 +## 1. 环境准备 ### 1.1 Docker安装 @@ -53,7 +53,7 @@ ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose docker-compose --version #显示版本信息即安装成功 ``` -## 2 单机版 +## 2. 单机版 本节演示如何部署1C1D的docker单机版。 @@ -197,7 +197,7 @@ docker cp iotdb:/iotdb/conf /docker-iotdb/iotdb/conf docker-compose -f docker-compose-standalone.yml up -d ``` -## 3 集群版 +## 3. 集群版 本小节描述如何手动部署包括3个ConfigNode和3个DataNode的实例，即通常所说的3C3D集群。 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md index cfd708fdb..84af4fd6e 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md @@ -20,7 +20,7 @@ --> # Docker部署 -## 1 环境准备 +## 1. 环境准备 ### 1.1 Docker安装 @@ -67,7 +67,7 @@ dmidecode 安装后，查找安装路径：`whereis dmidecode`，这里假设结 关于IoTDB企业版的容器镜像您可联系商务或技术支持获取。 -## 2 单机版部署 +## 2. 单机版部署 本节演示如何部署1C1D的docker单机版。 @@ -239,7 +239,7 @@ docker cp iotdb:/iotdb/conf /docker-iotdb/iotdb/conf docker-compose -f docker-compose-standalone.yml up -d ``` -## 3 集群版部署 +## 3. 集群版部署 本小节描述如何手动部署包括3个ConfigNode和3个DataNode的实例，即通常所说的3C3D集群。 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md index c80815100..c1e36dd5e 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md @@ -20,7 +20,7 @@ --> # 双活版部署 -## 1 什么是双活版？ +## 1. 什么是双活版？ 双活通常是指两个独立的单机(或集群)，实时进行镜像同步，它们的配置完全独立，可以同时接收外界的写入，每一个独立的单机(或集群)都可以将写入到自己的数据同步到另一个单机(或集群)中，两个单机(或集群)的数据可达到最终一致。 @@ -30,7 +30,7 @@ ![](/img/%E5%8F%8C%E6%B4%BB%E5%90%8C%E6%AD%A5.png) -## 2 注意事项 +## 2. 注意事项 1. 部署时推荐优先使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在目标服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的`cn_internal_address`、`dn_internal_address`。 @@ -42,7 +42,7 @@ 3. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考[文档](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 3 安装步骤 +## 3. 安装步骤 我们以两台单机A和B构建的双活版IoTDB为例，A和B的ip分别是192.168.1.3 和 192.168.1.4 ，这里用hostname来表示不同的主机，规划如下： diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md index 760f8329c..41e635f11 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -20,7 +20,7 @@ --> # 系统配置 -## 1 磁盘阵列 +## 1. 磁盘阵列 ### 1.1 配置建议 @@ -77,7 +77,7 @@ IoTDB对磁盘阵列配置没有严格运行要求，推荐使用多个磁盘阵 | 数据盘 | RAID5 | 7 | 允许坏1块 | 6 | | 数据盘 | NoRaid | 1 | 损坏丢失 | 1 | -## 2 操作系统 +## 2. 操作系统 ### 2.1 版本要求 @@ -192,7 +192,7 @@ echo "* hard nofile 65535" >> /etc/security/limits.conf ulimit -n ``` -## 3 软件依赖 +## 3. 软件依赖 安装 Java 运行环境 ，Java 版本 >= 1.8，请确保已设置 jdk 环境变量。（V1.3.2.2 及之上版本推荐直接部署JDK17，老版本JDK部分场景下性能有问题，且datanode会出现stop不掉的问题） diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_apache.md index e3f14a95d..c98ba8316 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_apache.md @@ -19,11 +19,11 @@ --> # 安装包获取 -## 1 安装包获取方式 +## 1. 安装包获取方式 安装包可直接在Apache IoTDB官网获取：https://iotdb.apache.org/zh/Download/ -## 2 安装包结构 +## 2. 安装包结构 解压后安装包（`apache-iotdb--all-bin.zip`），安装包解压后目录结构如下： diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md index 23758abf0..c5d5251f4 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md @@ -19,11 +19,11 @@ --> # 安装包获取 -## 1 获取方式 +## 1. 获取方式 企业版安装包可通过产品试用申请，或直接联系与您对接的工作人员获取。 -## 2 安装包结构 +## 2. 安装包结构 安装包解压后目录结构如下： diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md index 05c7bdbe9..14b1e29e5 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md @@ -22,12 +22,12 @@ IoTDB配套监控面板是IoTDB企业版配套工具之一。它旨在解决IoTDB及其所在操作系统的监控问题，主要包括：操作系统资源监控、IoTDB性能监控，及上百项内核监控指标，从而帮助用户监控集群健康状态，并进行集群调优和运维。本文将以常见的3C3D集群(3个Confignode和3个Datanode)为例，为您介绍如何在IoTDB的实例中开启系统监控模块，并且使用Prometheus + Grafana的方式完成对系统监控指标的可视化。 -## 1 安装准备 +## 1. 安装准备 1. 安装 IoTDB：需先安装IoTDB V1.0 版本及以上企业版，您可联系商务或技术支持获取 2. 获取 IoTDB 监控面板安装包：基于企业版 IoTDB 的数据库监控面板，您可联系商务或技术支持获取 -## 2 安装步骤 +## 2. 安装步骤 ### 步骤一：IoTDB开启监控指标采集 @@ -184,7 +184,7 @@ cd grafana-* ![](/img/%E9%9D%A2%E6%9D%BF%E6%B1%87%E6%80%BB.png) -## 3 附录、监控指标详解 +## 3. 附录、监控指标详解 ### 3.1 系统面板（System Dashboard） diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md index 0a248dff4..4499bbd69 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md @@ -22,7 +22,7 @@ 本章将介绍如何启动IoTDB单机实例，IoTDB单机实例包括 1 个ConfigNode 和1个DataNode（即通常所说的1C1D）。 -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 2. 推荐使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的 `cn_internal_address`、`dn_internal_address`。 @@ -40,7 +40,7 @@ - 避免使用 sudo：使用 sudo 命令会以 root 用户权限执行命令，可能会引起权限混淆或安全问题。 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系工作人员获取，部署监控面板步骤可以参考：[监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 安装步骤 +## 2. 安装步骤 ### 2.1 解压安装包并进入安装目录 @@ -122,7 +122,7 @@ DataNode 配置 ![](/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -## 3 常见问题 +## 3. 常见问题 1. Confignode节点启动失败 - 步骤 1: 请查看启动日志，检查是否修改了某些首次启动后不可改的参数。 @@ -151,7 +151,7 @@ DataNode 配置 cd /data/iotdb rm -rf data logs ``` -## 4 附录 +## 4. 附录 ### 4.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md index 095303c23..70542c894 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md @@ -22,7 +22,7 @@ 本章将介绍如何启动IoTDB单机实例，IoTDB单机实例包括 1 个ConfigNode 和1个DataNode（即通常所说的1C1D）。 -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 2. 推荐使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的 `cn_internal_address`、`dn_internal_address`。 @@ -40,7 +40,7 @@ - 避免使用 sudo：使用 sudo 命令会以 root 用户权限执行命令，可能会引起权限混淆或安全问题。 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系工作人员获取，部署监控面板步骤可以参考：[监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 安装步骤 +## 2. 安装步骤 ### 2.1 解压安装包并进入安装目录 @@ -176,7 +176,7 @@ IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOM ![](/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -## 3 常见问题 +## 3. 常见问题 1. 部署过程中多次提示激活失败 - 使用 `ls -al` 命令：使用 `ls -al` 命令检查安装包根目录的所有者信息是否为当前用户。 @@ -208,7 +208,7 @@ IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOM cd /data/iotdb rm -rf data logs ``` -## 4 附录 +## 4. 附录 ### 4.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md index d7fdda7f1..8f87ff99d 100644 --- a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -30,7 +30,7 @@ Apache IoTDB 是一款低成本、高性能的物联网原生时序数据库。 - 安装部署与使用文档：[快速上手](../QuickStart/QuickStart.md) -## 1 产品体系 +## 1. 产品体系 IoTDB 体系由若干个组件构成，帮助用户高效地管理和分析物联网产生的海量时序数据。 @@ -44,13 +44,13 @@ IoTDB 体系由若干个组件构成，帮助用户高效地管理和分析物 2. **时序数据标准文件格式（Apache TsFile）**：该文件格式是一种专为时序数据设计的存储格式，可以高效地存储和查询海量时序数据。目前 IoTDB、AINode 等模块的底层存储文件均由 Apache TsFile 进行支撑。通过 TsFile，用户可以在采集、管理、应用&分析阶段统一使用相同的文件格式进行数据管理，极大简化了数据采集到分析的整个流程，提高时序数据管理的效率和便捷度。 3. **时序模型训推一体化引擎（IoTDB AINode）**：针对智能分析场景，IoTDB 提供 AINode 时序模型训推一体化引擎，它提供了一套完整的时序数据分析工具，底层为模型训练引擎，支持训练任务与数据管理，与包括机器学习、深度学习等。通过这些工具，用户可以对存储在 IoTDB 中的数据进行深入分析，挖掘出其中的价值。 -## 2 TimechoDB 整体架构 +## 2. TimechoDB 整体架构 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： -## 3 产品特性 +## 3. 产品特性 Apache IoTDB 具备以下优势和特性： @@ -70,7 +70,7 @@ Apache IoTDB 具备以下优势和特性： - 丰富的生态环境对接：支持Hadoop、Spark等大数据生态系统组件对接，支持Grafana、Thingsboard、DataEase等设备管理和可视化工具 -## 4 商业版本 +## 4. 商业版本 天谋科技在 Apache IoTDB 开源版本的基础上提供了原厂商业化产品 TimechoDB，为企业、商业客户提供企业级产品和服务，它可以解决企业组建物联网大数据平台管理时序数据时所遇到的应用场景复杂、数据体量大、采样频率高、数据乱序多、数据处理耗时长、分析需求多样、存储与运维成本高等多种问题。 diff --git a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 8ecf2b001..aecb77043 100644 --- a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -27,7 +27,7 @@ TimechoDB 是一款低成本、高性能的物联网原生时序数据库，是 - 下载、部署与使用：[快速上手](../QuickStart/QuickStart_timecho.md) -## 1 产品体系 +## 1. 产品体系 天谋产品体系由若干个组件构成，覆盖由【数据采集】到【数据管理】到【数据分析&应用】的全时序数据生命周期，做到“采-存-用”一体化时序数据解决方案，帮助用户高效地管理和分析物联网产生的海量时序数据。 @@ -43,13 +43,13 @@ TimechoDB 是一款低成本、高性能的物联网原生时序数据库，是 3. **时序模型训推一体化引擎（AINode）**：针对智能分析场景，TimechoDB 提供 AINode 时序模型训推一体化引擎，它提供了一套完整的时序数据分析工具，底层为模型训练引擎，支持训练任务与数据管理，与包括机器学习、深度学习等。通过这些工具，用户可以对存储在 TimechoDB 中的数据进行深入分析，挖掘出其中的价值。 4. **数据采集**：为了更加便捷的对接各类工业采集场景， 天谋科技提供数据采集接入服务，支持多种协议和格式，可以接入各种传感器、设备产生的数据，同时支持断点续传、网闸穿透等特性。更加适配工业领域采集过程中配置难、传输慢、网络弱的特点，让用户的数采变得更加简单、高效。 -## 2 TimechoDB 整体架构 +## 2. TimechoDB 整体架构 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： -## 3 产品特性 +## 3. 产品特性 TimechoDB 具备以下优势和特性： @@ -69,7 +69,7 @@ TimechoDB 具备以下优势和特性： - 丰富的生态环境对接：支持Hadoop、Spark等大数据生态系统组件对接，支持Grafana、Thingsboard、DataEase等设备管理和可视化工具 -## 4 企业特性 +## 4. 企业特性 ### 4.1 更高阶的产品功能 diff --git a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Release-history_timecho.md b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Release-history_timecho.md index a07bcc8b4..30e6a18b2 100644 --- a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Release-history_timecho.md +++ b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Release-history_timecho.md @@ -20,7 +20,7 @@ --> # 发版历史 -## 1 TimechoDB（数据库内核） +## 1. TimechoDB（数据库内核） ### V1.3.4.1 > 发版时间：2025.01.08 > @@ -202,7 +202,7 @@ V1.0.0.1主要修复分区计算及查询执行时的相关问题，历史快照 - 流处理模块：支持流处理框架 - 流处理模块：支持集群间数据同步功能 -## 2 Workbench（控制台工具） +## 2. Workbench（控制台工具） | **控制台版本号** | **版本说明** | **可支持IoTDB版本** | | ---------------- | ------------------------------------------------------------ | ------------------- | diff --git a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Scenario.md b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Scenario.md index fc2e90d87..572115420 100644 --- a/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Scenario.md +++ b/src/zh/UserGuide/Master/Table/IoTDB-Introduction/Scenario.md @@ -21,7 +21,7 @@ # 应用场景 -## 1 应用1——能源电力 +## 1. 能源电力 ### 1.1 背景 @@ -34,7 +34,7 @@ IoTDB 凭借集群高可用、低流量数据同步、跨网闸支持和优异 ![img](/img/scenarios01.png) -## 2 应用2——航空航天 +## 2. 航空航天 ### 2.1 背景 @@ -47,7 +47,7 @@ IoTDB 凭借其国产自研的高效低流量数据同步、离线数据迁移 ![img](/img/scenarios02.png) -## 3 应用3——交通运输 +## 3. 交通运输 ### 3.1 背景 @@ -60,7 +60,7 @@ IoTDB 凭借其高效的时序数据管理和低延迟查询能力，有效应 ![img](/img/scenarios03.png) -## 4 应用4——钢铁冶炼 +## 4. 钢铁冶炼 ### 4.1 背景 @@ -73,7 +73,7 @@ IoTDB 通过其强大的数据存储与计算能力，为钢铁冶炼场景提 ![img](/img/scenarios04.png) -## 5 应用5——物联网 +## 5. 物联网 ### 5.1 背景 diff --git a/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_apache.md b/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_apache.md index ac14961d4..afa6cd2d0 100644 --- a/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_apache.md +++ b/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_apache.md @@ -23,7 +23,7 @@ 本篇文档将帮助您了解快速入门 IoTDB 的方法。 -## 1 如何安装部署？ +## 1. 如何安装部署？ 本篇文档将帮助您快速安装部署 IoTDB，您可以通过以下文档的链接快速定位到所需要查看的内容： @@ -41,7 +41,7 @@ > ❗️注意：目前我们仍然推荐直接在物理机/虚拟机上安装部署，如需要 docker 部署，可参考：[Docker 部署](../Deployment-and-Maintenance/Docker-Deployment_apache.md) -## 2 如何使用？ +## 2. 如何使用？ 1. 数据库建模设计：数据库建模是创建数据库系统的重要步骤，它涉及到设计数据的结构和关系，以确保数据的组织方式能够满足特定应用的需求，下面的文档将会帮助您快速了解 IoTDB 的建模设计： @@ -68,7 +68,7 @@ 6. 应用编程接口： IoTDB 提供了多种应用编程接口（API），以便于开发者在应用程序中与 IoTDB 进行交互，目前支持[ Java 原生接口](../API/Programming-Java-Native-API_apache.md)、[Python 原生接口](../API/Programming-Python-Native-API.md)、[JDBC](../API/Programming-JDBC_apache.md)等，更多编程接口可参见官网【应用编程接口】其他章节 -## 3 想了解更多技术细节？ +## 3. 想了解更多技术细节？ 如果您想了解 IoTDB 的更多技术内幕，可以移步至下面的文档： diff --git a/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_timecho.md b/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_timecho.md index 23168f8a1..cd22f2a74 100644 --- a/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_timecho.md +++ b/src/zh/UserGuide/Master/Table/QuickStart/QuickStart_timecho.md @@ -23,7 +23,7 @@ 本篇文档将帮助您了解快速入门 IoTDB 的方法。 -## 1 如何安装部署？ +## 1. 如何安装部署？ 本篇文档将帮助您快速安装部署 IoTDB，您可以通过以下文档的链接快速定位到所需要查看的内容： @@ -48,7 +48,7 @@ - 监控面板：提供了上百个数据库监控指标，用来对 IoTDB 及其所在操作系统进行细致监控，从而进行系统优化、性能优化、发现瓶颈等，安装步骤可查看 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 如何使用？ +## 2. 如何使用？ 1. 数据库建模设计：数据库建模是创建数据库系统的重要步骤，它涉及到设计数据的结构和关系，以确保数据的组织方式能够满足特定应用的需求，下面的文档将会帮助您快速了解 IoTDB 的建模设计： @@ -75,14 +75,14 @@ 6. 应用编程接口： IoTDB 提供了多种应用编程接口（API），以便于开发者在应用程序中与 IoTDB 进行交互，目前支持[ Java 原生接口](../API/Programming-Java-Native-API_timecho.md)、[Python 原生接口](../API/Programming-Python-Native-API.md)、[JDBC](../API/Programming-JDBC_timecho.md)等，更多编程接口可参见官网【应用编程接口】其他章节 -## 3 还有哪些便捷的周边工具？ +## 3. 还有哪些便捷的周边工具？ IoTDB 除了自身拥有丰富的功能外，其周边的工具体系包含的种类十分齐全。本篇文档将帮助您快速使用周边工具体系： - 监控面板：是一个对 IoTDB 及其所在操作系统进行细致监控的工具，涵盖数据库性能、系统资源等上百个数据库监控指标，助力系统优化与瓶颈识别等，具体使用介绍请查看 [监控面板部署](../Tools-System/Monitor-Tool_timecho.md) -## 4 想了解更多技术细节？ +## 4. 想了解更多技术细节？ 如果您想了解 IoTDB 的更多技术内幕，可以移步至下面的文档： diff --git a/src/zh/UserGuide/Master/Table/Reference/Sample-Data.md b/src/zh/UserGuide/Master/Table/Reference/Sample-Data.md index f7feec9b2..24f85071f 100644 --- a/src/zh/UserGuide/Master/Table/Reference/Sample-Data.md +++ b/src/zh/UserGuide/Master/Table/Reference/Sample-Data.md @@ -23,13 +23,13 @@ 本章节主要介绍一个简单的时序数据应用场景以及在此场景下的建模与示例数据，IoTDB 表模型用户手册中所有的示例 SQL 语句都可以在此建模和示例数据下执行。 -## 1 数据结构 +## 1. 数据结构 table1和table2均为如下表结构： ![](/img/Sample_data01.png) -## 2 导入语句 +## 2. 导入语句 以下为构建上述表结构及数据的SQL语句，您可以点此（[sample_data.sql](/img/sample_data.sql)）下载全部SQL并在CLI中执行，从而将数据导入您的IoTDB。 diff --git a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md index 4515da807..6c25a1260 100644 --- a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md +++ b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md @@ -28,7 +28,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - `iotdb-system.properties`：IoTDB 的配置文件。 - `iotdb-system.properties.template`：IoTDB 的配置文件模版。 -## 1 修改配置： +## 1. 修改配置： 在 `iotdb-system.properties` 文件中已存在的参数可以直接进行修改。对于那些在 `iotdb-system.properties` 中未列出的参数，可以从 `iotdb-system.properties.template` 配置文件模板中找到相应的参数，然后将其复制到 `iotdb-system.properties` 文件中进行修改。 @@ -40,7 +40,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - 重启服务生效： ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 - 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 -## 2 环境配置项 +## 2. 环境配置项 ### 2.1 confignode-env.sh/bat @@ -105,7 +105,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 改后生效方式 | 重启服务生效 | -## 3 系统配置项（iotdb-system.properties.template） +## 3. 系统配置项（iotdb-system.properties.template） ### 3.1 集群管理 @@ -771,7 +771,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 名字 | dn_tier_full_policy | | ------------ | ------------------------------------------------------------ | -| 描述 | 如何处理最后一层数据，当其已用空间高于其dn_default_space_usage_threshold时。 | +| 描述 | 如何处理最后一层数据，当其已用空间高于其dn_default_space_usage_threshold时。| | 类型 | String | | 默认值 | NULL | | 改后生效方式 | 热加载 | diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Basis-Function.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Basis-Function.md index 7a3699266..c2d312da6 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Basis-Function.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Basis-Function.md @@ -21,7 +21,7 @@ # 基础函数 -## 1 比较函数和运算符 +## 1. 比较函数和运算符 ### 1.1 基本比较运算符 @@ -120,7 +120,7 @@ SELECT * FROM table1 WHERE temperature IN (85.0, 90.0); SELECT * FROM table1 WHERE region NOT IN ('北京', '上海'); ``` -## 2 聚合函数 +## 2. 聚合函数 ### 2.1 概述 @@ -299,7 +299,7 @@ Total line number = 1 It costs 0.244s ``` -## 3 逻辑运算符 +## 3. 逻辑运算符 ### 3.1 概述 @@ -378,7 +378,7 @@ NOT NULL -- null | NULL | NULL | -## 4 日期和时间函数和运算符 +## 4. 日期和时间函数和运算符 ### 4.1 now() -> Timestamp @@ -621,7 +621,7 @@ Total line number = 18 It costs 0.319s ``` -## 5 数学函数和运算符 +## 5. 数学函数和运算符 ### 5.1 数学运算符 @@ -662,7 +662,7 @@ It costs 0.319s | e | 自然指数 | | double | e() | | pi | π | | double | pi() | -## 6 条件表达式 +## 6. 条件表达式 ### 6.1 CASE 表达式 @@ -722,7 +722,7 @@ SELECT a, b, coalesce(value1, value2[, ...]) ``` -## 7 转换函数 +## 7. 转换函数 ### 7.1 转换函数 @@ -755,7 +755,7 @@ SELECT * IN (try_cast('2024-11-27' AS DATE), try_cast('2024-11-28' AS DATE)); ``` -## 8 字符串函数和操作符 +## 8. 字符串函数和操作符 ### 8.1 字符串操作符 @@ -785,7 +785,7 @@ SELECT * | substring | 从指定位置提取字符到字符串末尾。需要注意的是，起始位置是基于字符而不是字节数组确定的。`start_index` 从 1 开始计数，长度从 `start_index` 位置计算。 | 支持两个参数**string**：要提取子字符串的源字符串，可以是字符串或文本类型。**start_index**：从哪个索引开始提取子字符串，索引从 1 开始计数。 | String：返回一个字符串，从 `start_index` 位置开始到字符串末尾的所有字符。**注意事项**：`start_index` 从 1 开始，即数组的第 0 个位置是 1参数为 null时，返回 `null`start_index 大于字符串长度时，结果报错。 | substring(string from start_index)或 substring(string, start_index) | | substring | 从一个字符串中提取从指定位置开始、指定长度的子字符串注意：起始位置和长度是基于字符而不是字节数组确定的。`start_index` 从 1 开始计数，长度从 `start_index` 位置计算。 | 支持三个参数**string**：要提取子字符串的源字符串，可以是字符串或文本类型。**start_index**：从哪个索引开始提取子字符串，索引从 1 开始计数。**length**：要提取的子字符串的长度。 | String：返回一个字符串，从 `start_index` 位置开始，提取 `length` 个字符。**注意事项**：参数为 null时，返回 `null`如果 `start_index` 大于字符串的长度，结果报错。如果 `length` 小于 0，结果报错。极端情况，`start_index + length` 超过 `int.MAX` 并变成负数，将导致异常结果。 | substring(string from start_index for length) 或 substring(string, start_index, length) | -## 9 模式匹配函数 +## 9. 模式匹配函数 ### 9.1 LIKE 运算符 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Featured-Functions.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Featured-Functions.md index cc8d96490..d4f9215f8 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Featured-Functions.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Featured-Functions.md @@ -21,7 +21,7 @@ # 特色函数 -## 1 时序特色函数 +## 1. 时序特色函数 ### 1.1 降采样函数 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Fill-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Fill-Clause.md index b61f74040..5bfaa241f 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Fill-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Fill-Clause.md @@ -21,13 +21,13 @@ # FILL 子句 -## 1 功能介绍 +## 1. 功能介绍 在执行数据查询时，可能会遇到某些列在某些行中没有数据，导致结果集中出现 NULL 值。这些 NULL 值不利于数据的可视化展示和分析，因此 IoTDB 提供了 FILL 子句来填充这些 NULL 值。 当查询中包含 ORDER BY 子句时，FILL 子句会在 ORDER BY 之前执行。而如果存在 GAPFILL（ date_bin_gapfill 函数）操作，则 FILL 子句会在 GAPFILL 之后执行。 -## 2 语法概览 +## 2. 语法概览 ```sql fillClause @@ -87,7 +87,7 @@ IoTDB 支持以下三种空值填充方式： 注意：对于数据类型不支持指定填充方法的列，既不进行填充，也不抛出异常，只是保持原样。 -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 @@ -305,7 +305,7 @@ Total line number = 7 It costs 0.073s ``` -## 4 高阶用法 +## 4. 高阶用法 使用 `PREVIOUS` 和 `LINEAR` FILL 时，还支持额外的 `FILL_GROUP` 参数，来进行分组内填充。 @@ -397,7 +397,7 @@ Total line number = 8 It costs 0.089s ``` -## 5 特别说明 +## 5. 特别说明 在使用 `LINEAR FILL` 或 `PREVIOUS FILL` 时，如果辅助时间列（用于确定填充逻辑的时间列）中存在 NULL 值，IoTDB 将遵循以下规则： diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/From-Join-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/From-Join-Clause.md index 3492401ac..b37633729 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/From-Join-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/From-Join-Clause.md @@ -21,7 +21,7 @@ # FROM & JOIN 子句 -## 1 语法概览 +## 1. 语法概览 ```sql FROM relation (',' relation)* @@ -60,11 +60,11 @@ qualifiedName ; ``` -## 2 FROM 子句 +## 2. FROM 子句 FROM 子句指定了查询操作的数据源。在逻辑上，查询的执行从 FROM 子句开始。FROM 子句可以包含单个表、使用 JOIN 子句连接的多个表的组合，或者子查询中的另一个 SELECT 查询。 -## 3 JOIN 子句 +## 3. JOIN 子句 JOIN 用于将两个表基于某些条件连接起来，通常，连接条件是一个谓词，但也可以指定其他隐含的规则。 @@ -115,7 +115,7 @@ SELECT selectExpr [, selectExpr] ... FROM [, ] ... [WHE 在当前版本的 IoTDB 中，只支持 FULL [OUTER] JOIN，即全外连接，返回左表和右表连接后的所有记录。如果某个表中的记录没有与另一个表中的记录匹配，则会返回 NULL 值。__FULL JOIN 只能使用显式连接方式。__ -## 4 示例数据 +## 4. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/GroupBy-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/GroupBy-Clause.md index 713dcff83..176d3e031 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/GroupBy-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/GroupBy-Clause.md @@ -21,7 +21,7 @@ # GROUP BY 子句 -## 1 语法概览 +## 1. 语法概览 ```sql GROUP BY expression (',' expression)* @@ -32,7 +32,7 @@ GROUP BY expression (',' expression)* ![](/img/groupby01.png) -## 2 注意事项 +## 2. 注意事项 - 在 SELECT 子句中的项必须包含聚合函数或由出现在 GROUP BY 子句中的列组成。 @@ -193,7 +193,7 @@ Total line number = 1 It costs 0.047s ``` -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Having-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Having-Clause.md index 383d9e770..d644321c1 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Having-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Having-Clause.md @@ -21,7 +21,7 @@ # HAVING 子句 -## 1 语法概览 +## 1. 语法概览 ```sql HAVING booleanExpression @@ -35,7 +35,7 @@ HAVING booleanExpression - 就语法而言，`HAVING`子句与`WHERE`子句相同，WHERE子句在分组聚合之前对数据进行过滤，HAVING子句是对分组聚合后的结果进行过滤。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Identifier.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Identifier.md index fcb5fa61c..49364d382 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Identifier.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Identifier.md @@ -23,7 +23,7 @@ 在 IoTDB 中，标识符用于标识 database、table、column、function 或其他对象名称。 -## 1 命名规则 +## 1. 命名规则 - __开头字符__：标识符必须以字母开头。 - __后续字符__：可以包含字母、数字和下划线。 @@ -50,7 +50,7 @@ table-name // 包含短横线 colum$name@field // 包含特殊字符且未用双引号括起 ``` -## 2 大小写敏感性 +## 2. 大小写敏感性 标识符不区分大小写，且系统存储标识符时不保留原始大小写，查询结果会根据用户在`SELECT`子句中指定的大小写显示列名。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Limit-Offset-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Limit-Offset-Clause.md index 30d950193..ebfb53d40 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Limit-Offset-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Limit-Offset-Clause.md @@ -21,7 +21,7 @@ # LIMIT 和 OFFSET 子句 -## 1 语法概览 +## 1. 语法概览 ```sql OFFSET INTEGER_VALUE LIMIT INTEGER_VALUE @@ -46,7 +46,7 @@ OFFSET 子句与 LIMIT 子句配合使用，用于指定查询结果跳过前 OF - 如果总记录数`n >= OFFSET+LIMIT`之和，返回`LIMIT`数量的记录。 - 如果总记录数`n < OFFSET+LIMIT`之和，返回从`OFFSET`开始到末尾的所有记录，最多`n-offset`条。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/OrderBy-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/OrderBy-Clause.md index aec9e0dfb..66cf55068 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/OrderBy-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/OrderBy-Clause.md @@ -21,7 +21,7 @@ # ORDER BY 子句 -## 1 语法概览 +## 1. 语法概览 ```sql ORDER BY sortItem (',' sortItem)* @@ -38,7 +38,7 @@ sortItem - 默认情况下， 将采用 ASC NULLS LAST排序，即值按升序排序，空值放在最后。可以通过手动指定其他参数更改默认排序顺序。 - ORDER BY 子句的执行顺序排在 LIMIT 或 OFFSET 子句之前。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Select-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Select-Clause.md index 78635e7da..ffc03f993 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Select-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Select-Clause.md @@ -21,7 +21,7 @@ # SELECT 子句 -## 1 语法概览 +## 1. 语法概览 ```sql SELECT selectItem (',' selectItem)* @@ -35,7 +35,7 @@ selectItem - __SELECT 子句__: 指定了查询结果应包含的列，包含聚合函数（如 SUM、AVG、COUNT 等）以及窗口函数，在逻辑上最后执行。 -## 2 语法详释： +## 2. 语法详释： 每个 `selectItem` 可以是以下形式之一： @@ -43,7 +43,7 @@ selectItem - __选择某个关系的所有列__: `relation.*` 选择某个关系的所有列，不允许使用列别名。 - __选择结果集中的所有列__: `*` 选择查询的所有列，不允许使用列别名。 -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 @@ -244,7 +244,7 @@ Total line number = 18 It costs 0.189s ``` -## 4 结果集列顺序 +## 4. 结果集列顺序 - __列顺序__: 结果集中的列顺序与 SELECT 子句中指定的顺序相同。 - __多列排序__: 如果选择表达式返回多个列，它们的排序方式与源关系中的排序方式相同 \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/Where-Clause.md b/src/zh/UserGuide/Master/Table/SQL-Manual/Where-Clause.md index 58c56b34b..a793d2746 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/Where-Clause.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/Where-Clause.md @@ -21,7 +21,7 @@ # WHERE 子句 -## 1 语法概览 +## 1. 语法概览 ```sql WHERE booleanExpression @@ -29,7 +29,7 @@ WHERE booleanExpression __WHERE 子句__:用于在 SQL 查询中指定筛选条件，WHERE 子句在 FROM 子句之后立即执行。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/Master/Table/SQL-Manual/overview.md b/src/zh/UserGuide/Master/Table/SQL-Manual/overview.md index 0a4b8e0d7..ea5a1a9cf 100644 --- a/src/zh/UserGuide/Master/Table/SQL-Manual/overview.md +++ b/src/zh/UserGuide/Master/Table/SQL-Manual/overview.md @@ -21,7 +21,7 @@ # 概览 -## 1 语法概览 +## 1. 语法概览 ```SQL SELECT ⟨select_list⟩ @@ -47,6 +47,7 @@ IoTDB 查询语法提供以下子句： - OFFSET 子句：用于指定查询结果的起始位置，即跳过前 OFFSET 行。与 LIMIT 子句配合使用。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) - LIMIT 子句：限制查询结果的行数，通常与 OFFSET 子句一起使用以实现分页功能。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) -## 2 子句执行顺序 +## 2. 子句执行顺序 + ![](/img/%E5%AD%90%E5%8F%A5%E6%89%A7%E8%A1%8C%E9%A1%BA%E5%BA%8F01.png) diff --git a/src/zh/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md b/src/zh/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md index 84eb33dbf..a375e55a8 100644 --- a/src/zh/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md +++ b/src/zh/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md @@ -23,7 +23,7 @@ 本文档介绍 IoTDB 中的分区策略和负载均衡策略。根据时序数据的特性，IoTDB 按序列和时间维度对其进行分区。结合序列分区与时间分区创建一个分区，作为划分的基本单元。为了提高吞吐量并降低管理成本，这些分区被均匀分配到分片（Region）中，分片是复制的基本单元。分片的副本决定了数据的存储位置，主副本负责主要负载的管理。在此过程中，副本放置算法决定哪些节点将持有分片副本，而主副本选择算法则指定哪个副本将成为主副本。 -## 1 分区策略和分区分配 +## 1. 分区策略和分区分配 IoTDB 为时间序列数据实现了量身定制的分区算法。在此基础上，缓存于配置节点和数据节点上的分区信息不仅易于管理，而且能够清晰区分冷热数据。随后，平衡的分区被均匀分配到集群的分片中，以实现存储均衡。 ### 1.1 分区策略 @@ -71,7 +71,7 @@ $$\text{RegionGroupNumber}=\left\lfloor\frac{\sum_{i=1}^{DataNodeNumber}\text{Re 值得注意的是，IoTDB 有效利用了时序数据的特性。当配置了 TTL（生存时间）时，IoTDB 可实现无需迁移的时序数据弹性存储，该功能在集群扩展时最小化了对在线操作的影响。上图展示了该功能的一个实例：新生成的数据分区被均匀分配到每个数据分片，过期数据会自动归档。因此，集群的存储最终将保持平衡。 -## 2 均衡策略 +## 2. 均衡策略 为了提高集群的可用性和性能，IoTDB 采用了精心设计的存储均衡和计算均衡算法。 ### 2.1 存储均衡 @@ -104,7 +104,7 @@ $$\text{RegionGroupNumber}=\left\lfloor\frac{\sum_{i=1}^{DataNodeNumber}\text{Re 为了解决这个问题，IoTDB 采用了一种主副本选择算法，能够持续平衡集群中的主副本分布。因此，集群实现了计算负载的均衡分布，确保了其性能。 -## 3 Source Code +## 3. Source Code + [数据分区](https://github.com/apache/iotdb/tree/master/iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/partition) + [分区分配](https://github.com/apache/iotdb/tree/master/iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/manager/load/balancer/partition) + [副本放置](https://github.com/apache/iotdb/tree/master/iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/manager/load/balancer/副本) diff --git a/src/zh/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md b/src/zh/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md index 2a4885b3d..103141827 100644 --- a/src/zh/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md +++ b/src/zh/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md @@ -21,7 +21,7 @@ # 编码和压缩 -## 1 编码方式 +## 1. 编码方式 ### 1.1 基本编码方式 @@ -97,7 +97,7 @@ IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN, ENCODIN Msg: 507: encoding TS_2DIFF does not support BOOLEAN ``` -## 2 压缩方式 +## 2. 压缩方式 当时间序列写入并按照指定的类型编码为二进制数据后，IoTDB 会使用压缩技术对该数据进行压缩，进一步提升空间存储效率。虽然编码和压缩都旨在提升存储效率，但编码技术通常只适合特定的数据类型（如二阶差分编码只适合与 INT32 或者 INT64 编码，存储浮点数需要先将他们乘以 10m 以转换为整数），然后将它们转换为二进制流。压缩方式（SNAPPY）针对二进制流进行压缩，因此压缩方式的使用不再受数据类型的限制。 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Benchmark.md b/src/zh/UserGuide/Master/Table/Tools-System/Benchmark.md index fc16a9b35..a0323e753 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Benchmark.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Benchmark.md @@ -21,7 +21,7 @@ # 测试工具 -## 1 基本概述 +## 1. 基本概述 IoT-benchmark 是基于 Java 和大数据环境开发的时序数据库基准测试工具，由清华大学软件学院研发并开源。它使用方便，支持多种写入以及查询方式，支持存储测试信息和结果以供进一步查询或分析，支持与 Tableau 集成以可视化测试结果。 @@ -53,7 +53,7 @@ IoT-benchmark 是基于 Java 和大数据环境开发的时序数据库基准测 表1-1大数据测试基准对比 -## 2 安装运行 +## 2. 安装运行 ### 2.1 前置条件 @@ -126,7 +126,7 @@ drwxr-xr-x. 2 root root 4096 1月 10 01:38 lib -## 3 主要参数 +## 3. 主要参数 ### 3.1 IoTDB服务模型 @@ -305,7 +305,7 @@ LOOP=50 DEVICE_NUMBER=20 TEST > tail -f log_info.log ``` -## 4 测试示例 +## 4. 测试示例 以IoTDB 2.0为例，使用IoT-Benchemark测试表模型写入及查询，修改IoT-Benchemark配置文件如下： diff --git a/src/zh/UserGuide/Master/Table/Tools-System/CLI.md b/src/zh/UserGuide/Master/Table/Tools-System/CLI.md index 36a5d5f0b..6ab0e9866 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/CLI.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/CLI.md @@ -25,7 +25,7 @@ IoTDB 为用户提供 CLI 工具用于和服务端程序进行交互操作。在 > 本文中 $IoTDB_HOME 表示 IoTDB 的安装目录所在路径。 -## 1 CLI 启动 +## 1. CLI 启动 CLI 客户端脚本是 $IoTDB_HOME/sbin 文件夹下的`start-cli`脚本。启动命令为： @@ -70,7 +70,7 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab ![](/img/Cli-01.png) -## 2 在 CLI 中执行语句 +## 2. 在 CLI 中执行语句 进入 CLI 后，用户可以直接在对话中输入 SQL 语句进行交互。如： @@ -92,11 +92,11 @@ show databases ![](/img/Cli-03.png) -## 3 CLI 退出 +## 3. CLI 退出 在 CLI 中输入`quit`或`exit`可退出 CLI 结束本次会话。 -## 4 其他说明 +## 4. 其他说明 CLI中使用命令小技巧： diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md b/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md index 9062be9fb..55d6828dc 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md @@ -21,7 +21,7 @@ # 集群管理工具 -## 1 数据文件夹概览工具 +## 1. 数据文件夹概览工具 IoTDB数据文件夹概览工具用于打印出数据文件夹的结构概览信息，工具位置为 tools/tsfile/print-iotdb-data-dir。 @@ -82,7 +82,7 @@ data dir num:1 |============================================================== ````````````````````````` -## 2 TsFile概览工具 +## 2. TsFile概览工具 TsFile概览工具用于以概要模式打印出一个TsFile的内容，工具位置为 tools/tsfile/print-tsfile。 @@ -170,7 +170,7 @@ file length: 2974 - "|||||||||||||||||||||"是为增强可读性而添加的导引信息，不是TsFile中实际存储的数据。 - 最后打印的"IndexOfTimerseriesIndex Tree"是对TsFile文件末尾的元数据索引树的重新整理打印，便于直观理解，不是TsFile中存储的实际数据。 -## 3 TsFile Resource概览工具 +## 3. TsFile Resource概览工具 TsFile resource概览工具用于打印出TsFile resource文件的内容，工具位置为 tools/tsfile/print-tsfile-resource-files。 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md b/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md index 74df81723..f31b5cfcf 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md @@ -21,7 +21,7 @@ # 集群管理工具 -## 1 集群管理工具 +## 1. 集群管理工具 IoTDB 集群管理工具是一款易用的运维工具（企业版工具）。旨在解决 IoTDB 分布式系统多节点的运维难题，主要包括集群部署、集群启停、弹性扩容、配置更新、数据导出等功能，从而实现对复杂数据库集群的一键式指令下发，极大降低管理难度。本文档将说明如何用集群管理工具远程部署、配置、启动和停止 IoTDB 集群实例。 @@ -805,7 +805,7 @@ iotdbctl cluster exportschema default_cluster -N datanode1 -param "-t ./ -pf ./p | default_3c3d.yaml | 3个confignode和3个datanode 配置样例 | | default_3c3d_grafa_prome | 3个confignode和3个datanode、Grafana、Prometheus配置样例 | -## 2 数据文件夹概览工具 +## 2. 数据文件夹概览工具 IoTDB数据文件夹概览工具用于打印出数据文件夹的结构概览信息，工具位置为 tools/tsfile/print-iotdb-data-dir。 @@ -866,7 +866,7 @@ data dir num:1 |============================================================== ````````````````````````` -## 3 TsFile概览工具 +## 3. TsFile概览工具 TsFile概览工具用于以概要模式打印出一个TsFile的内容，工具位置为 tools/tsfile/print-tsfile。 @@ -954,7 +954,7 @@ file length: 2974 - "|||||||||||||||||||||"是为增强可读性而添加的导引信息，不是TsFile中实际存储的数据。 - 最后打印的"IndexOfTimerseriesIndex Tree"是对TsFile文件末尾的元数据索引树的重新整理打印，便于直观理解，不是TsFile中存储的实际数据。 -## 4 TsFile Resource概览工具 +## 4. TsFile Resource概览工具 TsFile resource概览工具用于打印出TsFile resource文件的内容，工具位置为 tools/tsfile/print-tsfile-resource-files。 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md b/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md index c6e0eb6cb..902611942 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md @@ -24,7 +24,7 @@ 监控工具的部署可参考文档 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) 章节。 -## 1 监控指标的 Prometheus 映射关系 +## 1. 监控指标的 Prometheus 映射关系 > 对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射，其中 value 为具体值 @@ -36,7 +36,7 @@ | Rate | name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m1"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m5"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m15"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="mean"} value | | Timer | name_seconds_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value | -## 2 修改配置文件 +## 2. 修改配置文件 1) 以 DataNode 为例，修改 iotdb-system.properties 配置文件如下： @@ -60,7 +60,7 @@ file_count{name="seq",} 2.0 ... ``` -## 3 Prometheus + Grafana +## 3. Prometheus + Grafana 如上所示，IoTDB 对外暴露出标准的 Prometheus 格式的监控指标数据，可以使用 Prometheus 采集并存储监控指标，使用 Grafana 可视化监控指标。 @@ -102,7 +102,7 @@ static_configs: [Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus) -## 4 Apache IoTDB Dashboard +## 4. Apache IoTDB Dashboard `Apache IoTDB Dashboard`是 IoTDB 企业版的配套产品，支持统一集中式运维管理，可通过一个监控面板监控多个集群。你可以联系商务获取到 Dashboard 的 Json文件。 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_timecho.md b/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_timecho.md index 3b0fa3cc5..3eed71954 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_timecho.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Monitor-Tool_timecho.md @@ -24,7 +24,7 @@ 监控工具的部署可参考文档 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) 章节。 -## 1 监控指标的 Prometheus 映射关系 +## 1. 监控指标的 Prometheus 映射关系 > 对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射，其中 value 为具体值 @@ -36,7 +36,7 @@ | Rate | name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m1"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m5"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m15"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="mean"} value | | Timer | name_seconds_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value | -## 2 修改配置文件 +## 2. 修改配置文件 1) 以 DataNode 为例，修改 iotdb-system.properties 配置文件如下： @@ -60,7 +60,7 @@ file_count{name="seq",} 2.0 ... ``` -## 3 Prometheus + Grafana +## 3. Prometheus + Grafana 如上所示，IoTDB 对外暴露出标准的 Prometheus 格式的监控指标数据，可以使用 Prometheus 采集并存储监控指标，使用 Grafana 可视化监控指标。 @@ -102,7 +102,7 @@ static_configs: [Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus) -## 4 Apache IoTDB Dashboard +## 4. Apache IoTDB Dashboard 我们提供了Apache IoTDB Dashboard，支持统一集中式运维管理，可通过一个监控面板监控多个集群。 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 4843e88a1..20e2a316b 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 @@ -22,7 +22,7 @@ # 数据同步 数据同步是工业物联网的典型需求，通过数据同步机制，可实现 IoTDB 之间的数据共享，搭建完整的数据链路来满足内网外网数据互通、端边云同步、数据迁移、数据备份等需求。 -## 1 功能概述 +## 1. 功能概述 ### 1.1 数据同步 @@ -42,7 +42,7 @@ - 不支持 2.x 系列版本 IoTDB 数据同步到 1.x 系列版本版本的 IoTDB。 - 在进行数据同步任务时，请避免执行任何删除操作，防止两端状态不一致。 -## 2 使用说明 +## 2. 使用说明 数据同步任务有三种状态：RUNNING、STOPPED 和 DROPPED。任务状态转换如下图所示： @@ -204,7 +204,7 @@ IoTDB> SHOW PIPEPLUGINS
-## 3 使用示例 +## 3. 使用示例 ### 3.1 全量数据同步 diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md index b781b6a7b..fc65c8d9f 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md @@ -22,7 +22,7 @@ # 数据同步 数据同步是工业物联网的典型需求，通过数据同步机制，可实现 IoTDB 之间的数据共享，搭建完整的数据链路来满足内网外网数据互通、端边云同步、数据迁移、数据备份等需求。 -## 1 功能概述 +## 1. 功能概述 ### 1.1 数据同步 @@ -42,7 +42,7 @@ - 不支持 2.x 系列版本 IoTDB 数据同步到 1.x 系列版本版本的 IoTDB。 - 在进行数据同步任务时，请避免执行任何删除操作，防止两端状态不一致。 -## 2 使用说明 +## 2. 使用说明 数据同步任务有三种状态：RUNNING、STOPPED 和 DROPPED。任务状态转换如下图所示： @@ -209,7 +209,7 @@ IoTDB> SHOW PIPEPLUGINS -## 3 使用示例 +## 3. 使用示例 ### 3.1 全量数据同步 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 5453f2f3f..525a4bde1 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md @@ -20,7 +20,7 @@ --> # 运维语句 -## 1 状态查看 +## 1. 状态查看 ### 1.1 查看连接的模型 @@ -304,7 +304,7 @@ IoTDB> SHOW QUERIES WHERE elapsed_time > 30 +-----------------------+-----------------------------+-----------+------------+------------+----+ ``` -## 2 状态设置 +## 2. 状态设置 ### 2.1 设置连接的模型 @@ -444,7 +444,7 @@ IoTDB> SET SYSTEM TO READONLY ON CLUSTER; ``` -## 3 数据管理 +## 3. 数据管理 ### 3.1 刷写内存表中的数据到磁盘 @@ -535,7 +535,7 @@ localOrClusterMode IoTDB> CLEAR ALL CACHE ON LOCAL; ``` -## 4 数据修复 +## 4. 数据修复 ### 4.1 启动后台扫描并修复 tsfile 任务 @@ -599,7 +599,7 @@ localOrClusterMode IoTDB> STOP REPAIR DATA ON CLUSTER; ``` -## 5 终止查询 +## 5. 终止查询 ### 5.1 主动终止查询 diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Query-Performance-Analysis.md b/src/zh/UserGuide/Master/Table/User-Manual/Query-Performance-Analysis.md index 8ba60dff6..97fabd22d 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Query-Performance-Analysis.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Query-Performance-Analysis.md @@ -20,7 +20,7 @@ --> # 系统运维 -## 1 查询性能分析 +## 1. 查询性能分析 查询分析的意义在于帮助用户理解查询的执行机制和性能瓶颈，从而实现查询优化和性能提升。这不仅关乎到查询的执行效率，也直接影响到应用的用户体验和资源的有效利用。为了进行有效的查询分析，IoTDB 提供了查询分析语句：Explain 和 Explain Analyze。 diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md b/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md index 7e3d3bfce..1bc65232c 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md @@ -20,11 +20,11 @@ --> # 多级存储 -## 1 概述 +## 1. 概述 多级存储功能向用户提供多种存储介质管理的能力，用户可以使用多级存储功能为 IoTDB 配置不同类型的存储介质，并为存储介质进行分级。具体的，在 IoTDB 中，多级存储的配置体现为多目录的管理。用户可以将多个存储目录归为同一类，作为一个“层级”向 IoTDB 中配置，这种“层级”我们称之为 storage tier；同时，用户可以根据数据的冷热进行分类，并将不同类别的数据存储到指定的“层级”中。当前 IoTDB 支持通过数据的 TTL 进行冷热数据的分类，当一个层级中的数据不满足当前层级定义的 TTL 规则时，该数据会被自动迁移至下一层级中。 -## 2 参数定义 +## 2. 参数定义 在 IoTDB 中开启多级存储，需要进行以下几个方面的配置： @@ -49,7 +49,7 @@ | remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储，无需配置 | -## 3 本地多级存储配置示例 +## 3. 本地多级存储配置示例 以下以本地两级存储的配置示例。 @@ -67,7 +67,7 @@ dn_default_space_usage_thresholds=0.2;0.1 | 层级一 | 目录一：/data1/data | 最近 1 天的数据 | 20% | | 层级二 | 目录一：/data2/data目录二：/data3/data | 1 天以前的数据 | 10% | -## 4 远端多级存储配置示例 +## 4. 远端多级存储配置示例 以下以三级存储为例： diff --git a/src/zh/UserGuide/latest-Table/API/Programming-JDBC_apache.md b/src/zh/UserGuide/latest-Table/API/Programming-JDBC_apache.md index c5a1db5e0..7963e19c1 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-JDBC_apache.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-JDBC_apache.md @@ -21,7 +21,7 @@ # JDBC接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互，允许用户通过Java程序执行SQL语句来管理数据库和时间序列数据。它支持数据库的连接、创建、查询、更新和删除操作，以及时间序列数据的批量插入和查询。 @@ -29,7 +29,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 对于Java应用，我们推荐使用Java 原生接口。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -48,7 +48,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 功能说明 @@ -68,7 +68,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 | ResultSet.next() | 移动到结果集的下一行 | 无 | boolean: 是否成功移动到下一行 | | ResultSet.getString(int columnIndex) | 获取指定列的字符串值 | columnIndex: 列索引（从1开始） | String: 列的字符串值 | -## 4 示例代码 +## 4. 示例代码 **注意：使用表模型，必须在 url 中指定 sql_dialect 参数为 table。** diff --git a/src/zh/UserGuide/latest-Table/API/Programming-JDBC_timecho.md b/src/zh/UserGuide/latest-Table/API/Programming-JDBC_timecho.md index c5b57096e..cbca0f5da 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-JDBC_timecho.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-JDBC_timecho.md @@ -21,7 +21,7 @@ # JDBC接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互，允许用户通过Java程序执行SQL语句来管理数据库和时间序列数据。它支持数据库的连接、创建、查询、更新和删除操作，以及时间序列数据的批量插入和查询。 @@ -29,7 +29,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 对于Java应用，我们推荐使用Java 原生接口。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -48,7 +48,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 功能说明 @@ -68,7 +68,7 @@ IoTDB JDBC接口提供了一种标准的方式来与IoTDB数据库进行交互 | ResultSet.next() | 移动到结果集的下一行 | 无 | boolean: 是否成功移动到下一行 | | ResultSet.getString(int columnIndex) | 获取指定列的字符串值 | columnIndex: 列索引（从1开始） | String: 列的字符串值 | -## 4 示例代码 +## 4. 示例代码 **注意：使用表模型，必须在 url 中指定 sql_dialect 参数为 table。** diff --git a/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md b/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md index e390a4be8..212bb59cc 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md @@ -21,11 +21,11 @@ # Java Session原生接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接口，可以直接组装时序对象进行写入，无需拼装 SQL。推荐使用连接池，多线程并行操作数据库。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -44,7 +44,7 @@ IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 ITableSession接口 @@ -348,7 +348,7 @@ public class TableSessionBuilder { } ``` -## 4 客户端连接池 +## 4. 客户端连接池 ### 4.1 ITableSessionPool 接口 @@ -627,7 +627,7 @@ public class TableSessionPoolBuilder { } ``` -## 5 示例代码 +## 5. 示例代码 Session 示例代码：[src/main/java/org/apache/iotdb/TableModelSessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/TableModelSessionExample.java) diff --git a/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_timecho.md b/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_timecho.md index e97273103..05acee956 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_timecho.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_timecho.md @@ -21,11 +21,11 @@ # Java Session原生接口 -## 1 功能介绍 +## 1. 功能介绍 IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接口，可以直接组装时序对象进行写入，无需拼装 SQL。推荐使用连接池，多线程并行操作数据库。 -## 2 使用方式 +## 2. 使用方式 **环境要求:** @@ -44,7 +44,7 @@ IoTDB具备Java原生客户端驱动和对应的连接池，提供对象化接 ``` -## 3 读写操作 +## 3. 读写操作 ### 3.1 ITableSession接口 @@ -348,7 +348,7 @@ public class TableSessionBuilder { } ``` -## 4 客户端连接池 +## 4. 客户端连接池 ### 4.1 ITableSessionPool 接口 @@ -627,7 +627,7 @@ public class TableSessionPoolBuilder { } ``` -## 5 示例代码 +## 5. 示例代码 Session 示例代码：[src/main/java/org/apache/iotdb/TableModelSessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/TableModelSessionExample.java) diff --git a/src/zh/UserGuide/latest-Table/API/Programming-Python-Native-API.md b/src/zh/UserGuide/latest-Table/API/Programming-Python-Native-API.md index 28f92880a..05e5e0a15 100644 --- a/src/zh/UserGuide/latest-Table/API/Programming-Python-Native-API.md +++ b/src/zh/UserGuide/latest-Table/API/Programming-Python-Native-API.md @@ -21,7 +21,7 @@ # Python 原生接口 -## 1 使用方式 +## 1. 使用方式 安装依赖包: @@ -29,7 +29,7 @@ pip3 install apache-iotdb ``` -## 2 读写操作 +## 2. 读写操作 ### 2.1 TableSession @@ -168,7 +168,7 @@ class TableSessionConfig(object): 在使用完 TableSession 后，务必调用 close 方法来释放资源。 -## 3 客户端连接池 +## 3. 客户端连接池 ### 3.1 TableSessionPool @@ -287,7 +287,7 @@ class TableSessionPoolConfig(object): """ ``` -## 4 示例代码 +## 4. 示例代码 Session示例代码:[iotdb/blob/master/iotdb-client/client-py/table_model_session_example.py](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/table_model_session_example.py) diff --git a/src/zh/UserGuide/latest-Table/API/RestServiceV1.md b/src/zh/UserGuide/latest-Table/API/RestServiceV1.md index ba4062ca8..268961e83 100644 --- a/src/zh/UserGuide/latest-Table/API/RestServiceV1.md +++ b/src/zh/UserGuide/latest-Table/API/RestServiceV1.md @@ -23,7 +23,7 @@ IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 -## 1 开启 RESTful 服务 +## 1. 开启 RESTful 服务 Restful 服务默认情况是关闭的，开启 restful 功能需要找到 IoTDB 安装目录下的`conf/iotdb-system.properties`文件，将 `enable_rest_service` 设置为 `true` ，然后重启 datanode 进程。 @@ -31,7 +31,7 @@ Restful 服务默认情况是关闭的，开启 restful 功能需要找到 IoTDB enable_rest_service=true ``` -## 2 鉴权 +## 2. 鉴权 除了检活接口 `/ping`，restful服务使用了基础（basic）鉴权，每次 URL 请求都需要在 header 中携带 `'Authorization':'Basic' + base64.encode(username + ':' + password)`。 @@ -57,7 +57,7 @@ Authorization : Basic cm9vdDpyb290 {"code":800,"message":"INIT_AUTH_ERROR"} ``` -## 3 接口定义 +## 3. 接口定义 ### 3.1 ping @@ -251,7 +251,7 @@ curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290" -X ``` -## 4 配置 +## 4. 配置 配置文件位于 `iotdb-system.properties` 中。 diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md index ff3ff2727..f55d381db 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md @@ -21,7 +21,7 @@ # 常见概念 -## 1 数据模型相关概念 +## 1. 数据模型相关概念 ### 1.1 数据模型（sql_dialect） @@ -48,7 +48,7 @@ IoTDB 支持两种时序数据模型（SQL语法），管理的对象均为设 IoTDB 在数据编码后，使用压缩技术进一步压缩二进制数据，提升存储效率。IoTDB 支持多种压缩方法，详细信息请查看：[压缩和编码](../Technical-Insider/Encoding-and-Compression.md)。 -## 2 分布式相关概念 +## 2. 分布式相关概念 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： @@ -89,7 +89,7 @@ IoTDB 集群包括三种节点（进程）：ConfigNode（管理节点），Data | 数据 | data_replication_factor | 1 | 2 | -## 3 部署相关概念 +## 3. 部署相关概念 IoTDB 有两种运行模式：单机模式、集群模式。 diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md index 1a4de58e5..33a7b567f 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md @@ -21,7 +21,7 @@ # 常见概念 -## 1 数据模型相关概念 +## 1. 数据模型相关概念 ### 1.1 数据模型（sql_dialect） @@ -48,7 +48,7 @@ IoTDB 支持两种时序数据模型（SQL语法），管理的对象均为设 IoTDB 在数据编码后，使用压缩技术进一步压缩二进制数据，提升存储效率。IoTDB 支持多种压缩方法，详细信息请查看：[压缩和编码](../Technical-Insider/Encoding-and-Compression.md)。 -## 2 分布式相关概念 +## 2. 分布式相关概念 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： @@ -89,7 +89,7 @@ IoTDB 集群包括三种节点（进程）：ConfigNode（管理节点），Data | 数据 | data_replication_factor | 1 | 2 | -## 3 部署相关概念 +## 3. 部署相关概念 IoTDB 有三种运行模式：单机模式、集群模式和双活模式。 diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md index 377f3182c..e690f1311 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -23,11 +23,11 @@ 本章节主要介绍如何将时序数据应用场景转化为IoTDB时序建模。 -## 1 时序数据模型 +## 1. 时序数据模型 在构建IoTDB建模方案前，需要先了解时序数据和时序数据模型，详细内容见此页面：[时序数据模型](../Background-knowledge/Navigating_Time_Series_Data.md) -## 2 IoTDB 的两种时序模型 +## 2. IoTDB 的两种时序模型 IoTDB 提供了两种数据建模方式——树模型和表模型，其特点分别如下： @@ -80,7 +80,7 @@ IoTDB 提供了两种数据建模方式——树模型和表模型，其特点 - 在通过客户端工具 Cli 或 SDK 建立数据库连接时，需要通过 sql_dialect 参数指定使用的模型语法（默认使用树语法进行操作）。 -## 3 应用场景 +## 3. 应用场景 应用场景主要包括两类： diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md index 5a41c8909..d5c424bc7 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -23,11 +23,11 @@ 本章节主要介绍如何将时序数据应用场景转化为IoTDB时序建模。 -## 1 时序数据模型 +## 1. 时序数据模型 在构建IoTDB建模方案前，需要先了解时序数据和时序数据模型，详细内容见此页面：[时序数据模型](../Background-knowledge/Navigating_Time_Series_Data.md) -## 2 IoTDB 的两种时序模型 +## 2. IoTDB 的两种时序模型 IoTDB 提供了两种数据建模方式——树模型和表模型，其特点分别如下： @@ -80,7 +80,7 @@ IoTDB 提供了两种数据建模方式——树模型和表模型，其特点 - 在通过客户端工具 Cli 或 SDK 建立数据库连接时，需要通过 sql_dialect 参数指定使用的模型语法（默认使用树语法进行操作）。 -## 3 应用场景 +## 3. 应用场景 应用场景主要包括三类： diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Type.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Type.md index 4e043651a..35f8a971e 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Type.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Data-Type.md @@ -21,7 +21,7 @@ # 数据类型 -## 1 基本数据类型 +## 1. 基本数据类型 IoTDB 支持以下十种数据类型： @@ -70,7 +70,7 @@ CREATE TIMESERIES root.vehicle.d0.s0 WITH DATATYPE=FLOAT, ENCODING=RLE, 'MAX_POI | TIMESTAMP | INT32 INT64 TIMESTAMP | | DATE | DATE | -## 2 时间戳类型 +## 2. 时间戳类型 时间戳是一个数据到来的时间点，其中包括绝对时间戳和相对时间戳。 diff --git a/src/zh/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md b/src/zh/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md index 49d9edfb2..f965eb055 100644 --- a/src/zh/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/zh/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md @@ -20,7 +20,7 @@ --> # 时序数据模型 -## 1 什么叫时序数据？ +## 1. 什么叫时序数据？ 万物互联的今天，物联网场景、工业场景等各类场景都在进行数字化转型，人们通过在各类设备上安装传感器对设备的各类状态进行采集。如电机采集电压、电流，风机的叶片转速、角速度、发电功率；车辆采集经纬度、速度、油耗；桥梁的振动频率、挠度、位移量等。传感器的数据采集，已经渗透在各个行业中。 @@ -33,7 +33,7 @@ 传感器产生的海量时序数据是各行各业数字化转型的基础，因此我们对时序数据的模型梳理主要围绕设备、传感器展开。 -## 2 时序数据中的关键概念有哪些？ +## 2. 时序数据中的关键概念有哪些？ 时序数据中主要涉及的概念如下。 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management.md index 09ffa43b4..be6b7972a 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Database-Management.md @@ -21,7 +21,7 @@ # 数据库管理 -## 1 数据库管理 +## 1. 数据库管理 ### 1.1 创建数据库 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Delete-Data.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Delete-Data.md index fdd45cc15..dce9c095c 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Delete-Data.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Delete-Data.md @@ -21,7 +21,7 @@ # 数据删除 -## 1 数据删除： +## 1. 数据删除： 数据删除可以通过 delete 语句来完成，其中可以通过指定标签和时间的过滤条件来删除部分数据。 @@ -92,7 +92,7 @@ DELETE FROM table1 DELETE FROM table1 WHERE model_id = 'B' ``` -## 2 设备删除： +## 2. 设备删除： 当一个设备写入后，在 IoTDB 中即保留了其元数据，数据删除语句无法删除设备的元数据，可以使用设备删除语句删除设备的所有数据和元数据。 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Query-Data.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Query-Data.md index 40180ce77..0468da5a5 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Query-Data.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Query-Data.md @@ -21,7 +21,7 @@ # 数据查询 -## 1 语法概览 +## 1. 语法概览 ```SQL SELECT ⟨select_list⟩ @@ -47,13 +47,13 @@ IoTDB 查询语法提供以下子句： - OFFSET 子句：用于指定查询结果的起始位置，即跳过前 OFFSET 行。与 LIMIT 子句配合使用。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) - LIMIT 子句：限制查询结果的行数，通常与 OFFSET 子句一起使用以实现分页功能。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) -## 2 子句执行顺序 +## 2. 子句执行顺序 ![](/img/%E5%AD%90%E5%8F%A5%E6%89%A7%E8%A1%8C%E9%A1%BA%E5%BA%8F01.png) -## 3 常见查询示例 +## 3. 常见查询示例 ### 3.1 示例数据 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md b/src/zh/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md index 79d484945..38ea245f5 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md @@ -21,7 +21,7 @@ # 过期自动删除（TTL） -## 1 概览 +## 1. 概览 IoTDB支持表级的数据自动过期删除（TTL）设置，允许系统自动定期删除旧数据，以有效控制磁盘空间并维护高性能查询和低内存占用。TTL默认以毫秒为单位，数据过期后不可查询且禁止写入，但物理删除会延迟至压缩时。需注意，TTL变更可能导致短暂数据可查询性变化。 @@ -31,7 +31,7 @@ IoTDB支持表级的数据自动过期删除（TTL）设置，允许系统自动 2. TTL变更可能影响数据的可查询性。 3. 系统最终会移除过期数据，但存在延迟。 -## 2 设置 TTL +## 2. 设置 TTL 在表模型中，IoTDB 的 TTL 是按照表的粒度生效的。可以直接在表上设置 TTL，或者在数据库级别设置 TTL。当在数据库级别设置了TTL时，在创建新表的过程中，系统会自动采用这个TTL值作为新表的默认设置，但每个表仍然可以独立地被设置或覆盖该值。 @@ -89,7 +89,7 @@ use db CREATE TABLE test3 ("场站" string id, "温度" int32) with (ttl='INF') ``` -## 3 取消 TTL +## 3. 取消 TTL 取消 TTL 设置，可以修改表的 TTL 设置为 'INF'。目前，IoTDB 不支持修改数据库的 TTL。 @@ -97,7 +97,7 @@ CREATE TABLE test3 ("场站" string id, "温度" int32) with (ttl='INF') ALTER TABLE tableB set properties TTL='INF' ``` -## 4 查看 TTL 信息 +## 4. 查看 TTL 信息 使用 "SHOW DATABASES" 和 "SHOW TABLES" 命令可以直接显示数据库和表的 TTL 详情。数据库和表管理语句详情可见：[数据库管理](../Basic-Concept/Database-Management.md)、[表管理](../Basic-Concept/Table-Management.md) diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Table-Management.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Table-Management.md index 9b6dede6a..c2b59707a 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Table-Management.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Table-Management.md @@ -21,7 +21,7 @@ # 表管理 -## 1 表管理 +## 1. 表管理 ### 1.1 创建表 diff --git a/src/zh/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md b/src/zh/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md index 5f4ece0b5..4e9da1282 100644 --- a/src/zh/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md +++ b/src/zh/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md @@ -21,7 +21,7 @@ # 数据写入&更新 -## 1 数据写入 +## 1. 数据写入 ### 1.1 语法 @@ -178,7 +178,7 @@ values - 如果在 SQL 语句中引用了表中不存在的列，IoTDB 将返回错误码 `COLUMN_NOT_EXIST(616)`。 - 如果写入的数据类型与表中列的数据类型不一致，将报错 `DATA_TYPE_MISMATCH(507)`。 -## 2 数据更新 +## 2. 数据更新 ### 2.1 语法 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 6764698b6..34c25defb 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -26,7 +26,7 @@ -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 @@ -52,12 +52,12 @@ 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考：[监控面板部署](./Monitoring-panel-deployment.md) -## 2 准备步骤 +## 2. 准备步骤 1. 准备IoTDB数据库安装包 ：apache-iotdb-{version}-all-bin.zip（安装包获取见：[链接](../Deployment-and-Maintenance/IoTDB-Package_apache.md)） 2. 按环境要求配置好操作系统环境（系统环境配置见：[链接](../Deployment-and-Maintenance/Environment-Requirements.md)） -## 3 安装步骤 +## 3. 安装步骤 假设现在有3台linux服务器，IP地址和服务角色分配如下： @@ -160,7 +160,7 @@ cd sbin ![](/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -## 4 节点维护步骤 +## 4. 节点维护步骤 ### 4.1 ConfigNode节点维护 @@ -268,7 +268,7 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` -## 5 常见问题 +## 5. 常见问题 1. Confignode节点启动失败 - 步骤 1: 请查看启动日志，检查是否修改了某些首次启动后不可改的参数。 @@ -297,7 +297,7 @@ sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ```shell cd /data/iotdb rm -rf data logs ``` -## 6 附录 +## 6. 附录 ### 6.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 1c82999b7..7be498f0e 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -26,7 +26,7 @@ -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 @@ -52,12 +52,12 @@ 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考：[监控面板部署](./Monitoring-panel-deployment.md) -## 2 准备步骤 +## 2. 准备步骤 1. 准备IoTDB数据库安装包 ：timechodb-{version}-bin.zip（安装包获取见：[链接](./IoTDB-Package_timecho.md)） 2. 按环境要求配置好操作系统环境（系统环境配置见：[链接](./Environment-Requirements.md)） -## 3 安装步骤 +## 3. 安装步骤 假设现在有3台linux服务器，IP地址和服务角色分配如下： @@ -220,7 +220,7 @@ cd sbin ![](/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -## 4 节点维护步骤 +## 4. 节点维护步骤 ### 4.1 ConfigNode节点维护 @@ -328,7 +328,7 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` -## 5 常见问题 +## 5. 常见问题 1. 部署过程中多次提示激活失败 - 使用 `ls -al` 命令：使用 `ls -al` 命令检查安装包根目录的所有者信息是否为当前用户。 @@ -360,7 +360,7 @@ sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] ```shell cd /data/iotdb rm -rf data logs ``` -## 6 附录 +## 6. 附录 ### 6.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Database-Resources.md index fe6133025..cf3cf0af0 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Database-Resources.md @@ -20,7 +20,7 @@ --> # 资源规划 -## 1 CPU +## 1. CPU @@ -82,7 +82,7 @@
-## 2 内存 +## 2. 内存 @@ -144,7 +144,7 @@
-## 3 存储(磁盘) +## 3. 存储(磁盘) ### 3.1 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） @@ -190,11 +190,11 @@ - 简版计算公式：1000 * 100 * 12 * 86400 * 365 * 3 / 10 / 1024 / 1024 / 1024 / 1024 = 11T ### 3.2 存储配置 1000w 点位以上或查询负载较大，推荐配置 SSD。 -## 4 网络（网卡） +## 4. 网络（网卡） 在写入吞吐不超过1000万点/秒时，需配置千兆网卡；当写入吞吐超过 1000万点/秒时，需配置万兆网卡。 | **写入吞吐（数据点/秒）** | **网卡速率** | | ------------------- | ------------- | | <1000万 | 1Gbps（千兆） | | >=1000万 | 10Gbps（万兆） | -## 5 其他说明 +## 5. 其他说明 IoTDB 具有集群秒级扩容能力，扩容节点数据可不迁移，因此您无需担心按现有数据情况估算的集群能力有限，未来您可在需要扩容时为集群加入新的节点。 \ No newline at end of file diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_apache.md index 984b5fb3d..f6a913807 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_apache.md @@ -22,7 +22,7 @@ IoTDB 有两种运行模式：单机模式、集群模式。 -## 1 单机模式 +## 1. 单机模式 IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； @@ -30,7 +30,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限或对高可用要求不高的场景，例如边缘端服务器。 - **部署方法**：[单机版部署](../Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md) -## 2 集群模式 +## 2. 集群模式 IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 个 DataNode，即3C3D；当部分节点出现故障时，剩余节点仍然能对外提供服务，保证数据库服务的高可用性，且可随节点增加提升数据库性能。 @@ -38,7 +38,7 @@ IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 - **适用场景**：需要提供高可用和可靠性的企业级应用场景。 - **部署方法**：[集群版部署](../Deployment-and-Maintenance/Cluster-Deployment_apache.md) -## 3 特点总结 +## 3. 特点总结 | 维度 | 单机模式 | 集群模式 | | ------------ | ---------------------------- | ------------------------ | diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_timecho.md index d4a78a6b5..d49674d07 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_timecho.md @@ -22,7 +22,7 @@ IoTDB 有三种运行模式：单机模式、集群模式和双活模式。 -## 1 单机模式 +## 1. 单机模式 IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； @@ -30,7 +30,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限或对高可用要求不高的场景，例如边缘端服务器。 - **部署方法**：[单机版部署](../Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md) -## 2 双活模式 +## 2. 双活模式 双活版部署为 TimechoDB 企业版功能，是指两个独立的实例进行双向同步，能同时对外提供服务。当一台停机重启后，另一个实例会将缺失数据断点续传。 @@ -40,7 +40,7 @@ IoTDB单机实例包括 1 个ConfigNode、1个DataNode，即1C1D； - **适用场景**：资源有限（仅有两台服务器），但希望获得高可用能力。 - **部署方法**：[双活版部署](../Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md) -## 3 集群模式 +## 3. 集群模式 IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 个 DataNode，即3C3D；当部分节点出现故障时，剩余节点仍然能对外提供服务，保证数据库服务的高可用性，且可随节点增加提升数据库性能。 @@ -48,7 +48,7 @@ IoTDB 集群实例为 3 个ConfigNode 和不少于 3 个 DataNode，通常为 3 - **适用场景**：需要提供高可用和可靠性的企业级应用场景。 - **部署方法**：[集群版部署](../Deployment-and-Maintenance/Cluster-Deployment_timecho.md) -## 4 特点总结 +## 4. 特点总结 | 维度 | 单机模式 | 双活模式 | 集群模式 | | ------------ | ---------------------------- | ------------------------ | ------------------------ | diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_apache.md index 0d9e90aee..f0a0a79be 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_apache.md @@ -20,7 +20,7 @@ --> # Docker部署 -## 1 环境准备 +## 1. 环境准备 ### 1.1 Docker安装 @@ -53,7 +53,7 @@ ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose docker-compose --version #显示版本信息即安装成功 ``` -## 2 单机版 +## 2. 单机版 本节演示如何部署1C1D的docker单机版。 @@ -197,7 +197,7 @@ docker cp iotdb:/iotdb/conf /docker-iotdb/iotdb/conf docker-compose -f docker-compose-standalone.yml up -d ``` -## 3 集群版 +## 3. 集群版 本小节描述如何手动部署包括3个ConfigNode和3个DataNode的实例，即通常所说的3C3D集群。 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md index cfd708fdb..84af4fd6e 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Docker-Deployment_timecho.md @@ -20,7 +20,7 @@ --> # Docker部署 -## 1 环境准备 +## 1. 环境准备 ### 1.1 Docker安装 @@ -67,7 +67,7 @@ dmidecode 安装后，查找安装路径：`whereis dmidecode`，这里假设结 关于IoTDB企业版的容器镜像您可联系商务或技术支持获取。 -## 2 单机版部署 +## 2. 单机版部署 本节演示如何部署1C1D的docker单机版。 @@ -239,7 +239,7 @@ docker cp iotdb:/iotdb/conf /docker-iotdb/iotdb/conf docker-compose -f docker-compose-standalone.yml up -d ``` -## 3 集群版部署 +## 3. 集群版部署 本小节描述如何手动部署包括3个ConfigNode和3个DataNode的实例，即通常所说的3C3D集群。 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md index c80815100..c1e36dd5e 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md @@ -20,7 +20,7 @@ --> # 双活版部署 -## 1 什么是双活版？ +## 1. 什么是双活版？ 双活通常是指两个独立的单机(或集群)，实时进行镜像同步，它们的配置完全独立，可以同时接收外界的写入，每一个独立的单机(或集群)都可以将写入到自己的数据同步到另一个单机(或集群)中，两个单机(或集群)的数据可达到最终一致。 @@ -30,7 +30,7 @@ ![](/img/%E5%8F%8C%E6%B4%BB%E5%90%8C%E6%AD%A5.png) -## 2 注意事项 +## 2. 注意事项 1. 部署时推荐优先使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在目标服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的`cn_internal_address`、`dn_internal_address`。 @@ -42,7 +42,7 @@ 3. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系商务获取，部署监控面板步骤可以参考[文档](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 3 安装步骤 +## 3. 安装步骤 我们以两台单机A和B构建的双活版IoTDB为例，A和B的ip分别是192.168.1.3 和 192.168.1.4 ，这里用hostname来表示不同的主机，规划如下： diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md index 760f8329c..41e635f11 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -20,7 +20,7 @@ --> # 系统配置 -## 1 磁盘阵列 +## 1. 磁盘阵列 ### 1.1 配置建议 @@ -77,7 +77,7 @@ IoTDB对磁盘阵列配置没有严格运行要求，推荐使用多个磁盘阵 | 数据盘 | RAID5 | 7 | 允许坏1块 | 6 | | 数据盘 | NoRaid | 1 | 损坏丢失 | 1 | -## 2 操作系统 +## 2. 操作系统 ### 2.1 版本要求 @@ -192,7 +192,7 @@ echo "* hard nofile 65535" >> /etc/security/limits.conf ulimit -n ``` -## 3 软件依赖 +## 3. 软件依赖 安装 Java 运行环境 ，Java 版本 >= 1.8，请确保已设置 jdk 环境变量。（V1.3.2.2 及之上版本推荐直接部署JDK17，老版本JDK部分场景下性能有问题，且datanode会出现stop不掉的问题） diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_apache.md index e3f14a95d..c98ba8316 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_apache.md @@ -19,11 +19,11 @@ --> # 安装包获取 -## 1 安装包获取方式 +## 1. 安装包获取方式 安装包可直接在Apache IoTDB官网获取：https://iotdb.apache.org/zh/Download/ -## 2 安装包结构 +## 2. 安装包结构 解压后安装包（`apache-iotdb--all-bin.zip`），安装包解压后目录结构如下： diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md index 23758abf0..c5d5251f4 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/IoTDB-Package_timecho.md @@ -19,11 +19,11 @@ --> # 安装包获取 -## 1 获取方式 +## 1. 获取方式 企业版安装包可通过产品试用申请，或直接联系与您对接的工作人员获取。 -## 2 安装包结构 +## 2. 安装包结构 安装包解压后目录结构如下： diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md index 05c7bdbe9..14b1e29e5 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Monitoring-panel-deployment.md @@ -22,12 +22,12 @@ IoTDB配套监控面板是IoTDB企业版配套工具之一。它旨在解决IoTDB及其所在操作系统的监控问题，主要包括：操作系统资源监控、IoTDB性能监控，及上百项内核监控指标，从而帮助用户监控集群健康状态，并进行集群调优和运维。本文将以常见的3C3D集群(3个Confignode和3个Datanode)为例，为您介绍如何在IoTDB的实例中开启系统监控模块，并且使用Prometheus + Grafana的方式完成对系统监控指标的可视化。 -## 1 安装准备 +## 1. 安装准备 1. 安装 IoTDB：需先安装IoTDB V1.0 版本及以上企业版，您可联系商务或技术支持获取 2. 获取 IoTDB 监控面板安装包：基于企业版 IoTDB 的数据库监控面板，您可联系商务或技术支持获取 -## 2 安装步骤 +## 2. 安装步骤 ### 步骤一：IoTDB开启监控指标采集 @@ -184,7 +184,7 @@ cd grafana-* ![](/img/%E9%9D%A2%E6%9D%BF%E6%B1%87%E6%80%BB.png) -## 3 附录、监控指标详解 +## 3. 附录、监控指标详解 ### 3.1 系统面板（System Dashboard） diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md index 0a248dff4..4499bbd69 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md @@ -22,7 +22,7 @@ 本章将介绍如何启动IoTDB单机实例，IoTDB单机实例包括 1 个ConfigNode 和1个DataNode（即通常所说的1C1D）。 -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 2. 推荐使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的 `cn_internal_address`、`dn_internal_address`。 @@ -40,7 +40,7 @@ - 避免使用 sudo：使用 sudo 命令会以 root 用户权限执行命令，可能会引起权限混淆或安全问题。 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系工作人员获取，部署监控面板步骤可以参考：[监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 安装步骤 +## 2. 安装步骤 ### 2.1 解压安装包并进入安装目录 @@ -122,7 +122,7 @@ DataNode 配置 ![](/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -## 3 常见问题 +## 3. 常见问题 1. Confignode节点启动失败 - 步骤 1: 请查看启动日志，检查是否修改了某些首次启动后不可改的参数。 @@ -151,7 +151,7 @@ DataNode 配置 cd /data/iotdb rm -rf data logs ``` -## 4 附录 +## 4. 附录 ### 4.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md index 095303c23..70542c894 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md @@ -22,7 +22,7 @@ 本章将介绍如何启动IoTDB单机实例，IoTDB单机实例包括 1 个ConfigNode 和1个DataNode（即通常所说的1C1D）。 -## 1 注意事项 +## 1. 注意事项 1. 安装前请确认系统已参照[系统配置](../Deployment-and-Maintenance/Environment-Requirements.md)准备完成。 2. 推荐使用`hostname`进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在服务器上配置`/etc/hosts`，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的 `cn_internal_address`、`dn_internal_address`。 @@ -40,7 +40,7 @@ - 避免使用 sudo：使用 sudo 命令会以 root 用户权限执行命令，可能会引起权限混淆或安全问题。 6. 推荐部署监控面板，可以对重要运行指标进行监控，随时掌握数据库运行状态，监控面板可以联系工作人员获取，部署监控面板步骤可以参考：[监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 安装步骤 +## 2. 安装步骤 ### 2.1 解压安装包并进入安装目录 @@ -176,7 +176,7 @@ IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOM ![](/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -## 3 常见问题 +## 3. 常见问题 1. 部署过程中多次提示激活失败 - 使用 `ls -al` 命令：使用 `ls -al` 命令检查安装包根目录的所有者信息是否为当前用户。 @@ -208,7 +208,7 @@ IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOM cd /data/iotdb rm -rf data logs ``` -## 4 附录 +## 4. 附录 ### 4.1 Confignode节点参数介绍 diff --git a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md index d7fdda7f1..8f87ff99d 100644 --- a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -30,7 +30,7 @@ Apache IoTDB 是一款低成本、高性能的物联网原生时序数据库。 - 安装部署与使用文档：[快速上手](../QuickStart/QuickStart.md) -## 1 产品体系 +## 1. 产品体系 IoTDB 体系由若干个组件构成，帮助用户高效地管理和分析物联网产生的海量时序数据。 @@ -44,13 +44,13 @@ IoTDB 体系由若干个组件构成，帮助用户高效地管理和分析物 2. **时序数据标准文件格式（Apache TsFile）**：该文件格式是一种专为时序数据设计的存储格式，可以高效地存储和查询海量时序数据。目前 IoTDB、AINode 等模块的底层存储文件均由 Apache TsFile 进行支撑。通过 TsFile，用户可以在采集、管理、应用&分析阶段统一使用相同的文件格式进行数据管理，极大简化了数据采集到分析的整个流程，提高时序数据管理的效率和便捷度。 3. **时序模型训推一体化引擎（IoTDB AINode）**：针对智能分析场景，IoTDB 提供 AINode 时序模型训推一体化引擎，它提供了一套完整的时序数据分析工具，底层为模型训练引擎，支持训练任务与数据管理，与包括机器学习、深度学习等。通过这些工具，用户可以对存储在 IoTDB 中的数据进行深入分析，挖掘出其中的价值。 -## 2 TimechoDB 整体架构 +## 2. TimechoDB 整体架构 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： -## 3 产品特性 +## 3. 产品特性 Apache IoTDB 具备以下优势和特性： @@ -70,7 +70,7 @@ Apache IoTDB 具备以下优势和特性： - 丰富的生态环境对接：支持Hadoop、Spark等大数据生态系统组件对接，支持Grafana、Thingsboard、DataEase等设备管理和可视化工具 -## 4 商业版本 +## 4. 商业版本 天谋科技在 Apache IoTDB 开源版本的基础上提供了原厂商业化产品 TimechoDB，为企业、商业客户提供企业级产品和服务，它可以解决企业组建物联网大数据平台管理时序数据时所遇到的应用场景复杂、数据体量大、采样频率高、数据乱序多、数据处理耗时长、分析需求多样、存储与运维成本高等多种问题。 diff --git a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 8ecf2b001..aecb77043 100644 --- a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -27,7 +27,7 @@ TimechoDB 是一款低成本、高性能的物联网原生时序数据库，是 - 下载、部署与使用：[快速上手](../QuickStart/QuickStart_timecho.md) -## 1 产品体系 +## 1. 产品体系 天谋产品体系由若干个组件构成，覆盖由【数据采集】到【数据管理】到【数据分析&应用】的全时序数据生命周期，做到“采-存-用”一体化时序数据解决方案，帮助用户高效地管理和分析物联网产生的海量时序数据。 @@ -43,13 +43,13 @@ TimechoDB 是一款低成本、高性能的物联网原生时序数据库，是 3. **时序模型训推一体化引擎（AINode）**：针对智能分析场景，TimechoDB 提供 AINode 时序模型训推一体化引擎，它提供了一套完整的时序数据分析工具，底层为模型训练引擎，支持训练任务与数据管理，与包括机器学习、深度学习等。通过这些工具，用户可以对存储在 TimechoDB 中的数据进行深入分析，挖掘出其中的价值。 4. **数据采集**：为了更加便捷的对接各类工业采集场景， 天谋科技提供数据采集接入服务，支持多种协议和格式，可以接入各种传感器、设备产生的数据，同时支持断点续传、网闸穿透等特性。更加适配工业领域采集过程中配置难、传输慢、网络弱的特点，让用户的数采变得更加简单、高效。 -## 2 TimechoDB 整体架构 +## 2. TimechoDB 整体架构 下图展示了一个常见的 IoTDB 3C3D（3 个 ConfigNode、3 个 DataNode）的集群部署模式： -## 3 产品特性 +## 3. 产品特性 TimechoDB 具备以下优势和特性： @@ -69,7 +69,7 @@ TimechoDB 具备以下优势和特性： - 丰富的生态环境对接：支持Hadoop、Spark等大数据生态系统组件对接，支持Grafana、Thingsboard、DataEase等设备管理和可视化工具 -## 4 企业特性 +## 4. 企业特性 ### 4.1 更高阶的产品功能 diff --git a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Release-history_timecho.md b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Release-history_timecho.md index a07bcc8b4..30e6a18b2 100644 --- a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Release-history_timecho.md +++ b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Release-history_timecho.md @@ -20,7 +20,7 @@ --> # 发版历史 -## 1 TimechoDB（数据库内核） +## 1. TimechoDB（数据库内核） ### V1.3.4.1 > 发版时间：2025.01.08 > @@ -202,7 +202,7 @@ V1.0.0.1主要修复分区计算及查询执行时的相关问题，历史快照 - 流处理模块：支持流处理框架 - 流处理模块：支持集群间数据同步功能 -## 2 Workbench（控制台工具） +## 2. Workbench（控制台工具） | **控制台版本号** | **版本说明** | **可支持IoTDB版本** | | ---------------- | ------------------------------------------------------------ | ------------------- | diff --git a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Scenario.md b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Scenario.md index fc2e90d87..572115420 100644 --- a/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Scenario.md +++ b/src/zh/UserGuide/latest-Table/IoTDB-Introduction/Scenario.md @@ -21,7 +21,7 @@ # 应用场景 -## 1 应用1——能源电力 +## 1. 能源电力 ### 1.1 背景 @@ -34,7 +34,7 @@ IoTDB 凭借集群高可用、低流量数据同步、跨网闸支持和优异 ![img](/img/scenarios01.png) -## 2 应用2——航空航天 +## 2. 航空航天 ### 2.1 背景 @@ -47,7 +47,7 @@ IoTDB 凭借其国产自研的高效低流量数据同步、离线数据迁移 ![img](/img/scenarios02.png) -## 3 应用3——交通运输 +## 3. 交通运输 ### 3.1 背景 @@ -60,7 +60,7 @@ IoTDB 凭借其高效的时序数据管理和低延迟查询能力，有效应 ![img](/img/scenarios03.png) -## 4 应用4——钢铁冶炼 +## 4. 钢铁冶炼 ### 4.1 背景 @@ -73,7 +73,7 @@ IoTDB 通过其强大的数据存储与计算能力，为钢铁冶炼场景提 ![img](/img/scenarios04.png) -## 5 应用5——物联网 +## 5. 物联网 ### 5.1 背景 diff --git a/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_apache.md b/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_apache.md index ac14961d4..afa6cd2d0 100644 --- a/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_apache.md +++ b/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_apache.md @@ -23,7 +23,7 @@ 本篇文档将帮助您了解快速入门 IoTDB 的方法。 -## 1 如何安装部署？ +## 1. 如何安装部署？ 本篇文档将帮助您快速安装部署 IoTDB，您可以通过以下文档的链接快速定位到所需要查看的内容： @@ -41,7 +41,7 @@ > ❗️注意：目前我们仍然推荐直接在物理机/虚拟机上安装部署，如需要 docker 部署，可参考：[Docker 部署](../Deployment-and-Maintenance/Docker-Deployment_apache.md) -## 2 如何使用？ +## 2. 如何使用？ 1. 数据库建模设计：数据库建模是创建数据库系统的重要步骤，它涉及到设计数据的结构和关系，以确保数据的组织方式能够满足特定应用的需求，下面的文档将会帮助您快速了解 IoTDB 的建模设计： @@ -68,7 +68,7 @@ 6. 应用编程接口： IoTDB 提供了多种应用编程接口（API），以便于开发者在应用程序中与 IoTDB 进行交互，目前支持[ Java 原生接口](../API/Programming-Java-Native-API_apache.md)、[Python 原生接口](../API/Programming-Python-Native-API.md)、[JDBC](../API/Programming-JDBC_apache.md)等，更多编程接口可参见官网【应用编程接口】其他章节 -## 3 想了解更多技术细节？ +## 3. 想了解更多技术细节？ 如果您想了解 IoTDB 的更多技术内幕，可以移步至下面的文档： diff --git a/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_timecho.md b/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_timecho.md index 23168f8a1..cd22f2a74 100644 --- a/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_timecho.md +++ b/src/zh/UserGuide/latest-Table/QuickStart/QuickStart_timecho.md @@ -23,7 +23,7 @@ 本篇文档将帮助您了解快速入门 IoTDB 的方法。 -## 1 如何安装部署？ +## 1. 如何安装部署？ 本篇文档将帮助您快速安装部署 IoTDB，您可以通过以下文档的链接快速定位到所需要查看的内容： @@ -48,7 +48,7 @@ - 监控面板：提供了上百个数据库监控指标，用来对 IoTDB 及其所在操作系统进行细致监控，从而进行系统优化、性能优化、发现瓶颈等，安装步骤可查看 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) -## 2 如何使用？ +## 2. 如何使用？ 1. 数据库建模设计：数据库建模是创建数据库系统的重要步骤，它涉及到设计数据的结构和关系，以确保数据的组织方式能够满足特定应用的需求，下面的文档将会帮助您快速了解 IoTDB 的建模设计： @@ -75,14 +75,14 @@ 6. 应用编程接口： IoTDB 提供了多种应用编程接口（API），以便于开发者在应用程序中与 IoTDB 进行交互，目前支持[ Java 原生接口](../API/Programming-Java-Native-API_timecho.md)、[Python 原生接口](../API/Programming-Python-Native-API.md)、[JDBC](../API/Programming-JDBC_timecho.md)等，更多编程接口可参见官网【应用编程接口】其他章节 -## 3 还有哪些便捷的周边工具？ +## 3. 还有哪些便捷的周边工具？ IoTDB 除了自身拥有丰富的功能外，其周边的工具体系包含的种类十分齐全。本篇文档将帮助您快速使用周边工具体系： - 监控面板：是一个对 IoTDB 及其所在操作系统进行细致监控的工具，涵盖数据库性能、系统资源等上百个数据库监控指标，助力系统优化与瓶颈识别等，具体使用介绍请查看 [监控面板部署](../Tools-System/Monitor-Tool_timecho.md) -## 4 想了解更多技术细节？ +## 4. 想了解更多技术细节？ 如果您想了解 IoTDB 的更多技术内幕，可以移步至下面的文档： diff --git a/src/zh/UserGuide/latest-Table/Reference/Sample-Data.md b/src/zh/UserGuide/latest-Table/Reference/Sample-Data.md index f7feec9b2..24f85071f 100644 --- a/src/zh/UserGuide/latest-Table/Reference/Sample-Data.md +++ b/src/zh/UserGuide/latest-Table/Reference/Sample-Data.md @@ -23,13 +23,13 @@ 本章节主要介绍一个简单的时序数据应用场景以及在此场景下的建模与示例数据，IoTDB 表模型用户手册中所有的示例 SQL 语句都可以在此建模和示例数据下执行。 -## 1 数据结构 +## 1. 数据结构 table1和table2均为如下表结构： ![](/img/Sample_data01.png) -## 2 导入语句 +## 2. 导入语句 以下为构建上述表结构及数据的SQL语句，您可以点此（[sample_data.sql](/img/sample_data.sql)）下载全部SQL并在CLI中执行，从而将数据导入您的IoTDB。 diff --git a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md index a65ae90fd..6c25a1260 100644 --- a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md +++ b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md @@ -28,7 +28,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - `iotdb-system.properties`：IoTDB 的配置文件。 - `iotdb-system.properties.template`：IoTDB 的配置文件模版。 -## 1 修改配置： +## 1. 修改配置： 在 `iotdb-system.properties` 文件中已存在的参数可以直接进行修改。对于那些在 `iotdb-system.properties` 中未列出的参数，可以从 `iotdb-system.properties.template` 配置文件模板中找到相应的参数，然后将其复制到 `iotdb-system.properties` 文件中进行修改。 @@ -40,7 +40,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - 重启服务生效： ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 - 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 -## 2 环境配置项 +## 2. 环境配置项 ### 2.1 confignode-env.sh/bat @@ -105,7 +105,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 改后生效方式 | 重启服务生效 | -## 3 系统配置项（iotdb-system.properties.template） +## 3. 系统配置项（iotdb-system.properties.template） ### 3.1 集群管理 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Basis-Function.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Basis-Function.md index 7a3699266..c2d312da6 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Basis-Function.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Basis-Function.md @@ -21,7 +21,7 @@ # 基础函数 -## 1 比较函数和运算符 +## 1. 比较函数和运算符 ### 1.1 基本比较运算符 @@ -120,7 +120,7 @@ SELECT * FROM table1 WHERE temperature IN (85.0, 90.0); SELECT * FROM table1 WHERE region NOT IN ('北京', '上海'); ``` -## 2 聚合函数 +## 2. 聚合函数 ### 2.1 概述 @@ -299,7 +299,7 @@ Total line number = 1 It costs 0.244s ``` -## 3 逻辑运算符 +## 3. 逻辑运算符 ### 3.1 概述 @@ -378,7 +378,7 @@ NOT NULL -- null | NULL | NULL | -## 4 日期和时间函数和运算符 +## 4. 日期和时间函数和运算符 ### 4.1 now() -> Timestamp @@ -621,7 +621,7 @@ Total line number = 18 It costs 0.319s ``` -## 5 数学函数和运算符 +## 5. 数学函数和运算符 ### 5.1 数学运算符 @@ -662,7 +662,7 @@ It costs 0.319s | e | 自然指数 | | double | e() | | pi | π | | double | pi() | -## 6 条件表达式 +## 6. 条件表达式 ### 6.1 CASE 表达式 @@ -722,7 +722,7 @@ SELECT a, b, coalesce(value1, value2[, ...]) ``` -## 7 转换函数 +## 7. 转换函数 ### 7.1 转换函数 @@ -755,7 +755,7 @@ SELECT * IN (try_cast('2024-11-27' AS DATE), try_cast('2024-11-28' AS DATE)); ``` -## 8 字符串函数和操作符 +## 8. 字符串函数和操作符 ### 8.1 字符串操作符 @@ -785,7 +785,7 @@ SELECT * | substring | 从指定位置提取字符到字符串末尾。需要注意的是，起始位置是基于字符而不是字节数组确定的。`start_index` 从 1 开始计数，长度从 `start_index` 位置计算。 | 支持两个参数**string**：要提取子字符串的源字符串，可以是字符串或文本类型。**start_index**：从哪个索引开始提取子字符串，索引从 1 开始计数。 | String：返回一个字符串，从 `start_index` 位置开始到字符串末尾的所有字符。**注意事项**：`start_index` 从 1 开始，即数组的第 0 个位置是 1参数为 null时，返回 `null`start_index 大于字符串长度时，结果报错。 | substring(string from start_index)或 substring(string, start_index) | | substring | 从一个字符串中提取从指定位置开始、指定长度的子字符串注意：起始位置和长度是基于字符而不是字节数组确定的。`start_index` 从 1 开始计数，长度从 `start_index` 位置计算。 | 支持三个参数**string**：要提取子字符串的源字符串，可以是字符串或文本类型。**start_index**：从哪个索引开始提取子字符串，索引从 1 开始计数。**length**：要提取的子字符串的长度。 | String：返回一个字符串，从 `start_index` 位置开始，提取 `length` 个字符。**注意事项**：参数为 null时，返回 `null`如果 `start_index` 大于字符串的长度，结果报错。如果 `length` 小于 0，结果报错。极端情况，`start_index + length` 超过 `int.MAX` 并变成负数，将导致异常结果。 | substring(string from start_index for length) 或 substring(string, start_index, length) | -## 9 模式匹配函数 +## 9. 模式匹配函数 ### 9.1 LIKE 运算符 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Featured-Functions.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Featured-Functions.md index cc8d96490..d4f9215f8 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Featured-Functions.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Featured-Functions.md @@ -21,7 +21,7 @@ # 特色函数 -## 1 时序特色函数 +## 1. 时序特色函数 ### 1.1 降采样函数 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Fill-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Fill-Clause.md index b61f74040..5bfaa241f 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Fill-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Fill-Clause.md @@ -21,13 +21,13 @@ # FILL 子句 -## 1 功能介绍 +## 1. 功能介绍 在执行数据查询时，可能会遇到某些列在某些行中没有数据，导致结果集中出现 NULL 值。这些 NULL 值不利于数据的可视化展示和分析，因此 IoTDB 提供了 FILL 子句来填充这些 NULL 值。 当查询中包含 ORDER BY 子句时，FILL 子句会在 ORDER BY 之前执行。而如果存在 GAPFILL（ date_bin_gapfill 函数）操作，则 FILL 子句会在 GAPFILL 之后执行。 -## 2 语法概览 +## 2. 语法概览 ```sql fillClause @@ -87,7 +87,7 @@ IoTDB 支持以下三种空值填充方式： 注意：对于数据类型不支持指定填充方法的列，既不进行填充，也不抛出异常，只是保持原样。 -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 @@ -305,7 +305,7 @@ Total line number = 7 It costs 0.073s ``` -## 4 高阶用法 +## 4. 高阶用法 使用 `PREVIOUS` 和 `LINEAR` FILL 时，还支持额外的 `FILL_GROUP` 参数，来进行分组内填充。 @@ -397,7 +397,7 @@ Total line number = 8 It costs 0.089s ``` -## 5 特别说明 +## 5. 特别说明 在使用 `LINEAR FILL` 或 `PREVIOUS FILL` 时，如果辅助时间列（用于确定填充逻辑的时间列）中存在 NULL 值，IoTDB 将遵循以下规则： diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/From-Join-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/From-Join-Clause.md index 3492401ac..b37633729 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/From-Join-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/From-Join-Clause.md @@ -21,7 +21,7 @@ # FROM & JOIN 子句 -## 1 语法概览 +## 1. 语法概览 ```sql FROM relation (',' relation)* @@ -60,11 +60,11 @@ qualifiedName ; ``` -## 2 FROM 子句 +## 2. FROM 子句 FROM 子句指定了查询操作的数据源。在逻辑上，查询的执行从 FROM 子句开始。FROM 子句可以包含单个表、使用 JOIN 子句连接的多个表的组合，或者子查询中的另一个 SELECT 查询。 -## 3 JOIN 子句 +## 3. JOIN 子句 JOIN 用于将两个表基于某些条件连接起来，通常，连接条件是一个谓词，但也可以指定其他隐含的规则。 @@ -115,7 +115,7 @@ SELECT selectExpr [, selectExpr] ... FROM [, ] ... [WHE 在当前版本的 IoTDB 中，只支持 FULL [OUTER] JOIN，即全外连接，返回左表和右表连接后的所有记录。如果某个表中的记录没有与另一个表中的记录匹配，则会返回 NULL 值。__FULL JOIN 只能使用显式连接方式。__ -## 4 示例数据 +## 4. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/GroupBy-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/GroupBy-Clause.md index 713dcff83..176d3e031 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/GroupBy-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/GroupBy-Clause.md @@ -21,7 +21,7 @@ # GROUP BY 子句 -## 1 语法概览 +## 1. 语法概览 ```sql GROUP BY expression (',' expression)* @@ -32,7 +32,7 @@ GROUP BY expression (',' expression)* ![](/img/groupby01.png) -## 2 注意事项 +## 2. 注意事项 - 在 SELECT 子句中的项必须包含聚合函数或由出现在 GROUP BY 子句中的列组成。 @@ -193,7 +193,7 @@ Total line number = 1 It costs 0.047s ``` -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Having-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Having-Clause.md index 383d9e770..d644321c1 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Having-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Having-Clause.md @@ -21,7 +21,7 @@ # HAVING 子句 -## 1 语法概览 +## 1. 语法概览 ```sql HAVING booleanExpression @@ -35,7 +35,7 @@ HAVING booleanExpression - 就语法而言，`HAVING`子句与`WHERE`子句相同，WHERE子句在分组聚合之前对数据进行过滤，HAVING子句是对分组聚合后的结果进行过滤。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Identifier.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Identifier.md index fcb5fa61c..49364d382 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Identifier.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Identifier.md @@ -23,7 +23,7 @@ 在 IoTDB 中，标识符用于标识 database、table、column、function 或其他对象名称。 -## 1 命名规则 +## 1. 命名规则 - __开头字符__：标识符必须以字母开头。 - __后续字符__：可以包含字母、数字和下划线。 @@ -50,7 +50,7 @@ table-name // 包含短横线 colum$name@field // 包含特殊字符且未用双引号括起 ``` -## 2 大小写敏感性 +## 2. 大小写敏感性 标识符不区分大小写，且系统存储标识符时不保留原始大小写，查询结果会根据用户在`SELECT`子句中指定的大小写显示列名。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Limit-Offset-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Limit-Offset-Clause.md index 30d950193..ebfb53d40 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Limit-Offset-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Limit-Offset-Clause.md @@ -21,7 +21,7 @@ # LIMIT 和 OFFSET 子句 -## 1 语法概览 +## 1. 语法概览 ```sql OFFSET INTEGER_VALUE LIMIT INTEGER_VALUE @@ -46,7 +46,7 @@ OFFSET 子句与 LIMIT 子句配合使用，用于指定查询结果跳过前 OF - 如果总记录数`n >= OFFSET+LIMIT`之和，返回`LIMIT`数量的记录。 - 如果总记录数`n < OFFSET+LIMIT`之和，返回从`OFFSET`开始到末尾的所有记录，最多`n-offset`条。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/OrderBy-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/OrderBy-Clause.md index aec9e0dfb..66cf55068 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/OrderBy-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/OrderBy-Clause.md @@ -21,7 +21,7 @@ # ORDER BY 子句 -## 1 语法概览 +## 1. 语法概览 ```sql ORDER BY sortItem (',' sortItem)* @@ -38,7 +38,7 @@ sortItem - 默认情况下， 将采用 ASC NULLS LAST排序，即值按升序排序，空值放在最后。可以通过手动指定其他参数更改默认排序顺序。 - ORDER BY 子句的执行顺序排在 LIMIT 或 OFFSET 子句之前。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Select-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Select-Clause.md index 78635e7da..ffc03f993 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Select-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Select-Clause.md @@ -21,7 +21,7 @@ # SELECT 子句 -## 1 语法概览 +## 1. 语法概览 ```sql SELECT selectItem (',' selectItem)* @@ -35,7 +35,7 @@ selectItem - __SELECT 子句__: 指定了查询结果应包含的列，包含聚合函数（如 SUM、AVG、COUNT 等）以及窗口函数，在逻辑上最后执行。 -## 2 语法详释： +## 2. 语法详释： 每个 `selectItem` 可以是以下形式之一： @@ -43,7 +43,7 @@ selectItem - __选择某个关系的所有列__: `relation.*` 选择某个关系的所有列，不允许使用列别名。 - __选择结果集中的所有列__: `*` 选择查询的所有列，不允许使用列别名。 -## 3 示例数据 +## 3. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 @@ -244,7 +244,7 @@ Total line number = 18 It costs 0.189s ``` -## 4 结果集列顺序 +## 4. 结果集列顺序 - __列顺序__: 结果集中的列顺序与 SELECT 子句中指定的顺序相同。 - __多列排序__: 如果选择表达式返回多个列，它们的排序方式与源关系中的排序方式相同 \ No newline at end of file diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/Where-Clause.md b/src/zh/UserGuide/latest-Table/SQL-Manual/Where-Clause.md index 58c56b34b..a793d2746 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/Where-Clause.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/Where-Clause.md @@ -21,7 +21,7 @@ # WHERE 子句 -## 1 语法概览 +## 1. 语法概览 ```sql WHERE booleanExpression @@ -29,7 +29,7 @@ WHERE booleanExpression __WHERE 子句__:用于在 SQL 查询中指定筛选条件，WHERE 子句在 FROM 子句之后立即执行。 -## 2 示例数据 +## 2. 示例数据 在[示例数据页面](../Reference/Sample-Data.md)中，包含了用于构建表结构和插入数据的SQL语句，下载并在IoTDB CLI中执行这些语句，即可将数据导入IoTDB，您可以使用这些数据来测试和执行示例中的SQL语句，并获得相应的结果。 diff --git a/src/zh/UserGuide/latest-Table/SQL-Manual/overview.md b/src/zh/UserGuide/latest-Table/SQL-Manual/overview.md index 4419f6462..ea5a1a9cf 100644 --- a/src/zh/UserGuide/latest-Table/SQL-Manual/overview.md +++ b/src/zh/UserGuide/latest-Table/SQL-Manual/overview.md @@ -21,7 +21,7 @@ # 概览 -## 1 语法概览 +## 1. 语法概览 ```SQL SELECT ⟨select_list⟩ @@ -47,7 +47,7 @@ IoTDB 查询语法提供以下子句： - OFFSET 子句：用于指定查询结果的起始位置，即跳过前 OFFSET 行。与 LIMIT 子句配合使用。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) - LIMIT 子句：限制查询结果的行数，通常与 OFFSET 子句一起使用以实现分页功能。详细语法见：[LIMIT 和 OFFSET 子句](../SQL-Manual/Limit-Offset-Clause.md) -## 2 子句执行顺序 +## 2. 子句执行顺序 ![](/img/%E5%AD%90%E5%8F%A5%E6%89%A7%E8%A1%8C%E9%A1%BA%E5%BA%8F01.png) diff --git a/src/zh/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md b/src/zh/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md index 84eb33dbf..a375e55a8 100644 --- a/src/zh/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md +++ b/src/zh/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md @@ -23,7 +23,7 @@ 本文档介绍 IoTDB 中的分区策略和负载均衡策略。根据时序数据的特性，IoTDB 按序列和时间维度对其进行分区。结合序列分区与时间分区创建一个分区，作为划分的基本单元。为了提高吞吐量并降低管理成本，这些分区被均匀分配到分片（Region）中，分片是复制的基本单元。分片的副本决定了数据的存储位置，主副本负责主要负载的管理。在此过程中，副本放置算法决定哪些节点将持有分片副本，而主副本选择算法则指定哪个副本将成为主副本。 -## 1 分区策略和分区分配 +## 1. 分区策略和分区分配 IoTDB 为时间序列数据实现了量身定制的分区算法。在此基础上，缓存于配置节点和数据节点上的分区信息不仅易于管理，而且能够清晰区分冷热数据。随后，平衡的分区被均匀分配到集群的分片中，以实现存储均衡。 ### 1.1 分区策略 @@ -71,7 +71,7 @@ $$\text{RegionGroupNumber}=\left\lfloor\frac{\sum_{i=1}^{DataNodeNumber}\text{Re 值得注意的是，IoTDB 有效利用了时序数据的特性。当配置了 TTL（生存时间）时，IoTDB 可实现无需迁移的时序数据弹性存储，该功能在集群扩展时最小化了对在线操作的影响。上图展示了该功能的一个实例：新生成的数据分区被均匀分配到每个数据分片，过期数据会自动归档。因此，集群的存储最终将保持平衡。 -## 2 均衡策略 +## 2. 均衡策略 为了提高集群的可用性和性能，IoTDB 采用了精心设计的存储均衡和计算均衡算法。 ### 2.1 存储均衡 @@ -104,7 +104,7 @@ $$\text{RegionGroupNumber}=\left\lfloor\frac{\sum_{i=1}^{DataNodeNumber}\text{Re 为了解决这个问题，IoTDB 采用了一种主副本选择算法，能够持续平衡集群中的主副本分布。因此，集群实现了计算负载的均衡分布，确保了其性能。 -## 3 Source Code +## 3. Source Code + [数据分区](https://github.com/apache/iotdb/tree/master/iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/partition) + [分区分配](https://github.com/apache/iotdb/tree/master/iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/manager/load/balancer/partition) + [副本放置](https://github.com/apache/iotdb/tree/master/iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/manager/load/balancer/副本) diff --git a/src/zh/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md b/src/zh/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md index 2a4885b3d..103141827 100644 --- a/src/zh/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md +++ b/src/zh/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md @@ -21,7 +21,7 @@ # 编码和压缩 -## 1 编码方式 +## 1. 编码方式 ### 1.1 基本编码方式 @@ -97,7 +97,7 @@ IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN, ENCODIN Msg: 507: encoding TS_2DIFF does not support BOOLEAN ``` -## 2 压缩方式 +## 2. 压缩方式 当时间序列写入并按照指定的类型编码为二进制数据后，IoTDB 会使用压缩技术对该数据进行压缩，进一步提升空间存储效率。虽然编码和压缩都旨在提升存储效率，但编码技术通常只适合特定的数据类型（如二阶差分编码只适合与 INT32 或者 INT64 编码，存储浮点数需要先将他们乘以 10m 以转换为整数），然后将它们转换为二进制流。压缩方式（SNAPPY）针对二进制流进行压缩，因此压缩方式的使用不再受数据类型的限制。 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Benchmark.md b/src/zh/UserGuide/latest-Table/Tools-System/Benchmark.md index fc16a9b35..a0323e753 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Benchmark.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Benchmark.md @@ -21,7 +21,7 @@ # 测试工具 -## 1 基本概述 +## 1. 基本概述 IoT-benchmark 是基于 Java 和大数据环境开发的时序数据库基准测试工具，由清华大学软件学院研发并开源。它使用方便，支持多种写入以及查询方式，支持存储测试信息和结果以供进一步查询或分析，支持与 Tableau 集成以可视化测试结果。 @@ -53,7 +53,7 @@ IoT-benchmark 是基于 Java 和大数据环境开发的时序数据库基准测 表1-1大数据测试基准对比 -## 2 安装运行 +## 2. 安装运行 ### 2.1 前置条件 @@ -126,7 +126,7 @@ drwxr-xr-x. 2 root root 4096 1月 10 01:38 lib -## 3 主要参数 +## 3. 主要参数 ### 3.1 IoTDB服务模型 @@ -305,7 +305,7 @@ LOOP=50 DEVICE_NUMBER=20 TEST > tail -f log_info.log ``` -## 4 测试示例 +## 4. 测试示例 以IoTDB 2.0为例，使用IoT-Benchemark测试表模型写入及查询，修改IoT-Benchemark配置文件如下： diff --git a/src/zh/UserGuide/latest-Table/Tools-System/CLI.md b/src/zh/UserGuide/latest-Table/Tools-System/CLI.md index 36a5d5f0b..6ab0e9866 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/CLI.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/CLI.md @@ -25,7 +25,7 @@ IoTDB 为用户提供 CLI 工具用于和服务端程序进行交互操作。在 > 本文中 $IoTDB_HOME 表示 IoTDB 的安装目录所在路径。 -## 1 CLI 启动 +## 1. CLI 启动 CLI 客户端脚本是 $IoTDB_HOME/sbin 文件夹下的`start-cli`脚本。启动命令为： @@ -70,7 +70,7 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab ![](/img/Cli-01.png) -## 2 在 CLI 中执行语句 +## 2. 在 CLI 中执行语句 进入 CLI 后，用户可以直接在对话中输入 SQL 语句进行交互。如： @@ -92,11 +92,11 @@ show databases ![](/img/Cli-03.png) -## 3 CLI 退出 +## 3. CLI 退出 在 CLI 中输入`quit`或`exit`可退出 CLI 结束本次会话。 -## 4 其他说明 +## 4. 其他说明 CLI中使用命令小技巧： diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md b/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md index 9062be9fb..55d6828dc 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md @@ -21,7 +21,7 @@ # 集群管理工具 -## 1 数据文件夹概览工具 +## 1. 数据文件夹概览工具 IoTDB数据文件夹概览工具用于打印出数据文件夹的结构概览信息，工具位置为 tools/tsfile/print-iotdb-data-dir。 @@ -82,7 +82,7 @@ data dir num:1 |============================================================== ````````````````````````` -## 2 TsFile概览工具 +## 2. TsFile概览工具 TsFile概览工具用于以概要模式打印出一个TsFile的内容，工具位置为 tools/tsfile/print-tsfile。 @@ -170,7 +170,7 @@ file length: 2974 - "|||||||||||||||||||||"是为增强可读性而添加的导引信息，不是TsFile中实际存储的数据。 - 最后打印的"IndexOfTimerseriesIndex Tree"是对TsFile文件末尾的元数据索引树的重新整理打印，便于直观理解，不是TsFile中存储的实际数据。 -## 3 TsFile Resource概览工具 +## 3. TsFile Resource概览工具 TsFile resource概览工具用于打印出TsFile resource文件的内容，工具位置为 tools/tsfile/print-tsfile-resource-files。 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md b/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md index 74df81723..f31b5cfcf 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md @@ -21,7 +21,7 @@ # 集群管理工具 -## 1 集群管理工具 +## 1. 集群管理工具 IoTDB 集群管理工具是一款易用的运维工具（企业版工具）。旨在解决 IoTDB 分布式系统多节点的运维难题，主要包括集群部署、集群启停、弹性扩容、配置更新、数据导出等功能，从而实现对复杂数据库集群的一键式指令下发，极大降低管理难度。本文档将说明如何用集群管理工具远程部署、配置、启动和停止 IoTDB 集群实例。 @@ -805,7 +805,7 @@ iotdbctl cluster exportschema default_cluster -N datanode1 -param "-t ./ -pf ./p | default_3c3d.yaml | 3个confignode和3个datanode 配置样例 | | default_3c3d_grafa_prome | 3个confignode和3个datanode、Grafana、Prometheus配置样例 | -## 2 数据文件夹概览工具 +## 2. 数据文件夹概览工具 IoTDB数据文件夹概览工具用于打印出数据文件夹的结构概览信息，工具位置为 tools/tsfile/print-iotdb-data-dir。 @@ -866,7 +866,7 @@ data dir num:1 |============================================================== ````````````````````````` -## 3 TsFile概览工具 +## 3. TsFile概览工具 TsFile概览工具用于以概要模式打印出一个TsFile的内容，工具位置为 tools/tsfile/print-tsfile。 @@ -954,7 +954,7 @@ file length: 2974 - "|||||||||||||||||||||"是为增强可读性而添加的导引信息，不是TsFile中实际存储的数据。 - 最后打印的"IndexOfTimerseriesIndex Tree"是对TsFile文件末尾的元数据索引树的重新整理打印，便于直观理解，不是TsFile中存储的实际数据。 -## 4 TsFile Resource概览工具 +## 4. TsFile Resource概览工具 TsFile resource概览工具用于打印出TsFile resource文件的内容，工具位置为 tools/tsfile/print-tsfile-resource-files。 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md b/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md index c6e0eb6cb..902611942 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md @@ -24,7 +24,7 @@ 监控工具的部署可参考文档 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) 章节。 -## 1 监控指标的 Prometheus 映射关系 +## 1. 监控指标的 Prometheus 映射关系 > 对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射，其中 value 为具体值 @@ -36,7 +36,7 @@ | Rate | name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m1"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m5"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m15"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="mean"} value | | Timer | name_seconds_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value | -## 2 修改配置文件 +## 2. 修改配置文件 1) 以 DataNode 为例，修改 iotdb-system.properties 配置文件如下： @@ -60,7 +60,7 @@ file_count{name="seq",} 2.0 ... ``` -## 3 Prometheus + Grafana +## 3. Prometheus + Grafana 如上所示，IoTDB 对外暴露出标准的 Prometheus 格式的监控指标数据，可以使用 Prometheus 采集并存储监控指标，使用 Grafana 可视化监控指标。 @@ -102,7 +102,7 @@ static_configs: [Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus) -## 4 Apache IoTDB Dashboard +## 4. Apache IoTDB Dashboard `Apache IoTDB Dashboard`是 IoTDB 企业版的配套产品，支持统一集中式运维管理，可通过一个监控面板监控多个集群。你可以联系商务获取到 Dashboard 的 Json文件。 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_timecho.md b/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_timecho.md index 3b0fa3cc5..3eed71954 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_timecho.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Monitor-Tool_timecho.md @@ -24,7 +24,7 @@ 监控工具的部署可参考文档 [监控面板部署](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) 章节。 -## 1 监控指标的 Prometheus 映射关系 +## 1. 监控指标的 Prometheus 映射关系 > 对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射，其中 value 为具体值 @@ -36,7 +36,7 @@ | Rate | name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m1"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m5"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m15"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="mean"} value | | Timer | name_seconds_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value | -## 2 修改配置文件 +## 2. 修改配置文件 1) 以 DataNode 为例，修改 iotdb-system.properties 配置文件如下： @@ -60,7 +60,7 @@ file_count{name="seq",} 2.0 ... ``` -## 3 Prometheus + Grafana +## 3. Prometheus + Grafana 如上所示，IoTDB 对外暴露出标准的 Prometheus 格式的监控指标数据，可以使用 Prometheus 采集并存储监控指标，使用 Grafana 可视化监控指标。 @@ -102,7 +102,7 @@ static_configs: [Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus) -## 4 Apache IoTDB Dashboard +## 4. Apache IoTDB Dashboard 我们提供了Apache IoTDB Dashboard，支持统一集中式运维管理，可通过一个监控面板监控多个集群。 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 4843e88a1..20e2a316b 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 @@ -22,7 +22,7 @@ # 数据同步 数据同步是工业物联网的典型需求，通过数据同步机制，可实现 IoTDB 之间的数据共享，搭建完整的数据链路来满足内网外网数据互通、端边云同步、数据迁移、数据备份等需求。 -## 1 功能概述 +## 1. 功能概述 ### 1.1 数据同步 @@ -42,7 +42,7 @@ - 不支持 2.x 系列版本 IoTDB 数据同步到 1.x 系列版本版本的 IoTDB。 - 在进行数据同步任务时，请避免执行任何删除操作，防止两端状态不一致。 -## 2 使用说明 +## 2. 使用说明 数据同步任务有三种状态：RUNNING、STOPPED 和 DROPPED。任务状态转换如下图所示： @@ -204,7 +204,7 @@ IoTDB> SHOW PIPEPLUGINS
-## 3 使用示例 +## 3. 使用示例 ### 3.1 全量数据同步 diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md index b781b6a7b..fc65c8d9f 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md @@ -22,7 +22,7 @@ # 数据同步 数据同步是工业物联网的典型需求，通过数据同步机制，可实现 IoTDB 之间的数据共享，搭建完整的数据链路来满足内网外网数据互通、端边云同步、数据迁移、数据备份等需求。 -## 1 功能概述 +## 1. 功能概述 ### 1.1 数据同步 @@ -42,7 +42,7 @@ - 不支持 2.x 系列版本 IoTDB 数据同步到 1.x 系列版本版本的 IoTDB。 - 在进行数据同步任务时，请避免执行任何删除操作，防止两端状态不一致。 -## 2 使用说明 +## 2. 使用说明 数据同步任务有三种状态：RUNNING、STOPPED 和 DROPPED。任务状态转换如下图所示： @@ -209,7 +209,7 @@ IoTDB> SHOW PIPEPLUGINS -## 3 使用示例 +## 3. 使用示例 ### 3.1 全量数据同步 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 5453f2f3f..525a4bde1 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md @@ -20,7 +20,7 @@ --> # 运维语句 -## 1 状态查看 +## 1. 状态查看 ### 1.1 查看连接的模型 @@ -304,7 +304,7 @@ IoTDB> SHOW QUERIES WHERE elapsed_time > 30 +-----------------------+-----------------------------+-----------+------------+------------+----+ ``` -## 2 状态设置 +## 2. 状态设置 ### 2.1 设置连接的模型 @@ -444,7 +444,7 @@ IoTDB> SET SYSTEM TO READONLY ON CLUSTER; ``` -## 3 数据管理 +## 3. 数据管理 ### 3.1 刷写内存表中的数据到磁盘 @@ -535,7 +535,7 @@ localOrClusterMode IoTDB> CLEAR ALL CACHE ON LOCAL; ``` -## 4 数据修复 +## 4. 数据修复 ### 4.1 启动后台扫描并修复 tsfile 任务 @@ -599,7 +599,7 @@ localOrClusterMode IoTDB> STOP REPAIR DATA ON CLUSTER; ``` -## 5 终止查询 +## 5. 终止查询 ### 5.1 主动终止查询 diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Query-Performance-Analysis.md b/src/zh/UserGuide/latest-Table/User-Manual/Query-Performance-Analysis.md index 8ba60dff6..97fabd22d 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Query-Performance-Analysis.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Query-Performance-Analysis.md @@ -20,7 +20,7 @@ --> # 系统运维 -## 1 查询性能分析 +## 1. 查询性能分析 查询分析的意义在于帮助用户理解查询的执行机制和性能瓶颈，从而实现查询优化和性能提升。这不仅关乎到查询的执行效率，也直接影响到应用的用户体验和资源的有效利用。为了进行有效的查询分析，IoTDB 提供了查询分析语句：Explain 和 Explain Analyze。 diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md b/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md index 7e3d3bfce..1bc65232c 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md @@ -20,11 +20,11 @@ --> # 多级存储 -## 1 概述 +## 1. 概述 多级存储功能向用户提供多种存储介质管理的能力，用户可以使用多级存储功能为 IoTDB 配置不同类型的存储介质，并为存储介质进行分级。具体的，在 IoTDB 中，多级存储的配置体现为多目录的管理。用户可以将多个存储目录归为同一类，作为一个“层级”向 IoTDB 中配置，这种“层级”我们称之为 storage tier；同时，用户可以根据数据的冷热进行分类，并将不同类别的数据存储到指定的“层级”中。当前 IoTDB 支持通过数据的 TTL 进行冷热数据的分类，当一个层级中的数据不满足当前层级定义的 TTL 规则时，该数据会被自动迁移至下一层级中。 -## 2 参数定义 +## 2. 参数定义 在 IoTDB 中开启多级存储，需要进行以下几个方面的配置： @@ -49,7 +49,7 @@ | remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储，无需配置 | -## 3 本地多级存储配置示例 +## 3. 本地多级存储配置示例 以下以本地两级存储的配置示例。 @@ -67,7 +67,7 @@ dn_default_space_usage_thresholds=0.2;0.1 | 层级一 | 目录一：/data1/data | 最近 1 天的数据 | 20% | | 层级二 | 目录一：/data2/data目录二：/data3/data | 1 天以前的数据 | 10% | -## 4 远端多级存储配置示例 +## 4. 远端多级存储配置示例 以下以三级存储为例：