You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2020/04/06 09:27:49 UTC
[incubator-iotdb] branch rel/0.9 updated: remove
tsfile-format.properties
This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch rel/0.9
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
The following commit(s) were added to refs/heads/rel/0.9 by this push:
new 0a5708d remove tsfile-format.properties
0a5708d is described below
commit 0a5708dbd258ba8ae3ec6d3de6aa19f6cecaf347
Author: qiaojialin <64...@qq.com>
AuthorDate: Mon Apr 6 17:27:35 2020 +0800
remove tsfile-format.properties
---
README.md | 2 +-
docs/UserGuide/0-Get Started/1-QuickStart.md | 2 +-
docs/UserGuide/2-Concept/2-Data Type.md | 2 +-
docs/UserGuide/3-Server/4-Config Manual.md | 3 +--
docs/UserGuide/4-Client/5-Programming - TsFile API.md | 10 +++-------
docs/UserGuide/8-System Design/3-Writing Data on HDFS.md | 4 +++-
docs/zh/UserGuide/0-Get Started/1-QuickStart.md | 2 +-
docs/zh/UserGuide/2-Concept/2-Data Type.md | 2 +-
docs/zh/UserGuide/3-Server/4-Config Manual.md | 6 ++----
docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md | 10 +++-------
docs/zh/UserGuide/8-System Design/3-Writing Data on HDFS.md | 4 +++-
11 files changed, 20 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index 9096ef8..7262a4a 100644
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ Then the binary version (including both server and client) can be found at **dis
configuration files are under "conf" folder
* environment config module (`iotdb-env.bat`, `iotdb-env.sh`),
- * system config module (`tsfile-format.properties`, `iotdb-engine.properties`)
+ * system config module (`iotdb-engine.properties`)
* log config module (`logback.xml`).
For more, see [Chapter3: Server](https://iotdb.apache.org/#/Documents/0.9.x/chap3/sec1) and [Chapter4: Client](https://iotdb.apache.org/#/Documents/0.9.x/chap4/sec1) in detail.
diff --git a/docs/UserGuide/0-Get Started/1-QuickStart.md b/docs/UserGuide/0-Get Started/1-QuickStart.md
index 3b61d67..a0a53e3 100644
--- a/docs/UserGuide/0-Get Started/1-QuickStart.md
+++ b/docs/UserGuide/0-Get Started/1-QuickStart.md
@@ -51,7 +51,7 @@ You can download the binary file from:
configuration files are under "conf" folder
* environment config module (`iotdb-env.bat`, `iotdb-env.sh`),
- * system config module (`tsfile-format.properties`, `iotdb-engine.properties`)
+ * system config module (`iotdb-engine.properties`)
* log config module (`logback.xml`).
For more, see [Chapter3: Server](../3-Server/1-Download.html) in detail.
diff --git a/docs/UserGuide/2-Concept/2-Data Type.md b/docs/UserGuide/2-Concept/2-Data Type.md
index ebfece9..e7c0dbc 100644
--- a/docs/UserGuide/2-Concept/2-Data Type.md
+++ b/docs/UserGuide/2-Concept/2-Data Type.md
@@ -30,7 +30,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](../5-Operation%20Manual/4-SQL%20Reference.html) 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](../2-Concept/3-Encoding.html) or [TS\_2DIFF](../2-Concept/3-Encoding.html) (Refer to [Create Timeseries Statement](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on ho [...]
+The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](../5-Operation%20Manual/4-SQL%20Reference.html) 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](../2-Concept/3-Encoding.html) or [TS\_2DIFF](../2-Concept/3-Encoding.html) (Refer to [Create Timeseries Statement](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on ho [...]
* 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/UserGuide/3-Server/4-Config Manual.md b/docs/UserGuide/3-Server/4-Config Manual.md
index 53ab1d3..ce3f8e3 100644
--- a/docs/UserGuide/3-Server/4-Config Manual.md
+++ b/docs/UserGuide/3-Server/4-Config Manual.md
@@ -27,8 +27,7 @@ Before starting to use IoTDB, you need to config the configuration files first.
In total, we provide users three kinds of configurations module:
* environment configuration file (`iotdb-env.bat`, `iotdb-env.sh`). The default configuration file for the environment configuration item. Users can configure the relevant system configuration items of JAVA-JVM in the file.
-* system configuration file (`tsfile-format.properties`, `iotdb-engine.properties`).
- * `tsfile-format.properties`: The default configuration file for the IoTDB file layer configuration item. Users can configure the information about the TsFile, such as the data size written to the disk per time(`group_size_in_byte`).
+* system configuration file (`iotdb-engine.properties`).
* `iotdb-engine.properties`: The default configuration file for the IoTDB engine layer configuration item. Users can configure the IoTDB engine related parameters in the file, such as JDBC service listening port (`rpc_port`), unsequence data storage directory (`unsequence_data_dir`), etc.
* log configuration file (`logback.xml`)
diff --git a/docs/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/UserGuide/4-Client/5-Programming - TsFile API.md
index 25b64fc..eaeab20 100644
--- a/docs/UserGuide/4-Client/5-Programming - TsFile API.md
+++ b/docs/UserGuide/4-Client/5-Programming - TsFile API.md
@@ -687,15 +687,11 @@ public class TsFileRead {
```
-## User-specified config file path
+## Change TsFile Config
-Default config file `tsfile-format.properties.template` is located at `/tsfile/src/main/resources` directory. If you want to use your own path, you can:
-```
-System.setProperty(TsFileConstant.TSFILE_CONF, "your config file path");
-```
-and then call:
```
TSFileConfig config = TSFileDescriptor.getInstance().getConfig();
+config.setXXX();
```
## Bloom filter
@@ -704,7 +700,7 @@ Bloom filter checks whether a given time series is in the tsfile before loading
If you want to learn more about its mechanism, you can refer to: [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).
#### configuration
-you can control the false positive rate of bloom filter by the following parameter in the config file `tsfile-format.properties` which located at `/server/src/assembly/resources/conf` directory
+you can control the false positive rate of bloom filter by the following parameter in the config file `iotdb-engine.properties` which located at `/server/src/assembly/resources/conf` directory
```
# The acceptable error rate of bloom filter, should be in [0.01, 0.1], default is 0.05
bloom_filter_error_rate=0.05
diff --git a/docs/UserGuide/8-System Design/3-Writing Data on HDFS.md b/docs/UserGuide/8-System Design/3-Writing Data on HDFS.md
index 91f53a4..79567c0 100644
--- a/docs/UserGuide/8-System Design/3-Writing Data on HDFS.md
+++ b/docs/UserGuide/8-System Design/3-Writing Data on HDFS.md
@@ -35,7 +35,9 @@ When you config to store TSFile on HDFS, your data files will be in distributed
If you want to store TSFile and related data files in HDFS, here are the steps:
-First, build server and Hadoop module by: `mvn clean package -pl server,hadoop -am -Dmaven.test.skip=true`
+First, download the source release from website or git clone the repository, the tag of a released version is release/x.x.x
+
+Build server and Hadoop module by: `mvn clean package -pl server,hadoop -am -Dmaven.test.skip=true`
Then, copy the target jar of Hadoop module `hadoop-tsfile-0.9.1-jar-with-dependencies.jar` into server target lib folder `.../server/target/iotdb-server-0.9.1/lib`.
diff --git a/docs/zh/UserGuide/0-Get Started/1-QuickStart.md b/docs/zh/UserGuide/0-Get Started/1-QuickStart.md
index b856d38..1edbf2f 100644
--- a/docs/zh/UserGuide/0-Get Started/1-QuickStart.md
+++ b/docs/zh/UserGuide/0-Get Started/1-QuickStart.md
@@ -66,7 +66,7 @@ IoTDB支持多种安装途径。用户可以使用三种方式对IoTDB进行安
配置文件在"conf"文件夹下，包括：
* 环境配置模块 (`iotdb-env.bat`, `iotdb-env.sh`),
- * 系统配置模块 (`tsfile-format.properties`, `iotdb-engine.properties`)
+ * 系统配置模块 (`iotdb-engine.properties`)
* 日志配置模块 (`logback.xml`).
想要了解更多，请浏览[Chapter3: Server](../3-Server/1-Download.html)
diff --git a/docs/zh/UserGuide/2-Concept/2-Data Type.md b/docs/zh/UserGuide/2-Concept/2-Data Type.md
index 18fdb57..e782247 100644
--- a/docs/zh/UserGuide/2-Concept/2-Data Type.md
+++ b/docs/zh/UserGuide/2-Concept/2-Data Type.md
@@ -31,7 +31,7 @@ IoTDB支持:
一共六种数据类型。
-其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](../2-Concept/3-Encoding.html)或[TS_2DIFF](../2-Concept/3-Encoding.html)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.4节](../5-Operation%20Manual/4-SQL%20Reference.html)，若不指定则系统会根据配置文件`tsfile-format.properties`文件中的[float_precision项](../3-Server/4-Config%20Manual.html)配置。
+其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](../2-Concept/3-Encoding.html)或[TS_2DIFF](../2-Concept/3-Encoding.html)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.4节](../5-Operation%20Manual/4-SQL%20Reference.html)，若不指定则系统会根据配置文件`iotdb-engine.properties`文件中的[float_precision项](../3-Server/4-Config%20Manual.html)配置。
当系统中用户输入的数据类型与该时间序列的数据类型不对应时，系统会提醒类型错误，如下所示，二阶差分不支持布尔类型的编码：
diff --git a/docs/zh/UserGuide/3-Server/4-Config Manual.md b/docs/zh/UserGuide/3-Server/4-Config Manual.md
index 7e91f5c..2baa30e 100644
--- a/docs/zh/UserGuide/3-Server/4-Config Manual.md
+++ b/docs/zh/UserGuide/3-Server/4-Config Manual.md
@@ -23,14 +23,12 @@
为方便IoTDB Server的配置与管理，IoTDB Server为用户提供三种配置项，使得用户可以在启动服务器或服务器运行时对其进行配置。
-三种配置项的配置文件均位于IoTDB安装目录：`$IOTDB_HOME/conf`文件夹下,其中涉及server配置的共有3个文件，分别为：`iotdb-env.sh`, `tsfile-format.properties`, `iotdb-engine.properties`。用户可以通过更改其中的配置项对系统运行的相关配置项进行配置。
+三种配置项的配置文件均位于IoTDB安装目录：`$IOTDB_HOME/conf`文件夹下,其中涉及server配置为：`iotdb-env.sh`, `iotdb-engine.properties`。用户可以通过更改其中的配置项对系统运行的相关配置项进行配置。
配置文件的说明如下：
* `iotdb-env.sh`：环境配置项的默认配置文件。用户可以在文件中配置JAVA-JVM的相关系统配置项。
-* `tsfile-format.properties`：IoTDB文件层系统配置项的默认配置文件。用户可以在文件中配置IoTDB存储时TsFile文件的相关信息，如每次将内存中的数据写入到磁盘时的数据大小(`group_size_in_byte`)，内存中每个列打一次包的大小(`page_size_in_byte`)等。
-
* `iotdb-engine.properties`：IoTDB引擎层系统配置项的默认配置文件。用户可以在文件中配置IoTDB引擎运行时的相关参数，如JDBC服务监听端口(`rpc_port`)、overflow数据文件存储目录(`overflow_data_dir`)等。
## 环境配置项
@@ -76,7 +74,7 @@
## 系统配置项
-系统配置项是IoTDB Server运行的核心配置，它主要用于设置IoTDB Server文件层和引擎层的参数，便于用户根据自身需求调整Server的相关配置，以达到较好的性能表现。系统配置项可分为两大模块：文件层配置项和引擎层配置项。用户可以通过查看`tsfile-format.properties`, `iotdb-engine.properties`,文件查看和修改两种配置项的内容。在0.7.0版本中字符串类型的配置项大小写敏感。
+系统配置项是IoTDB Server运行的核心配置，它主要用于设置IoTDB Server文件层和引擎层的参数，便于用户根据自身需求调整Server的相关配置，以达到较好的性能表现。系统配置项可分为两大模块：文件层配置项和引擎层配置项。用户可以通过查看`iotdb-engine.properties`,文件查看和修改两种配置项的内容。在0.7.0版本中字符串类型的配置项大小写敏感。
### 文件层配置
diff --git a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
index a201bb3..9dce284 100644
--- a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
+++ b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
@@ -670,15 +670,11 @@ public class TsFileRead {
```
-## 用户指定的配置文件路径
+## 修改 TsFile 配置项
-默认配置文件`tsfile-format.properties.template`位于` / tsfile / src / main / resources`目录中。 如果要使用自己的路径，则可以：
-```
-System.setProperty(TsFileConstant.TSFILE_CONF, "your config file path");
-```
-然后调用
```
TSFileConfig config = TSFileDescriptor.getInstance().getConfig();
+config.setXXX()
```
## 布隆过滤器
@@ -687,7 +683,7 @@ TSFileConfig config = TSFileDescriptor.getInstance().getConfig();
如果要了解有关其机制的更多信息，可以参考： [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).
#### 配置
-您可以通过`/ server / src / assembly / resources / conf`目录中的配置文件`tsfile-format.properties`中的以下参数来控制Bloom过滤器的误报率。
+您可以通过`/ server / src / assembly / resources / conf`目录中的配置文件`iotdb-engine.properties`中的以下参数来控制Bloom过滤器的误报率。
```
# The acceptable error rate of bloom filter, should be in [0.01, 0.1], default is 0.05
bloom_filter_error_rate=0.05
diff --git a/docs/zh/UserGuide/8-System Design/3-Writing Data on HDFS.md b/docs/zh/UserGuide/8-System Design/3-Writing Data on HDFS.md
index 2f0a2ce..d94de1a 100644
--- a/docs/zh/UserGuide/8-System Design/3-Writing Data on HDFS.md
+++ b/docs/zh/UserGuide/8-System Design/3-Writing Data on HDFS.md
@@ -35,7 +35,9 @@
如果你希望将TSFile存储在HDFS上，可以遵循以下步骤：
-首先，使用maven打包server和Hadoop模块：`mvn clean package -pl server,hadoop -am -Dmaven.test.skip=true`
+首先下载对应版本的源码发布版或者下载 github 仓库，发布版代码的 tag 为 release/x.x.x
+
+使用maven打包server和Hadoop模块：`mvn clean package -pl server,hadoop -am -Dmaven.test.skip=true`
然后，将Hadoop模块的target jar包`hadoop-tsfile-0.9.1-jar-with-dependencies.jar`复制到server模块的target lib文件夹 `.../server/target/iotdb-server-0.9.1/lib`下。