You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2021/03/29 09:28:43 UTC
[iotdb] 01/01: [To NewDoc] re-order the user guide chapters
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch re-order
in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit 1250049c53b0f9a4dbea165f43bad0e2132fc271
Author: HTHou <hh...@outlook.com>
AuthorDate: Mon Mar 29 17:27:58 2021 +0800
[To NewDoc] re-order the user guide chapters
---
.../{Client => API}/Programming - JDBC.md | 0
.../{Client => API}/Programming - Native API.md | 0
.../Programming - Other Languages.md | 0
.../{Client => API}/Programming - TsFile API.md | 0
.../Administration.md | 2 +-
.../{Server => Appendix}/Config Manual.md | 0
.../SQL Reference.md | 0
.../UserGuide/{Client => Appendix}/Status Codes.md | 0
.../Architecture/Shared Nothing Cluster.md | 24 --
.../{Client => CLI}/Command Line Interface.md | 0
.../{Server => Cluster Setup}/Cluster Setup.md | 0
.../Sync Tool.md | 0
.../Programming - MQTT.md | 0
.../Programming - Thrift.md | 0
.../{Concept => Data Concept}/Compression.md | 0
.../Data Model and Terminology.md | 4 +-
.../{Concept => Data Concept}/Data Type.md | 0
.../{Concept => Data Concept}/Encoding.md | 0
docs/UserGuide/{Concept => Data Concept}/SDT.md | 0
.../Writing Data on HDFS.md | 0
.../Frequently asked questions.md | 0
.../Architecture.md | 0
.../{Overview => IoTDB Introduction}/Features.md | 0
.../Publication.md | 0
.../{Overview => IoTDB Introduction}/Scenario.md | 0
.../What is IoTDB.md | 0
.../DDL Data Definition Language.md | 0
.../DML Data Manipulation Language.md | 0
.../Maintenance Command.md | 0
.../{Server => QuickStart}/Docker Image.md | 0
docs/UserGuide/{Server => QuickStart}/Download.md | 0
.../{Architecture => QuickStart}/Files.md | 0
.../{Get Started => QuickStart}/QuickStart.md | 0
.../{Server => QuickStart}/ServerFileList.md | 0
.../{Server => QuickStart}/Single Node Setup.md | 0
.../{Operation Manual => UDF}/Triggers.md | 0
.../UDF User Defined Function.md | 0
.../{Client => API}/Programming - JDBC.md | 0
.../{Client => API}/Programming - Native API.md | 0
.../Programming - Other Languages.md | 0
.../{Client => API}/Programming - TsFile API.md | 0
.../Administration.md | 0
.../{Server => Appendix}/Config Manual.md | 0
.../SQL Reference.md | 0
.../UserGuide/{Client => Appendix}/Status Codes.md | 0
.../Architecture/Shared Nothing Cluster.md | 24 --
.../{Client => CLI}/Command Line Interface.md | 0
.../{Server => Cluster Setup}/Cluster Setup.md | 0
.../Collaboration of Edge and Cloud/Sync Tool.md | 187 +++++++++++++++
.../Programming - MQTT.md | 0
.../Programming - Thrift.md | 0
.../{Concept => Data Concept}/Compression.md | 0
.../Data Model and Terminology.md | 3 +-
.../{Concept => Data Concept}/Data Type.md | 0
.../{Concept => Data Concept}/Encoding.md | 0
docs/zh/UserGuide/{Concept => Data Concept}/SDT.md | 0
.../Writing Data on HDFS.md | 0
.../Frequently asked questions.md | 0
.../Architecture.md | 0
.../{Overview => IoTDB Introduction}/Features.md | 0
.../Publication.md | 4 +-
.../{Overview => IoTDB Introduction}/Scenario.md | 0
.../What is IoTDB.md | 0
.../DDL Data Definition Language.md | 0
.../DML Data Manipulation Language.md | 0
.../Maintenance Command.md | 0
.../{Server => QuickStart}/Docker Image.md | 0
.../UserGuide/{Server => QuickStart}/Download.md | 0
.../{Architecture => QuickStart}/Files.md | 0
.../{Get Started => QuickStart}/QuickStart.md | 0
.../{Server => QuickStart}/ServerFileList.md | 0
.../{Server => QuickStart}/Single Node Setup.md | 0
.../{Operation Manual => UDF}/Triggers.md | 0
.../UDF User Defined Function.md | 0
site/src/main/.vuepress/config.js | 259 +++++++++++++--------
75 files changed, 350 insertions(+), 157 deletions(-)
diff --git a/docs/UserGuide/Client/Programming - JDBC.md b/docs/UserGuide/API/Programming - JDBC.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - JDBC.md
rename to docs/UserGuide/API/Programming - JDBC.md
diff --git a/docs/UserGuide/Client/Programming - Native API.md b/docs/UserGuide/API/Programming - Native API.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - Native API.md
rename to docs/UserGuide/API/Programming - Native API.md
diff --git a/docs/UserGuide/Client/Programming - Other Languages.md b/docs/UserGuide/API/Programming - Other Languages.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - Other Languages.md
rename to docs/UserGuide/API/Programming - Other Languages.md
diff --git a/docs/UserGuide/Client/Programming - TsFile API.md b/docs/UserGuide/API/Programming - TsFile API.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - TsFile API.md
rename to docs/UserGuide/API/Programming - TsFile API.md
diff --git a/docs/UserGuide/Operation Manual/Administration.md b/docs/UserGuide/Administration Management/Administration.md
similarity index 99%
rename from docs/UserGuide/Operation Manual/Administration.md
rename to docs/UserGuide/Administration Management/Administration.md
index 55a775f..d38b6d2 100644
--- a/docs/UserGuide/Operation Manual/Administration.md
+++ b/docs/UserGuide/Administration Management/Administration.md
@@ -19,7 +19,7 @@
-->
-# Account Management
+# Administration Management
IoTDB provides users with account privilege management operations, so as to ensure data security.
diff --git a/docs/UserGuide/Server/Config Manual.md b/docs/UserGuide/Appendix/Config Manual.md
similarity index 100%
rename from docs/UserGuide/Server/Config Manual.md
rename to docs/UserGuide/Appendix/Config Manual.md
diff --git a/docs/UserGuide/Operation Manual/SQL Reference.md b/docs/UserGuide/Appendix/SQL Reference.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/SQL Reference.md
rename to docs/UserGuide/Appendix/SQL Reference.md
diff --git a/docs/UserGuide/Client/Status Codes.md b/docs/UserGuide/Appendix/Status Codes.md
similarity index 100%
rename from docs/UserGuide/Client/Status Codes.md
rename to docs/UserGuide/Appendix/Status Codes.md
diff --git a/docs/UserGuide/Architecture/Shared Nothing Cluster.md b/docs/UserGuide/Architecture/Shared Nothing Cluster.md
deleted file mode 100644
index 238af74..0000000
--- a/docs/UserGuide/Architecture/Shared Nothing Cluster.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-# Shared Nothing Architecture
-
-Shared Nothing Architecture is under development. Please wait patiently and look forward to it.
\ No newline at end of file
diff --git a/docs/UserGuide/Client/Command Line Interface.md b/docs/UserGuide/CLI/Command Line Interface.md
similarity index 100%
rename from docs/UserGuide/Client/Command Line Interface.md
rename to docs/UserGuide/CLI/Command Line Interface.md
diff --git a/docs/UserGuide/Server/Cluster Setup.md b/docs/UserGuide/Cluster Setup/Cluster Setup.md
similarity index 100%
rename from docs/UserGuide/Server/Cluster Setup.md
rename to docs/UserGuide/Cluster Setup/Cluster Setup.md
diff --git a/docs/UserGuide/System Tools/Sync Tool.md b/docs/UserGuide/Collaboration of Edge and Cloud/Sync Tool.md
similarity index 100%
rename from docs/UserGuide/System Tools/Sync Tool.md
rename to docs/UserGuide/Collaboration of Edge and Cloud/Sync Tool.md
diff --git a/docs/UserGuide/Client/Programming - MQTT.md b/docs/UserGuide/Communication Service Protocol/Programming - MQTT.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - MQTT.md
rename to docs/UserGuide/Communication Service Protocol/Programming - MQTT.md
diff --git a/docs/UserGuide/Client/Programming - Thrift.md b/docs/UserGuide/Communication Service Protocol/Programming - Thrift.md
similarity index 100%
rename from docs/UserGuide/Client/Programming - Thrift.md
rename to docs/UserGuide/Communication Service Protocol/Programming - Thrift.md
diff --git a/docs/UserGuide/Concept/Compression.md b/docs/UserGuide/Data Concept/Compression.md
similarity index 100%
rename from docs/UserGuide/Concept/Compression.md
rename to docs/UserGuide/Data Concept/Compression.md
diff --git a/docs/UserGuide/Concept/Data Model and Terminology.md b/docs/UserGuide/Data Concept/Data Model and Terminology.md
similarity index 99%
rename from docs/UserGuide/Concept/Data Model and Terminology.md
rename to docs/UserGuide/Data Concept/Data Model and Terminology.md
index 9fc917c..479b9c7 100644
--- a/docs/UserGuide/Concept/Data Model and Terminology.md
+++ b/docs/UserGuide/Data Concept/Data Model and Terminology.md
@@ -18,8 +18,8 @@
under the License.
-->
-
-# Data Model
+# Data Concept
+## Data Model
In this section, a power scenario is taken as an example to illustrate how to creat a correct data model in IoTDB. For convenience, a sample data file is attached for you to practise IoTDB.
diff --git a/docs/UserGuide/Concept/Data Type.md b/docs/UserGuide/Data Concept/Data Type.md
similarity index 100%
rename from docs/UserGuide/Concept/Data Type.md
rename to docs/UserGuide/Data Concept/Data Type.md
diff --git a/docs/UserGuide/Concept/Encoding.md b/docs/UserGuide/Data Concept/Encoding.md
similarity index 100%
rename from docs/UserGuide/Concept/Encoding.md
rename to docs/UserGuide/Data Concept/Encoding.md
diff --git a/docs/UserGuide/Concept/SDT.md b/docs/UserGuide/Data Concept/SDT.md
similarity index 100%
rename from docs/UserGuide/Concept/SDT.md
rename to docs/UserGuide/Data Concept/SDT.md
diff --git a/docs/UserGuide/Architecture/Writing Data on HDFS.md b/docs/UserGuide/Ecosystem Integration/Writing Data on HDFS.md
similarity index 100%
rename from docs/UserGuide/Architecture/Writing Data on HDFS.md
rename to docs/UserGuide/Ecosystem Integration/Writing Data on HDFS.md
diff --git a/docs/UserGuide/Get Started/Frequently asked questions.md b/docs/UserGuide/FAQ/Frequently asked questions.md
similarity index 100%
rename from docs/UserGuide/Get Started/Frequently asked questions.md
rename to docs/UserGuide/FAQ/Frequently asked questions.md
diff --git a/docs/UserGuide/Overview/Architecture.md b/docs/UserGuide/IoTDB Introduction/Architecture.md
similarity index 100%
rename from docs/UserGuide/Overview/Architecture.md
rename to docs/UserGuide/IoTDB Introduction/Architecture.md
diff --git a/docs/UserGuide/Overview/Features.md b/docs/UserGuide/IoTDB Introduction/Features.md
similarity index 100%
rename from docs/UserGuide/Overview/Features.md
rename to docs/UserGuide/IoTDB Introduction/Features.md
diff --git a/docs/UserGuide/Get Started/Publication.md b/docs/UserGuide/IoTDB Introduction/Publication.md
similarity index 100%
rename from docs/UserGuide/Get Started/Publication.md
rename to docs/UserGuide/IoTDB Introduction/Publication.md
diff --git a/docs/UserGuide/Overview/Scenario.md b/docs/UserGuide/IoTDB Introduction/Scenario.md
similarity index 100%
rename from docs/UserGuide/Overview/Scenario.md
rename to docs/UserGuide/IoTDB Introduction/Scenario.md
diff --git a/docs/UserGuide/Overview/What is IoTDB.md b/docs/UserGuide/IoTDB Introduction/What is IoTDB.md
similarity index 100%
rename from docs/UserGuide/Overview/What is IoTDB.md
rename to docs/UserGuide/IoTDB Introduction/What is IoTDB.md
diff --git a/docs/UserGuide/Operation Manual/DDL Data Definition Language.md b/docs/UserGuide/IoTDB-SQL Language/DDL Data Definition Language.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/DDL Data Definition Language.md
rename to docs/UserGuide/IoTDB-SQL Language/DDL Data Definition Language.md
diff --git a/docs/UserGuide/Operation Manual/DML Data Manipulation Language.md b/docs/UserGuide/IoTDB-SQL Language/DML Data Manipulation Language.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/DML Data Manipulation Language.md
rename to docs/UserGuide/IoTDB-SQL Language/DML Data Manipulation Language.md
diff --git a/docs/UserGuide/Operation Manual/Maintenance Command.md b/docs/UserGuide/IoTDB-SQL Language/Maintenance Command.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/Maintenance Command.md
rename to docs/UserGuide/IoTDB-SQL Language/Maintenance Command.md
diff --git a/docs/UserGuide/Server/Docker Image.md b/docs/UserGuide/QuickStart/Docker Image.md
similarity index 100%
rename from docs/UserGuide/Server/Docker Image.md
rename to docs/UserGuide/QuickStart/Docker Image.md
diff --git a/docs/UserGuide/Server/Download.md b/docs/UserGuide/QuickStart/Download.md
similarity index 100%
rename from docs/UserGuide/Server/Download.md
rename to docs/UserGuide/QuickStart/Download.md
diff --git a/docs/UserGuide/Architecture/Files.md b/docs/UserGuide/QuickStart/Files.md
similarity index 100%
rename from docs/UserGuide/Architecture/Files.md
rename to docs/UserGuide/QuickStart/Files.md
diff --git a/docs/UserGuide/Get Started/QuickStart.md b/docs/UserGuide/QuickStart/QuickStart.md
similarity index 100%
rename from docs/UserGuide/Get Started/QuickStart.md
rename to docs/UserGuide/QuickStart/QuickStart.md
diff --git a/docs/UserGuide/Server/ServerFileList.md b/docs/UserGuide/QuickStart/ServerFileList.md
similarity index 100%
rename from docs/UserGuide/Server/ServerFileList.md
rename to docs/UserGuide/QuickStart/ServerFileList.md
diff --git a/docs/UserGuide/Server/Single Node Setup.md b/docs/UserGuide/QuickStart/Single Node Setup.md
similarity index 100%
rename from docs/UserGuide/Server/Single Node Setup.md
rename to docs/UserGuide/QuickStart/Single Node Setup.md
diff --git a/docs/UserGuide/Operation Manual/Triggers.md b/docs/UserGuide/UDF/Triggers.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/Triggers.md
rename to docs/UserGuide/UDF/Triggers.md
diff --git a/docs/UserGuide/Operation Manual/UDF User Defined Function.md b/docs/UserGuide/UDF/UDF User Defined Function.md
similarity index 100%
rename from docs/UserGuide/Operation Manual/UDF User Defined Function.md
rename to docs/UserGuide/UDF/UDF User Defined Function.md
diff --git a/docs/zh/UserGuide/Client/Programming - JDBC.md b/docs/zh/UserGuide/API/Programming - JDBC.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - JDBC.md
rename to docs/zh/UserGuide/API/Programming - JDBC.md
diff --git a/docs/zh/UserGuide/Client/Programming - Native API.md b/docs/zh/UserGuide/API/Programming - Native API.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - Native API.md
rename to docs/zh/UserGuide/API/Programming - Native API.md
diff --git a/docs/zh/UserGuide/Client/Programming - Other Languages.md b/docs/zh/UserGuide/API/Programming - Other Languages.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - Other Languages.md
rename to docs/zh/UserGuide/API/Programming - Other Languages.md
diff --git a/docs/zh/UserGuide/Client/Programming - TsFile API.md b/docs/zh/UserGuide/API/Programming - TsFile API.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - TsFile API.md
rename to docs/zh/UserGuide/API/Programming - TsFile API.md
diff --git a/docs/zh/UserGuide/Operation Manual/Administration.md b/docs/zh/UserGuide/Administration Management/Administration.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/Administration.md
rename to docs/zh/UserGuide/Administration Management/Administration.md
diff --git a/docs/zh/UserGuide/Server/Config Manual.md b/docs/zh/UserGuide/Appendix/Config Manual.md
similarity index 100%
rename from docs/zh/UserGuide/Server/Config Manual.md
rename to docs/zh/UserGuide/Appendix/Config Manual.md
diff --git a/docs/zh/UserGuide/Operation Manual/SQL Reference.md b/docs/zh/UserGuide/Appendix/SQL Reference.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/SQL Reference.md
rename to docs/zh/UserGuide/Appendix/SQL Reference.md
diff --git a/docs/zh/UserGuide/Client/Status Codes.md b/docs/zh/UserGuide/Appendix/Status Codes.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Status Codes.md
rename to docs/zh/UserGuide/Appendix/Status Codes.md
diff --git a/docs/zh/UserGuide/Architecture/Shared Nothing Cluster.md b/docs/zh/UserGuide/Architecture/Shared Nothing Cluster.md
deleted file mode 100644
index 26528ca..0000000
--- a/docs/zh/UserGuide/Architecture/Shared Nothing Cluster.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-# Shared-nothing 架构
-
-正在开发中，敬请期待。
diff --git a/docs/zh/UserGuide/Client/Command Line Interface.md b/docs/zh/UserGuide/CLI/Command Line Interface.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Command Line Interface.md
rename to docs/zh/UserGuide/CLI/Command Line Interface.md
diff --git a/docs/zh/UserGuide/Server/Cluster Setup.md b/docs/zh/UserGuide/Cluster Setup/Cluster Setup.md
similarity index 100%
rename from docs/zh/UserGuide/Server/Cluster Setup.md
rename to docs/zh/UserGuide/Cluster Setup/Cluster Setup.md
diff --git a/docs/zh/UserGuide/Collaboration of Edge and Cloud/Sync Tool.md b/docs/zh/UserGuide/Collaboration of Edge and Cloud/Sync Tool.md
new file mode 100644
index 0000000..654eace
--- /dev/null
+++ b/docs/zh/UserGuide/Collaboration of Edge and Cloud/Sync Tool.md
@@ -0,0 +1,187 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# 端云协同
+
+## TsFile 同步工具
+
+### 介绍
+
+同步工具是定期将本地磁盘中新增的已持久化的tsfile文件上传至云端并加载到IoTDB的套件工具。
+
+在同步工具的发送端，同步模块是一个独立的进程，独立于本地的IoTDB。通过独立的脚本进行启动和关闭(详见章节`使用方式`)，同步的频率周期可由用户设置。
+
+在同步工具的接收端，同步模块内嵌于IoTDB的引擎，和IoTDB处于同一个进程中。同步模块监听一个独立的端口，该端口可由用户设置(详见章节`配置参数`)。用户使用前，需要在同步接收端设置同步白名单，以网段形式表示，接收端的同步模块只接受位于白名单网段中的发送端同步的数据。
+
+同步工具具有多对一的发送-接受模式，即一个同步接收端可以同时接受多个同步发送端传输的数据，一个同步发送端只能向一个同步接收端发送数据。
+
+> 注意：在使用同步工具前，同步工具的接收端和发送端需要单独配置。
+
+### 应用场景
+
+以一个工厂应用为例，通常有多个分厂和多个总厂，每个分厂中使用一个IoTDB实例收集数据，然后将数据定时汇总到总厂中进行备份或者分析等，一个总厂可以接收来自多个分厂的数据，在这种场景下每个IoTDB实例所管理的设备各不相同。
+
+在sync模块中，每个分厂是发送端，总厂是接收端，发送端定时将数据同步给接收端，在上述应用场景下一个设备的数据只能由一个发送端来收集，因此多个发送端同步的数据之间必须是没有设备重叠的，否则不符合sync功能的应用场景。
+
+当出现异常场景时，即两个或两个以上的发送端向同一个接收端同步相同设备(其存储组设为root.sg)的数据时，后被接收端收到的含有该设备数据的发送端的root.sg数据将会被拒绝接收。示例：发送端1向接收端同步存储组root.sg1和root.sg2, 发送端2向接收端同步存储组root.sg2和root.sg3,
+均包括时间序列root.sg2.d0.s0, 若接收端先接收到发送端1的root.sg2.d0.s0的数据，那么接收端将拒绝发送端2的root.sg2同步的数据。
+
+### 配置参数
+
+#### 同步工具接收端
+同步工具接收端的参数配置位于IoTDB的配置文件iotdb-engine.properties中，其安装目录为$IOTDB_HOME/conf/iotdb-engine.properties。在该配置文件中，有四个参数和同步接收端有关，配置说明如下:
+
+
+|参数名|is_sync_enable|
+|--- |--- |
+|描述|同步功能开关，配置为true表示接收端允许接收同步的数据并加载，设置为false的时候表示接收端不允许接收同步的数据|
+|类型|Boolean|
+|默认值|false|
+|改后生效方式|重启服务生效|
+
+|参数名|ip_white_list|
+|--- |--- |
+|描述|设置同步功能发送端IP地址的白名单，以网段的形式表示，多个网段之间用逗号分隔。发送端向接收端同步数据时，只有当该发送端IP地址处于该白名单设置的网段范围内，接收端才允许同步操作。如果白名单为空，则接收端不允许任何发送端同步数据。默认接收端接受全部IP的同步请求。|
+|类型|String|
+|默认值|0.0.0.0/0|
+|改后生效方式|重启服务生效|
+
+|参数名|sync_server_port|
+|--- |--- |
+|描述|同步接收端服务器监听接口，请确认该端口不是系统保留端口并且未被占用。参数is_sync_enable设置为true时有效，参数is_sync_enable设置为false时无效|
+|类型|Short Int : [0,65535]|
+|默认值|5555|
+|改后生效方式|重启服务生效|
+
+#### 同步工具发送端
+同步功能发送端的参数配置在一个单独的配置文件中，其安装目录为```$IOTDB_HOME/conf/iotdb-sync-client.properties```。在该配置文件中，有五个参数和同步发送端有关，配置说明如下：
+
+|参数名|server_ip|
+|--- |--- |
+|描述|同步接收端的IP地址|
+|类型|String|
+|默认值|127.0.0.1|
+|改后生效方式|重启同步功能发送端生效|
+
+|参数名|server_port|
+|--- |--- |
+|描述|同步接收端服务器监听端口，需要保证该端口和同步接收端配置的监听端口一致|
+|类型|Short Int : [0,65535]|
+|默认值|5555|
+|改后生效方式|重启同步功能发送端生效|
+
+|参数名|sync_period_in_second|
+|--- |--- |
+|描述|同步周期，两次同步任务开始时间的间隔，单位为秒(s)|
+|类型|Int : [0,2147483647]|
+|默认值|600|
+|改后生效方式|重启同步功能发送端生效|
+
+|参数名|sync_storage_groups|
+|--- |--- |
+|描述|进行同步的存储组列表，存储组间用逗号分隔；若列表设置为空表示同步所有存储组，默认为空|
+|类型|String|
+|示例|root.sg1, root.sg2|
+|改后生效方式|重启同步功能发送端生效|
+
+|参数名|max_number_of_sync_file_retry|
+|--- |--- |
+|描述|发送端同步文件到接收端失败时的最大重试次数|
+|类型|Int : [0,2147483647]|
+|示例|5|
+|改后生效方式|重启同步功能发送端生效|
+
+### 使用方式
+
+#### 启动同步功能接收端
+
+1. 配置接收端的参数，例如：
+
+```
+ ####################
+ ### Sync Server Configuration
+ ####################
+
+ # Whether to open the sync_server_port for receiving data from sync client, the default is closed
+ is_sync_enable=false
+
+ # Sync server port to listen
+ sync_server_port=5555
+
+ # White IP list of Sync client.
+ # Please use the form of network segment to present the range of IP, for example: 192.168.0.0/16
+ # If there are more than one IP segment, please separate them by commas
+ # The default is to allow all IP to sync
+ ip_white_list=0.0.0.0/0
+```
+
+2. 启动IoTDB引擎，同步功能接收端会同时启动，启动时LOG日志会出现`IoTDB: start SYNC ServerService successfully`字样，表示同步接收端启动成功.
+
+#### 关闭同步功能接收端
+
+关闭IoTDB，同步功能接收端会同时关闭。
+
+#### 启动同步功能发送端
+1. 配置发送端的参数
+
+```
+ # Sync receiver server address
+ server_ip=127.0.0.1
+
+ # Sync receiver server port
+ server_port=5555
+
+ # The period time of sync process, the time unit is second.
+ sync_period_in_second=600
+
+ # This parameter represents storage groups that participate in the synchronization task, which distinguishes each storage group by comma.
+ # If the list is empty, it means that all storage groups participate in synchronization.
+ # By default, it is empty list.
+ # sync_storage_groups = root.sg1, root.sg2
+
+ # The maximum number of retry when syncing a file to receiver fails.
+ max_number_of_sync_file_retry=5
+
+```
+2. 启动同步功能发送端
+
+用户可以使用```$IOTDB_HOME/tools```文件夹下的脚本启动同步功能的发送端
+Linux系统与MacOS系统启动命令如下：
+```
+ Shell >$IOTDB_HOME/tools/start-sync-client.sh
+```
+Windows系统启动命令如下：
+```
+ Shell >$IOTDB_HOME\tools\start-sync-client.bat
+```
+
+#### 关闭同步功能发送端
+
+用户可以使用```$IOTDB_HOME/tools```文件夹下的脚本关闭同步功能的发送端。
+Linux系统与MacOS系统停止命令如下：
+```
+ Shell >$IOTDB_HOME/tools/stop-sync-client.sh
+```
+Windows系统停止命令如下：
+```
+ Shell >$IOTDB_HOME\tools\stop-sync-client.bat
+```
+
diff --git a/docs/zh/UserGuide/Client/Programming - MQTT.md b/docs/zh/UserGuide/Communication Service Protocol/Programming - MQTT.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - MQTT.md
rename to docs/zh/UserGuide/Communication Service Protocol/Programming - MQTT.md
diff --git a/docs/zh/UserGuide/Client/Programming - Thrift.md b/docs/zh/UserGuide/Communication Service Protocol/Programming - Thrift.md
similarity index 100%
rename from docs/zh/UserGuide/Client/Programming - Thrift.md
rename to docs/zh/UserGuide/Communication Service Protocol/Programming - Thrift.md
diff --git a/docs/zh/UserGuide/Concept/Compression.md b/docs/zh/UserGuide/Data Concept/Compression.md
similarity index 100%
rename from docs/zh/UserGuide/Concept/Compression.md
rename to docs/zh/UserGuide/Data Concept/Compression.md
diff --git a/docs/zh/UserGuide/Concept/Data Model and Terminology.md b/docs/zh/UserGuide/Data Concept/Data Model and Terminology.md
similarity index 99%
rename from docs/zh/UserGuide/Concept/Data Model and Terminology.md
rename to docs/zh/UserGuide/Data Concept/Data Model and Terminology.md
index 56ff1b0..956f903 100644
--- a/docs/zh/UserGuide/Concept/Data Model and Terminology.md
+++ b/docs/zh/UserGuide/Data Concept/Data Model and Terminology.md
@@ -19,7 +19,8 @@
-->
-# 数据模型
+# 数据概念
+## 数据模型
本节，我们以电力场景为例，说明如何在IoTDB中创建一个正确的数据模型。
diff --git a/docs/zh/UserGuide/Concept/Data Type.md b/docs/zh/UserGuide/Data Concept/Data Type.md
similarity index 100%
rename from docs/zh/UserGuide/Concept/Data Type.md
rename to docs/zh/UserGuide/Data Concept/Data Type.md
diff --git a/docs/zh/UserGuide/Concept/Encoding.md b/docs/zh/UserGuide/Data Concept/Encoding.md
similarity index 100%
rename from docs/zh/UserGuide/Concept/Encoding.md
rename to docs/zh/UserGuide/Data Concept/Encoding.md
diff --git a/docs/zh/UserGuide/Concept/SDT.md b/docs/zh/UserGuide/Data Concept/SDT.md
similarity index 100%
rename from docs/zh/UserGuide/Concept/SDT.md
rename to docs/zh/UserGuide/Data Concept/SDT.md
diff --git a/docs/zh/UserGuide/Architecture/Writing Data on HDFS.md b/docs/zh/UserGuide/Ecosystem Integration/Writing Data on HDFS.md
similarity index 100%
rename from docs/zh/UserGuide/Architecture/Writing Data on HDFS.md
rename to docs/zh/UserGuide/Ecosystem Integration/Writing Data on HDFS.md
diff --git a/docs/zh/UserGuide/Get Started/Frequently asked questions.md b/docs/zh/UserGuide/FAQ/Frequently asked questions.md
similarity index 100%
rename from docs/zh/UserGuide/Get Started/Frequently asked questions.md
rename to docs/zh/UserGuide/FAQ/Frequently asked questions.md
diff --git a/docs/zh/UserGuide/Overview/Architecture.md b/docs/zh/UserGuide/IoTDB Introduction/Architecture.md
similarity index 100%
rename from docs/zh/UserGuide/Overview/Architecture.md
rename to docs/zh/UserGuide/IoTDB Introduction/Architecture.md
diff --git a/docs/zh/UserGuide/Overview/Features.md b/docs/zh/UserGuide/IoTDB Introduction/Features.md
similarity index 100%
rename from docs/zh/UserGuide/Overview/Features.md
rename to docs/zh/UserGuide/IoTDB Introduction/Features.md
diff --git a/docs/zh/UserGuide/Get Started/Publication.md b/docs/zh/UserGuide/IoTDB Introduction/Publication.md
similarity index 98%
rename from docs/zh/UserGuide/Get Started/Publication.md
rename to docs/zh/UserGuide/IoTDB Introduction/Publication.md
index 659ba68..39076ec 100644
--- a/docs/zh/UserGuide/Get Started/Publication.md
+++ b/docs/zh/UserGuide/IoTDB Introduction/Publication.md
@@ -19,7 +19,7 @@
-->
-# 研究论文
+## 研究论文
Apache IoTDB 始于清华大学软件学院。IoTDB 是一个用于管理大量时间序列数据的数据库，它采用了列式存储、数据编码、预计算和索引技术，具有类 SQL 的接口，可支持每秒每节点写入数百万数据点，可以秒级获得超过数万亿个数据点的查询结果。它还可以很容易地与 Apache Hadoop、MapReduce 和 Apache Spark 集成以进行分析。
@@ -31,7 +31,7 @@ Apache IoTDB 始于清华大学软件学院。IoTDB 是一个用于管理大量
* [The Design of Apache IoTDB distributed framework](http://ndbc2019.sdu.edu.cn/info/1002/1044.htm), Tianan Li, Jianmin Wang, Xiangdong Huang, Yi Xu, Dongfang Mao, Jun Yuan. NDBC 2019
* [Dual-PISA: An index for aggregation operations on time series data](https://www.sciencedirect.com/science/article/pii/S0306437918305489), Jialin Qiao, Xiangdong Huang, Jianmin Wang, Raymond K Wong. IS 2020
-# Benchmark工具
+## Benchmark工具
我们还研发了面向时间序列数据库的 Benchmark 工具：
diff --git a/docs/zh/UserGuide/Overview/Scenario.md b/docs/zh/UserGuide/IoTDB Introduction/Scenario.md
similarity index 100%
rename from docs/zh/UserGuide/Overview/Scenario.md
rename to docs/zh/UserGuide/IoTDB Introduction/Scenario.md
diff --git a/docs/zh/UserGuide/Overview/What is IoTDB.md b/docs/zh/UserGuide/IoTDB Introduction/What is IoTDB.md
similarity index 100%
rename from docs/zh/UserGuide/Overview/What is IoTDB.md
rename to docs/zh/UserGuide/IoTDB Introduction/What is IoTDB.md
diff --git a/docs/zh/UserGuide/Operation Manual/DDL Data Definition Language.md b/docs/zh/UserGuide/IoTDB-SQL Language/DDL Data Definition Language.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/DDL Data Definition Language.md
rename to docs/zh/UserGuide/IoTDB-SQL Language/DDL Data Definition Language.md
diff --git a/docs/zh/UserGuide/Operation Manual/DML Data Manipulation Language.md b/docs/zh/UserGuide/IoTDB-SQL Language/DML Data Manipulation Language.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/DML Data Manipulation Language.md
rename to docs/zh/UserGuide/IoTDB-SQL Language/DML Data Manipulation Language.md
diff --git a/docs/zh/UserGuide/Operation Manual/Maintenance Command.md b/docs/zh/UserGuide/IoTDB-SQL Language/Maintenance Command.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/Maintenance Command.md
rename to docs/zh/UserGuide/IoTDB-SQL Language/Maintenance Command.md
diff --git a/docs/zh/UserGuide/Server/Docker Image.md b/docs/zh/UserGuide/QuickStart/Docker Image.md
similarity index 100%
rename from docs/zh/UserGuide/Server/Docker Image.md
rename to docs/zh/UserGuide/QuickStart/Docker Image.md
diff --git a/docs/zh/UserGuide/Server/Download.md b/docs/zh/UserGuide/QuickStart/Download.md
similarity index 100%
rename from docs/zh/UserGuide/Server/Download.md
rename to docs/zh/UserGuide/QuickStart/Download.md
diff --git a/docs/zh/UserGuide/Architecture/Files.md b/docs/zh/UserGuide/QuickStart/Files.md
similarity index 100%
rename from docs/zh/UserGuide/Architecture/Files.md
rename to docs/zh/UserGuide/QuickStart/Files.md
diff --git a/docs/zh/UserGuide/Get Started/QuickStart.md b/docs/zh/UserGuide/QuickStart/QuickStart.md
similarity index 100%
rename from docs/zh/UserGuide/Get Started/QuickStart.md
rename to docs/zh/UserGuide/QuickStart/QuickStart.md
diff --git a/docs/zh/UserGuide/Server/ServerFileList.md b/docs/zh/UserGuide/QuickStart/ServerFileList.md
similarity index 100%
rename from docs/zh/UserGuide/Server/ServerFileList.md
rename to docs/zh/UserGuide/QuickStart/ServerFileList.md
diff --git a/docs/zh/UserGuide/Server/Single Node Setup.md b/docs/zh/UserGuide/QuickStart/Single Node Setup.md
similarity index 100%
rename from docs/zh/UserGuide/Server/Single Node Setup.md
rename to docs/zh/UserGuide/QuickStart/Single Node Setup.md
diff --git a/docs/zh/UserGuide/Operation Manual/Triggers.md b/docs/zh/UserGuide/UDF/Triggers.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/Triggers.md
rename to docs/zh/UserGuide/UDF/Triggers.md
diff --git a/docs/zh/UserGuide/Operation Manual/UDF User Defined Function.md b/docs/zh/UserGuide/UDF/UDF User Defined Function.md
similarity index 100%
rename from docs/zh/UserGuide/Operation Manual/UDF User Defined Function.md
rename to docs/zh/UserGuide/UDF/UDF User Defined Function.md
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index 0147b5b..6862d61 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -72,7 +72,7 @@ var config = {
{
text: 'Document',
items: [
- { text: 'In progress', link: '/UserGuide/Master/Get Started/QuickStart' },
+ { text: 'In progress', link: '/UserGuide/Master/QuickStart/QuickStart' },
{ text: 'V0.11.x', link: '/UserGuide/V0.11.x/Get Started/QuickStart' },
{ text: 'V0.10.x', link: '/UserGuide/V0.10.x/Get Started/QuickStart' },
{ text: 'V0.9.x', link: '/UserGuide/V0.9.x/0-Get Started/1-QuickStart' },
@@ -500,72 +500,80 @@ var config = {
collapsable: false,
},
{
- title: 'Get Started',
+ title: 'IOTDB Introduction',
children: [
- ['Get Started/QuickStart','QuickStart'],
- ['Get Started/Frequently asked questions','Frequently asked questions'],
- ['Get Started/Publication','Research Papers']
+ ['IOTDB Introduction/What is IoTDB','What is IoTDB'],
+ ['IOTDB Introduction/Architecture','Architecture'],
+ ['IOTDB Introduction/Scenario','Scenario'],
+ ['IOTDB Introduction/Features','Features'],
+ ['IOTDB Introduction/Publication','Publication']
]
},
{
- title: 'Overview',
+ title: 'Quick Start',
children: [
- ['Overview/What is IoTDB','What is IoTDB'],
- ['Overview/Architecture','Architecture'],
- ['Overview/Scenario','Scenario'],
- ['Overview/Features','Features']
+ ['Quick Start/QuickStart','QuickStart'],
+ ['Quick Start/Docker Image','Docker Image']
]
},
{
- title: 'Concept',
+ title: 'Data Concept',
children: [
- ['Concept/Data Model and Terminology','Data Model and Terminology'],
- ['Concept/Data Type','Data Type'],
- ['Concept/Encoding','Encoding'],
- ['Concept/Compression','Compression'],
- ['Concept/SDT','SDT']
+ ['Data Concept/Data Model and Terminology','Data Model and Terminology'],
+ ['Data Concept/Data Type','Data Type'],
+ ['Data Concept/Encoding','Encoding'],
+ ['Data Concept/Compression','Compression'],
+ ['Data Concept/SDT','SDT']
]
},
{
- title: 'Server',
+ title: 'CLI',
children: [
- ['Server/Download','Download'],
- ['Server/Single Node Setup','Single Node Setup'],
- ['Server/Cluster Setup','Cluster Setup'],
- ['Server/Config Manual','Config Manual'],
- ['Server/Docker Image','Docker Image']
+ ['CLI/Command Line Interface','Command Line Interface']
]
},
{
- title: 'Client',
+ title: 'Administration Management',
children: [
- ['Client/Command Line Interface','Command Line Interface'],
- ['Client/Programming - Native API','Native API'],
- ['Client/Programming - JDBC','JDBC'],
- ['Client/Programming - Other Languages','Other Languages'],
- ['Client/Programming - TsFile API','TsFile API'],
- ['Client/Programming - MQTT','MQTT'],
- ['Client/Status Codes','Status Codes']
+ ['Administration Management/Administration','Administration']
]
},
{
- title: 'Operation Manual',
+ title: 'IoTDB-SQL Language',
children: [
- ['Operation Manual/DDL Data Definition Language','DDL (Data Definition Language)'],
- ['Operation Manual/DML Data Manipulation Language','DML (Data Manipulation Language)'],
- ['Operation Manual/UDF User Defined Function','UDF (User Defined Function)'],
+ ['IoTDB-SQL Language/DDL Data Definition Language','DDL (Data Definition Language)'],
+ ['IoTDB-SQL Language/DML Data Manipulation Language','DML (Data Manipulation Language)'],
+ ['IoTDB-SQL Language/Maintenance Command','Maintenance Command']
+ ]
+ },
+ {
+ title: 'API',
+ children: [
+ ['API/Programming - JDBC','JDBC'],
+ ['API/Programming - Native API','Native API'],
+ ['API/Programming - Other Languages','Other Languages'],
+ ['API/Programming - TsFile API','TsFile API']
+ ]
+ },
+ {
+ title: 'UDF',
+ children: [
+ ['UDF/UDF User Defined Function','UDF (User Defined Function)'],
// The trigger module has not been implemented yet,
// so the website should not show users how to use it to avoid misleading.
- // ['Operation Manual/Triggers','Triggers'],
- ['Operation Manual/Kill Query','Kill Query'],
- ['Operation Manual/Administration','Administration'],
- ['Operation Manual/SQL Reference','SQL Reference']
+ // ['UDF/Triggers','Triggers'],
+ ]
+ },
+ {
+ title: 'Communication Service Protocol',
+ children: [
+ ['Communication Service Protocol/Programming - MQTT','Thrift'],
+ ['Communication Service Protocol/Programming - MQTT','MQTT'],
]
},
{
title: 'System Tools',
children: [
- ['System Tools/Sync Tool','Sync Tool'],
['System Tools/JMX Tool','JMX Tool'],
['System Tools/Watermark Tool','Watermark Tool'],
['System Tools/Query History Visualization Tool','Query History Visualization Tool'],
@@ -578,6 +586,12 @@ var config = {
]
},
{
+ title: 'Collaboration of Edge and Cloud',
+ children: [
+ ['Collaboration of Edge and Cloud/Sync Tool','Sync Tool']
+ ]
+ },
+ {
title: 'Ecosystem Integration',
children: [
['Ecosystem Integration/Grafana','Grafana'],
@@ -587,15 +601,28 @@ var config = {
['Ecosystem Integration/Hive TsFile','Hive TsFile'],
['Ecosystem Integration/Zeppelin-IoTDB','Zeppelin-IoTDB'],
['Ecosystem Integration/Flink IoTDB','Flink IoTDB'],
- ['Ecosystem Integration/Flink TsFile','Flink TsFile']
+ ['Ecosystem Integration/Flink TsFile','Flink TsFile'],
+ ['Ecosystem Integration/Writing Data on HDFS','Writing Data on HDFS'],
]
},
{
- title: 'Architecture',
+ title: 'Cluster Setup',
children: [
- ['Architecture/Files','Files'],
- ['Architecture/Writing Data on HDFS','Writing Data on HDFS'],
- ['Architecture/Shared Nothing Cluster','Shared Nothing Cluster']
+ ['Cluster Setup/Cluster Setup','Cluster Setup']
+ ]
+ },
+ {
+ title: 'FAQ',
+ children: [
+ ['FAQ/Frequently asked questions','Frequently asked questions']
+ ]
+ },
+ {
+ title: 'Appendix',
+ children: [
+ ['Appendix/Config Manual','Config Manual'],
+ ['Appendix/SQL Reference','SQL Reference'],
+ ['Appendix/Status Codes','Status Codes']
]
},
{
@@ -1126,103 +1153,129 @@ var config = {
collapsable: false,
},
{
- title: '开始',
+ title: 'IoTDB简介',
children: [
- ['Get Started/QuickStart','快速入门'],
- ['Get Started/Frequently asked questions','常见问题'],
- ['Get Started/Publication','调查报告']
+ ['IOTDB Introduction/What is IoTDB','IoTDB简介'],
+ ['IOTDB Introduction/Features','主要功能特点'],
+ ['IOTDB Introduction/Architecture','系统架构'],
+ ['IOTDB Introduction/Scenario','应用场景'],
+ ['IOTDB Introduction/Publication','研究论文']
]
},
{
- title: '概述',
+ title: '快速上手',
children: [
- ['Overview/What is IoTDB','什么是IoTDB'],
- ['Overview/Architecture','架构'],
- ['Overview/Scenario','场景'],
- ['Overview/Features','特征']
+ ['Quick Start/QuickStart','快速上手'],
+ ['Quick Start/Docker Image','Docker 镜像']
]
},
{
- title: '概念',
+ title: '数据概念',
children: [
- ['Concept/Data Model and Terminology','数据模型与技术'],
- ['Concept/Data Type','数据类型'],
- ['Concept/Encoding','编码方式'],
- ['Concept/Compression','压缩方式'],
- ['Concept/SDT','旋转门压缩']
+ ['Data Concept/Data Model and Terminology','数据模型'],
+ ['Data Concept/Data Type','数据类型'],
+ ['Data Concept/Encoding','编码方式'],
+ ['Data Concept/Compression','压缩方式'],
+ ['Data Concept/SDT','旋转门压缩']
]
},
{
- title: '服务器端',
+ title: 'SQL命令行终端(CLI)',
children: [
- ['Server/Download','下载'],
- ['Server/Single Node Setup','单节点安装'],
- ['Server/Cluster Setup','集群设置'],
- ['Server/Config Manual','配置手册'],
- ['Server/Docker Image','Docker镜像'],
- ['Server/ServerFileList','服务端文件列表']
+ ['CLI/Command Line Interface','SQL命令行终端(CLI)']
]
},
{
- title: '客户端',
+ title: '权限管理',
children: [
- ['Client/Command Line Interface','命令行接口(CLI)'],
- ['Client/Programming - Native API','原生接口'],
- ['Client/Programming - JDBC','JDBC'],
- ['Client/Programming - Other Languages','其他语言'],
- ['Client/Programming - TsFile API','TsFile API'],
- ['Client/Programming - MQTT','MQTT'],
- ['Client/Status Codes','状态码']
+ ['Administration Management/Administration','权限管理']
]
},
{
- title: '操作指南',
+ title: 'IoTDB-SQL 语言',
children: [
- ['Operation Manual/DDL Data Definition Language','DDL (数据定义语言)'],
- ['Operation Manual/DML Data Manipulation Language','DML (数据操作语言)'],
- ['Operation Manual/UDF User Defined Function','UDF（用户自定义函数）'],
+ ['IoTDB-SQL Language/DDL Data Definition Language','数据定义语言（DDL）'],
+ ['IoTDB-SQL Language/DML Data Manipulation Language','数据操作语言（DML）'],
+ ['IoTDB-SQL Language/Maintenance Command','运维命令']
+ ]
+ },
+ {
+ title: '应用编程接口',
+ children: [
+ ['API/Programming - JDBC','JDBC'],
+ ['API/Programming - Native API','Java 原生接口'],
+ ['API/Programming - Other Languages','其他语言原生接口'],
+ ['API/Programming - TsFile API','TsFile API']
+ ]
+ },
+ {
+ title: '用户定义函数(UDF)',
+ children: [
+ ['UDF/UDF User Defined Function','用户定义函数(UDF)'],
// The trigger module has not been implemented yet,
// so the website should not show users how to use it to avoid misleading.
- // ['Operation Manual/Triggers','触发器'],
- ['Operation Manual/Kill Query','中止查询'],
- ['Operation Manual/Administration','权限管理语句'],
- ['Operation Manual/SQL Reference','SQL 参考文档']
+ // ['UDF/Triggers','Triggers'],
+ ]
+ },
+ {
+ title: '通信服务协议',
+ children: [
+ ['Communication Service Protocol/Programming - MQTT','Thrift'],
+ ['Communication Service Protocol/Programming - MQTT','MQTT'],
]
},
{
title: '系统工具',
children: [
- ['System Tools/Sync Tool','同步工具'],
- ['System Tools/JMX Tool','JMX工具'],
- ['System Tools/Watermark Tool','水印工具'],
+ ['System Tools/Load External Tsfile','加载 TsFile'],
+ ['System Tools/Performance Tracing Tool','查询性能追踪'],
+ ['System Tools/CSV Tool','导入导出 CSV'],
+ ['System Tools/Monitor and Log Tools','监控工具和系统日志'],
+ ['System Tools/JMX Tool','JMX 工具'],
+ ['System Tools/MLogParser Tool','Mlog解析工具'],
+ ['System Tools/NodeTool','节点工具'],
['System Tools/Query History Visualization Tool','查询历史可视化工具'],
- ['System Tools/Monitor and Log Tools','监控与日志工具'],
- ['System Tools/Load External Tsfile','加载外部tsfile文件'],
- ['System Tools/Performance Tracing Tool','性能追踪工具'],
- ['System Tools/MLogParser Tool','MLog解析工具'],
- ['System Tools/NodeTool','集群状态工具'],
- ['System Tools/CSV Tool','CSV工具']
+ ['System Tools/Watermark Tool','水印工具'],
]
},
{
- title: '生态集成',
+ title: '端云协同',
children: [
- ['Ecosystem Integration/Grafana','Grafana'],
- ['Ecosystem Integration/MapReduce TsFile','MapReduce TsFile'],
- ['Ecosystem Integration/Spark TsFile','Spark TsFile'],
- ['Ecosystem Integration/Spark IoTDB','Spark IoTDB'],
- ['Ecosystem Integration/Hive TsFile','Hive TsFile'],
+ ['Collaboration of Edge and Cloud/Sync Tool','TsFile 同步工具']
+ ]
+ },
+ {
+ title: '系统集成',
+ children: [
+ ['Ecosystem Integration/Grafana','Grafana-IoTDB'],
['Ecosystem Integration/Zeppelin-IoTDB','Zeppelin-IoTDB'],
- ['Ecosystem Integration/Flink IoTDB','Flink IoTDB'],
- ['Ecosystem Integration/Flink TsFile','Flink TsFile']
+ ['Ecosystem Integration/Spark TsFile','Spark TsFile'],
+ ['Ecosystem Integration/MapReduce TsFile','Hadoop-TsFile'],
+ ['Ecosystem Integration/Spark IoTDB','Spark-IoTDB'],
+ ['Ecosystem Integration/Hive TsFile','Hive-TsFile'],
+ ['Ecosystem Integration/Flink TsFile','Flink-TsFile'],
+ ['Ecosystem Integration/Flink IoTDB','Flink-IoTDB'],
+ ['Ecosystem Integration/Writing Data on HDFS','HDFS集成'],
]
},
{
- title: '系统设计',
+ title: '集群搭建',
children: [
- ['Architecture/Files','文件'],
- ['Architecture/Writing Data on HDFS','使用HDFS存储数据'],
- ['Architecture/Shared Nothing Cluster','Shared-nothing 架构']
+ ['Cluster Setup/Cluster Setup','集群搭建']
+ ]
+ },
+ {
+ title: '常见问题',
+ children: [
+ ['FAQ/Frequently asked questions','常见问题']
+ ]
+ },
+ {
+ title: '附录',
+ children: [
+ ['Appendix/Config Manual','附录1: 配置参数'],
+ ['Appendix/SQL Reference','附录2: SQL 参考文档'],
+ ['Appendix/Status Codes','附录3: 状态码']
]
}
],