This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new c844d10 fix doc errors (#542)
c844d10 is described below
commit c844d10c3560d7251523f3a06c35c21b3cccb9e7
Author: Haonan <[email protected]>
AuthorDate: Tue Nov 12 14:09:42 2019 +0800
fix doc errors (#542)
---
...e(CLI).md => 1-Command Line Interface (CLI).md} | 2 +-
...e Hadoop Connector.md => 2-MapReduce TsFile.md} | 2 +-
...TsFile Spark Connector.md => 3-Spark TsFile.md} | 0
...4-Spark IoTDB Connector.md => 4-Spark IoTDB.md} | 0
...5-Tsfile Hive Connector.md => 5-Hive TsFile.md} | 0
.../8-System Design (Developer)/2-Files.md | 34 ++++++++--------------
docs/Documentation/UserGuide/0-Content.md | 10 +++----
.../UserGuide/3-Server/4-Config Manual.md | 2 +-
.../7-Ecosystem Integration/2-MapReduce TsFile.md | 2 +-
.../8-System Design (Developer)/2-Files.md | 6 ++--
10 files changed, 24 insertions(+), 34 deletions(-)
diff --git a/docs/Documentation-CHN/UserGuide/4-Client/1-Command Line
Interface(CLI).md b/docs/Documentation-CHN/UserGuide/4-Client/1-Command Line
Interface (CLI).md
similarity index 99%
rename from docs/Documentation-CHN/UserGuide/4-Client/1-Command Line
Interface(CLI).md
rename to docs/Documentation-CHN/UserGuide/4-Client/1-Command Line Interface
(CLI).md
index 3017d9e..f4ef981 100644
--- a/docs/Documentation-CHN/UserGuide/4-Client/1-Command Line
Interface(CLI).md
+++ b/docs/Documentation-CHN/UserGuide/4-Client/1-Command Line Interface
(CLI).md
@@ -30,7 +30,7 @@
<!-- /TOC -->
-# Command Line Interface(CLI)
+# Command Line Interface (CLI)
IOTDB为用户提供Client/Shell工具用于启动客户端和服务端程序。下面介绍每个Client/Shell工具的运行方式和相关参数。
> \$IOTDB\_HOME表示IoTDB的安装目录所在路径。
diff --git a/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/2-TsFile
Hadoop Connector.md b/docs/Documentation-CHN/UserGuide/7-Ecosystem
Integration/2-MapReduce TsFile.md
similarity index 99%
rename from docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/2-TsFile
Hadoop Connector.md
rename to docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md
index 2ff68cf..f82b06d 100644
--- a/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/2-TsFile Hadoop
Connector.md
+++ b/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md
@@ -19,7 +19,7 @@
-->
# 第7章: 生态集成
-# TsFile的Hadoop连接器
+# MapReduce TsFile
<!-- TOC -->
## 概要
diff --git a/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/3-TsFile
Spark Connector.md b/docs/Documentation-CHN/UserGuide/7-Ecosystem
Integration/3-Spark TsFile.md
similarity index 100%
rename from docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/3-TsFile
Spark Connector.md
rename to docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/3-Spark
TsFile.md
diff --git a/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/4-Spark
IoTDB Connector.md b/docs/Documentation-CHN/UserGuide/7-Ecosystem
Integration/4-Spark IoTDB.md
similarity index 100%
rename from docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/4-Spark
IoTDB Connector.md
rename to docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/4-Spark
IoTDB.md
diff --git a/docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/5-Tsfile
Hive Connector.md b/docs/Documentation-CHN/UserGuide/7-Ecosystem
Integration/5-Hive TsFile.md
similarity index 100%
rename from docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/5-Tsfile
Hive Connector.md
rename to docs/Documentation-CHN/UserGuide/7-Ecosystem Integration/5-Hive
TsFile.md
diff --git a/docs/Documentation-CHN/UserGuide/8-System Design
(Developer)/2-Files.md b/docs/Documentation-CHN/UserGuide/8-System Design
(Developer)/2-Files.md
index 1c8f38b..e6bd62b 100644
--- a/docs/Documentation-CHN/UserGuide/8-System Design (Developer)/2-Files.md
+++ b/docs/Documentation-CHN/UserGuide/8-System Design (Developer)/2-Files.md
@@ -29,45 +29,35 @@ IoTDB需要存储的数据分为三类，分别为数据文件、系统文件以
### 数据文件
-数据文件存储了用户写入IoTDB系统的所有数据。包含TsFile文件和其他文件，其中，TsFile文件可以通过配置项`tsfile_dir`配置存储路径（详情见[tsfile_dir配置项](/#/Documents/progress/chap3/sec2)），其他文件可通过[data_dir配置项](/#/Documents/progress/chap3/sec2)进行配置。
+数据文件存储了用户写入IoTDB系统的所有数据。包含TsFile文件和其他文件，可通过[data_dirs配置项](/#/Documents/progress/chap3/sec4)进行配置。
-为了更好的支持用户对于磁盘空间扩展等存储需求，IoTDB为TsFile的存储配置增加了多文件目录的存储方式，用户可自主配置多个存储路径作为数据的持久化位置（详情见[tsfile_dir配置项](/#/Documents/progress/chap3/sec2)），并可以指定或自定义目录选择策略（详情见[mult_dir_strategy配置项](/#/Documents/progress/chap3/sec2)）。
+为了更好的支持用户对于磁盘空间扩展等存储需求，IoTDB为TsFile的存储配置增加了多文件目录的存储方式，用户可自主配置多个存储路径作为数据的持久化位置（详情见[data_dirs配置项](/#/Documents/progress/chap3/sec4)），并可以指定或自定义目录选择策略（详情见[mult_dir_strategy配置项](/#/Documents/progress/chap3/sec4)）。
### 系统文件
-系统Schema文件，存储了数据文件的元数据信息。可通过sys_dir配置项进行配置（详情见[sys_dir配置项](/#/Documents/progress/chap3/sec2)）。
+系统Schema文件，存储了数据文件的元数据信息。可通过base_dir配置项进行配置（详情见[base_dir配置项](/#/Documents/progress/chap3/sec4)）。
### 写前日志文件
-写前日志文件存储了系统的写前日志。可通过`wal_dir`配置项进行配置（详情见[wal_dir配置项](/#/Documents/progress/chap3/sec2)）。
+写前日志文件存储了系统的写前日志。可通过`wal_dir`配置项进行配置（详情见[wal_dir配置项](/#/Documents/progress/chap3/sec4)）。
### 数据存储目录设置举例
接下来我们将举一个数据目录配置的例子，来具体说明如何配置数据的存储目录。
-IoTDB涉及到的所有数据目录路径有：data_dir, tsfile_dir, mult_dir_strategy,
sys_dir和wal_dir，它们分别涉及的是IoTDB的数据文件、系统文件以及写前日志文件。您可以选择输入路径自行配置，也可以不进行任何操作使用系统默认的配置项（关于各个配置项的具体内容见本文第5.2.2.2.2节）。
+IoTDB涉及到的所有数据目录路径有：data_dirs, mult_dir_strategy,
base_dir和wal_dir，它们分别涉及的是IoTDB的数据文件、系统文件以及写前日志文件。您可以选择输入路径自行配置，也可以不进行任何操作使用系统默认的配置项。
以下我们给出一个用户对五个目录都进行自行配置的例子。
```
-data_dir = D:\\iotdb\\data\\data
-tsfile_dir = E:\\iotdb\\data\\data1, data\\data2, F:\\data3
mult_dir_strategy
= MaxDiskUsableSpaceFirstStrategy
sys_dir = data\\system
wal_dir = data
-
+base_dir = $IOTDB_HOME/data
+data_dirs = /data1/data, /data2/data, /data3/data
+multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
+wal_dir= $IOTDB_HOME/data/wal
```
按照上述配置，系统会：
-* 将除TsFile之外的数据文件存储在D:\iotdb\data\data
-*
将TsFile存储在路径E:\iotdb\data\data1、路径%IOTDB_HOME%\data\data2和路径F:\data3中。且对这三个路径的选择策略是：`优先选择磁盘剩余空间最大的目录`，即在每次数据持久化到磁盘时系统会自动选择磁盘剩余空间最大的一个目录将数据进行写入
-* 将TsFile之外的其他数据文件存储在路径D:\\iotdb\\data\\data中
-* 将系统文件存储在%IOTDB_HOME%\data\system
-* 将写前日志文件存储在%IOTDB_HOME%\data
-
-> 如果对上述TsFile的目录进行了修改，那么需要将旧目录中的所有TsFile移动到新的目录中，并且要严格按照目录的顺序。
-> 如果您在TsFile的目录中增加了新路径，那么IoTDB会直接将该目录纳入到多目录选择的范围中，用户无需有其他的操作。
-
-例如，将tsfile_dir修改为
-```
-D:\\data4, E:\\data5, F:\\data6
-```
+*
将TsFile存储在路径/data1/data、路径/data2/data和路径data3/data3中。且对这三个路径的选择策略是：`优先选择磁盘剩余空间最大的目录`，即在每次数据持久化到磁盘时系统会自动选择磁盘剩余空间最大的一个目录将数据进行写入
+* 将系统文件存储在$IOTDB_HOME/data
+* 将写前日志文件存储在$IOTDB_HOME/data/wal
-那么就需要将E:\iotdb\data\data1中的文件移动到D:\data4，%IOTDB_HOME%\data\data2的文件移动到E:\data5，F:\data3的文件移动到F:\data6。系统即可继续正常运行。
diff --git a/docs/Documentation/UserGuide/0-Content.md
b/docs/Documentation/UserGuide/0-Content.md
index db757f2..b289fbb 100644
--- a/docs/Documentation/UserGuide/0-Content.md
+++ b/docs/Documentation/UserGuide/0-Content.md
@@ -41,7 +41,7 @@
* 4-Config Manual
* 5-Docker Image
# Chapter 4: Client
-* 1-Command Line Interface(CLI)
+* 1-Command Line Interface (CLI)
* 2-Programming - JDBC
* 3-Programming - Session
* 4-Programming - Other Languages
@@ -61,10 +61,10 @@
* 7-Monitor and Log Tools
# Chapter 7: Ecosystem Integration
* 1-Grafana
-* 2-TsFile Hadoop Connector
-* 3-TsFile Spark Connector
-* 4-Spark IoTDB Connector
-* 5-TsFile Hive Connector
+* 2-MapReduce TsFile
+* 3-Spark TsFile
+* 4-Spark IoTDB
+* 5-Hive TsFile
# Chapter 8: System Design (Developer)
* 1-Hierarchy
* 2-Files
diff --git a/docs/Documentation/UserGuide/3-Server/4-Config Manual.md
b/docs/Documentation/UserGuide/3-Server/4-Config Manual.md
index 26a2b65..450d645 100644
--- a/docs/Documentation/UserGuide/3-Server/4-Config Manual.md
+++ b/docs/Documentation/UserGuide/3-Server/4-Config Manual.md
@@ -206,7 +206,7 @@ The detail of each variables are as follows:
|Name| data\_dirs |
|:---:|:---|
-|Description| The directories of data files. Multiple directories are
separated by comma. See the
[multi\_dir\_strategy](/#/Documents/progress/chap4/sec2) configuration item for
data distribution strategy. The starting directory of the relative path is
related to the operating system. It is recommended to use an absolute path. If
the path does not exist, the system will automatically create it.|
+|Description| The directories of data files. Multiple directories are
separated by comma. The starting directory of the relative path is related to
the operating system. It is recommended to use an absolute path. If the path
does not exist, the system will automatically create it.|
|Type|String[]|
|Default| data/data |
|Effective|After restart system|
diff --git a/docs/Documentation/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md b/docs/Documentation/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md
index 5029ce4..8cc1f9c 100644
--- a/docs/Documentation/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md
+++ b/docs/Documentation/UserGuide/7-Ecosystem Integration/2-MapReduce
TsFile.md
@@ -19,7 +19,7 @@
-->
# Chapter 7: Ecosystem Integration
-# TsFile-Hadoop-Connector
+# MapReduce TsFile
<!-- TOC -->
## Outline
diff --git a/docs/Documentation/UserGuide/8-System Design
(Developer)/2-Files.md b/docs/Documentation/UserGuide/8-System Design
(Developer)/2-Files.md
index 75f3162..3905707 100644
--- a/docs/Documentation/UserGuide/8-System Design (Developer)/2-Files.md
+++ b/docs/Documentation/UserGuide/8-System Design (Developer)/2-Files.md
@@ -29,13 +29,13 @@ The data that IoTDB stores is divided into three
categories, namely data files,
### Data Files
-Data files store all the data that the user wrote to IoTDB, which contains
TsFile and other files. TsFile storage directory can be configured with the
`data_dirs` configuration item (see [file
layer](/#/Documents/progress/chap3/sec2) for details). Other files can be
configured through [data_dirs](/#/Documents/progress/chap3/sec2) configuration
item (see [Engine Layer](/#/Documents/progress/chap3/sec2) for details).
+Data files store all the data that the user wrote to IoTDB, which contains
TsFile and other files. TsFile storage directory can be configured with the
`data_dirs` configuration item (see [file
layer](/#/Documents/progress/chap3/sec4) for details). Other files can be
configured through [data_dirs](/#/Documents/progress/chap3/sec4) configuration
item (see [Engine Layer](/#/Documents/progress/chap3/sec4) for details).
-In order to better support users' storage requirements such as disk space
expansion, IoTDB supports multiple file directories storage methods for TsFile
storage configuration. Users can set multiple storage paths as data storage
locations( see [data_dirs](/#/Documents/progress/chap3/sec2) configuration
item), and you can specify or customize the directory selection policy (see
[multi_dir_strategy](/#/Documents/progress/chap3/sec2) configuration item for
details).
+In order to better support users' storage requirements such as disk space
expansion, IoTDB supports multiple file directories storage methods for TsFile
storage configuration. Users can set multiple storage paths as data storage
locations( see [data_dirs](/#/Documents/progress/chap3/sec4) configuration
item), and you can specify or customize the directory selection policy (see
[multi_dir_strategy](/#/Documents/progress/chap3/sec4) configuration item for
details).
### System files
-System files include schema files, which store metadata information of data in
IoTDB. It can be configured through the `base_dir` configuration item (see
[System Layer](/#/Documents/progress/chap3/sec2) for details).
+System files include schema files, which store metadata information of data in
IoTDB. It can be configured through the `base_dir` configuration item (see
[System Layer](/#/Documents/progress/chap3/sec4) for details).
### Pre-write Log Files
