You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by hx...@apache.org on 2019/08/09 02:34:04 UTC
[incubator-iotdb] branch master updated: Update documents according
to #332 (#333)
This is an automated email from the ASF dual-hosted git repository.
hxd 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 a0e51c9 Update documents according to #332 (#333)
a0e51c9 is described below
commit a0e51c9033ea6fe5b2e527df8292603919b486d0
Author: Boris <zh...@gmail.com>
AuthorDate: Fri Aug 9 10:31:17 2019 +0800
Update documents according to #332 (#333)
* Update documents according to https://github.com/apache/incubator-iotdb/pull/332 (for fitting new distribution structure）
---
README.md | 12 ++++++++----
.../2-Concept Key Concepts and Terminology/2-Data Type.md | 2 +-
docs/Documentation/Frequently asked questions.md | 5 +++--
docs/Documentation/QuickStart.md | 13 +++++++------
.../2-Concept Key Concepts and Terminology/2-Data Type.md | 2 +-
.../UserGuide/4-Deployment and Management/1-Deployment.md | 5 +++--
6 files changed, 23 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index b572deb..564583b 100644
--- a/README.md
+++ b/README.md
@@ -86,9 +86,9 @@ incubator-iotdb/ <-- root path
+- pom.xml
```
-Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
+Let `$IOTDB_HOME = /workspace/incubator-iotdb/server/target/iotdb-server-{project.version}`
-Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli
+Let `$IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/target/iotdb-client-{project.version}`
Note:
* if `IOTDB_HOME` is not explicitly assigned,
@@ -133,7 +133,7 @@ If successful, you will see the the following text in the terminal:
Otherwise, you may need to check the error statements and fix the problems.
-After build, the IoTDB project will be at the folder "server/iotdb". The folder will include the following contents:
+After build, the IoTDB project will be at the folder "server/target/iotdb-server-{project.version}". The folder will include the following contents:
```
server/iotdb/ <-- root path
@@ -151,7 +151,7 @@ server/iotdb/ <-- root path
Before starting to use IoTDB, you need to config the configuration files first. For your convenience, we have already set the default config in the files.
-In total, we provide users three kinds of configurations module: environment config module (iotdb-env.bat, iotdb-env.sh), system config module (tsfile-format.properties, iotdb-engine.properties) and log config module (logback.xml). All of these kinds of configuration files are put in iotdb/config folder.
+In total, we provide users three kinds of configurations module: environment config module (`iotdb-env.bat`, `iotdb-env.sh`), system config module (`tsfile-format.properties`, `iotdb-engine.properties`) and log config module (`logback.xml`). All of these kinds of configuration files are put in iotdb/config folder.
For more, you are advised to check our documentation [Chapter4: Deployment and Management](https://iotdb.apache.org/#/Documents/0.8.0/chap4/sec1) in detail.
@@ -191,7 +191,11 @@ Now let's trying to read and write some data from IoTDB using our Client. To sta
/workspace/incubator-iotdb
> mvn clean package -pl client -am -Dmaven.test.skip=true
+```
+
+After build, the IoTDB client will be at the folder "client/target/iotdb-client-{project.version}".
+```
# Unix/OS X
> $IOTDB_CLI_HOME/sbin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>
diff --git a/docs/Documentation-CHN/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md b/docs/Documentation-CHN/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
index 2bf7287..c0900c6 100644
--- a/docs/Documentation-CHN/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
+++ b/docs/Documentation-CHN/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
@@ -32,7 +32,7 @@ IoTDB支持:
一共六种数据类型。
-其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](/#/Documents/0.8.0/chap2/sec3)或[TS_2DIFF](/#/Documents/0.8.0/chap2/sec3)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.1节](/#/Documents/0.8.0/chap5/sec1)，若不指定则系统会根据配置文件tsfile-format.properties文件中的[float_precision项](/#/Documents/0.8.0/chap4/sec2)配置。
+其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](/#/Documents/0.8.0/chap2/sec3)或[TS_2DIFF](/#/Documents/0.8.0/chap2/sec3)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.1节](/#/Documents/0.8.0/chap5/sec1)，若不指定则系统会根据配置文件`tsfile-format.properties`文件中的[float_precision项](/#/Documents/0.8.0/chap4/sec2)配置。
当系统中用户输入的数据类型与该时间序列的数据类型不对应时，系统会提醒类型错误，如下所示，二阶差分不支持布尔类型的编码：
diff --git a/docs/Documentation/Frequently asked questions.md b/docs/Documentation/Frequently asked questions.md
index 953f9c3..b359c67 100644
--- a/docs/Documentation/Frequently asked questions.md
+++ b/docs/Documentation/Frequently asked questions.md
@@ -80,8 +80,9 @@ Readme.md
...
```
-Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb
-Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli/
+Let `$IOTDB_HOME = /workspace/incubator-iotdb/server/target/iotdb-server-{project.version}`
+
+Let `$IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/target/iotdb-client-{project.version}`
By default settings, the logs are stored under ```IOTDB_HOME/logs```. You can change log level and storage path by configuring ```logback.xml``` under ```IOTDB_HOME/conf```.
diff --git a/docs/Documentation/QuickStart.md b/docs/Documentation/QuickStart.md
index 3e1b860..3d5e579 100755
--- a/docs/Documentation/QuickStart.md
+++ b/docs/Documentation/QuickStart.md
@@ -79,8 +79,9 @@ incubator-iotdb/ <-- root path
+- pom.xml
```
-Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
-Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli/
+Let `$IOTDB_HOME = /workspace/incubator-iotdb/server/target/iotdb-server-{project.version}`
+
+Let `$IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/target/iotdb-client-{project.version}`
Note:
* if `IOTDB_HOME` is not explicitly assigned,
@@ -149,11 +150,11 @@ Before starting to use IoTDB, you need to config the configuration files first.
In total, we provide users three kinds of configurations module:
-* environment config module (iotdb-env.`sh`(Linux or OSX), iotdb-env.`bat`(Windows))
-* system config module (tsfile-format.properties, iotdb-engine.properties)
-* log config module (logback.xml)
+* environment config module (`iotdb-env.sh`(Linux or OSX), `iotdb-env.bat`(Windows))
+* system config module (`tsfile-format.properties`, `iotdb-engine.properties`)
+* log config module (`logback.xml`)
-The configuration files of the three configuration items are located in the IoTDB installation directory: $IOTDB_HOME/conf folder. For more, you are advised to check Chapter 4 of the User Guide to give you the details.
+The configuration files of the three configuration items are located in the IoTDB installation directory: `$IOTDB_HOME/conf` folder. For more, you are advised to check Chapter 4 of the User Guide to give you the details.
## Start
diff --git a/docs/Documentation/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md b/docs/Documentation/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
index ffd1e80..8c3b553 100644
--- a/docs/Documentation/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
+++ b/docs/Documentation/UserGuide/2-Concept Key Concepts and Terminology/2-Data Type.md
@@ -31,7 +31,7 @@ IoTDB supports six data types in total:
* TEXT (String).
-The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](/#/Documents/0.8.0/chap5/sec1) for more information on how to specify), which is the number of digits after the decimal point of the floating point number, if the encoding method is [RLE](/#/Documents/0.8.0/chap2/sec3) or [TS\_2DIFF](/#/Documents/0.8.0/chap2/sec3) (Refer to [Create Timeseries Statement](/#/Documents/0.8.0/chap5/sec1) for more information on how to specify). If MAX\_POINT\_NU [...]
+The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](/#/Documents/0.8.0/chap5/sec1) for more information on how to specify), which is the number of digits after the decimal point of the floating point number, if the encoding method is [RLE](/#/Documents/0.8.0/chap2/sec3) or [TS\_2DIFF](/#/Documents/0.8.0/chap2/sec3) (Refer to [Create Timeseries Statement](/#/Documents/0.8.0/chap5/sec1) for more information on how to specify). If MAX\_POINT\_NU [...]
* For Float data value, The data range is (-Integer.MAX_VALUE, Integer.MAX_VALUE), rather than Float.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(float) in Java.
* For Double data value, The data range is (-Long.MAX_VALUE, Long.MAX_VALUE), rather than Double.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(double) in Java (Long.MAX_VALUE=9.22E18).
diff --git a/docs/Documentation/UserGuide/4-Deployment and Management/1-Deployment.md b/docs/Documentation/UserGuide/4-Deployment and Management/1-Deployment.md
index ceddb8f..1396041 100644
--- a/docs/Documentation/UserGuide/4-Deployment and Management/1-Deployment.md
+++ b/docs/Documentation/UserGuide/4-Deployment and Management/1-Deployment.md
@@ -94,8 +94,9 @@ incubator-iotdb/ <-- root path
+- pom.xml
```
-Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
-Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli/
+Let `$IOTDB_HOME = /workspace/incubator-iotdb/server/target/iotdb-server-{project.version}`
+
+Let `$IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/target/iotdb-client-{project.version}`
Note:
* if `IOTDB_HOME` is not explicitly assigned,