Skip to content
Permalink
Browse files
rename iotdb-engine.properties to iotdb-datanode.properties (#6449)
  • Loading branch information
HTHou committed Jun 26, 2022
1 parent 51b8f12 commit 3062bdb6238c44b5814854eec015e9eaa5093c65
Showing 53 changed files with 102 additions and 102 deletions.
@@ -180,7 +180,7 @@ you run `mvn package` successfully.**
configuration files are under "conf" folder

* environment config module (`iotdb-env.bat`, `iotdb-env.sh`),
* system config module (`iotdb-engine.properties`)
* system config module (`iotdb-datanode.properties`)
* log config module (`logback.xml`).

For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/Master/Reference/Config-Manual.html).
@@ -165,7 +165,7 @@ git checkout vx.x.x

配置文件在"conf"文件夹下
* 环境配置模块(`iotdb-env.bat`, `iotdb-env.sh`),
* 系统配置模块(`iotdb-engine.properties`)
* 系统配置模块(`iotdb-datanode.properties`)
* 日志配置模块(`logback.xml`)。

有关详细信息,请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/Config-Manual.html)。
@@ -28,7 +28,7 @@ RUN apt update \
&& unzip /apache-iotdb-*-bin.zip -d / \
&& rm /apache-iotdb-*-bin.zip \
&& mv /apache-iotdb-* /iotdb \
&& sed -i '/^# enable_influxdb_rpc_service=false/a enable_influxdb_rpc_service=true' /iotdb/sbin/../conf/iotdb-engine.properties \
&& sed -i '/^# enable_influxdb_rpc_service=false/a enable_influxdb_rpc_service=true' /iotdb/sbin/../conf/iotdb-datanode.properties \
&& apt remove unzip -y \
&& apt autoremove -y \
&& apt purge --auto-remove -y \
@@ -72,11 +72,11 @@ It is required to use "mvn spotless:apply" to format the code before committing,

Notes

1.The default values need to be consistent between iotdb-engine.properties file and IoTDBConfig file.
1.The default values need to be consistent between iotdb-datanode.properties file and IoTDBConfig file.

2.To modify the configuration parameters, the following files need to be modified

a.Configuration file: server/src/assembly/resources/conf/iotdb-engine.properties
a.Configuration file: server/src/assembly/resources/conf/iotdb-datanode.properties

b. Codes: IoTDBDescriptor, IoTDBConfig

@@ -59,7 +59,7 @@ or json array of the above two.
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/6711230/78357469-1bf11880-75e4-11ea-978f-a53996667a0d.png">

### MQTT Configurations
The IoTDB MQTT service load configurations from `${IOTDB_HOME}/${IOTDB_CONF}/iotdb-engine.properties` by default.
The IoTDB MQTT service load configurations from `${IOTDB_HOME}/${IOTDB_CONF}/iotdb-datanode.properties` by default.

Configurations are as follows:

@@ -157,7 +157,7 @@ public class CustomizedJsonPayloadFormatter implements PayloadFormatter {
@Override
public String getName() {
// set the value of mqtt_payload_formatter in iotdb-engine.properties as the following string:
// set the value of mqtt_payload_formatter in iotdb-datanode.properties as the following string:
return "CustomizedJson";
}
}
@@ -170,8 +170,8 @@ public class CustomizedJsonPayloadFormatter implements PayloadFormatter {

Then, in your server:
* Create ${IOTDB_HOME}/ext/mqtt/ folder, and put the jar into this folder.
* Update configuration to enable MQTT service. (`enable_mqtt_service=true` in `conf/iotdb-engine.properties`)
* Set the value of `mqtt_payload_formatter` in `conf/iotdb-engine.properties` as the value of getName() in your implementation
* Update configuration to enable MQTT service. (`enable_mqtt_service=true` in `conf/iotdb-datanode.properties`)
* Set the value of `mqtt_payload_formatter` in `conf/iotdb-datanode.properties` as the value of getName() in your implementation
, in this example, the value is `CustomizedJson`
* Launch the IoTDB server.
* Now IoTDB will use your implementation to parse the MQTT message.
@@ -33,7 +33,7 @@ IoTDB supports the following data types:
* TEXT (String)


The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](../Reference/SQL-Reference.md) 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](Encoding.md) or [TS\_2DIFF](Encoding.md). If MAX\_POINT\_NUMBER is not specified, the system will use [float\_precision](../Reference/Config-Manual.md) in the configuration file `iotdb-engine.properties`.
The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](../Reference/SQL-Reference.md) 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](Encoding.md) or [TS\_2DIFF](Encoding.md). If MAX\_POINT\_NUMBER is not specified, the system will use [float\_precision](../Reference/Config-Manual.md) in the configuration file `iotdb-datanode.properties`.

* 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, caused by 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, caused by the limition of function Math.round(double) in Java (Long.MAX_VALUE=9.22E18).
@@ -37,7 +37,7 @@ After that, you can get a **conf** directory and a **lib** directory in
schema-engine-rocksdb/target/schema-engine-rocksdb. Copy the file in the conf directory to the conf directory of server,
and copy the files in the lib directory to the lib directory of server.

Then, open the **iotdb-engine.properties** in the conf directory of server, and set the `schema_engine_mode` to
Then, open the **iotdb-datanode.properties** in the conf directory of server, and set the `schema_engine_mode` to
Rocksdb_based. Restart the IoTDB, the system will use `RSchemaRegion` to manage the metadata.

```
@@ -41,7 +41,7 @@ Build server and Hadoop module by: `mvn clean package -pl server,hadoop -am -Dma

Then, copy the target jar of Hadoop module `hadoop-tsfile-X.X.X-jar-with-dependencies.jar` into server target lib folder `.../server/target/iotdb-server-X.X.X/lib`.

Edit user config in `iotdb-engine.properties`. Related configurations are:
Edit user config in `iotdb-datanode.properties`. Related configurations are:

* tsfile\_storage\_fs

@@ -49,7 +49,7 @@ To grasp the performance of iotdb, this module is added to count the time-consum

#### Configuration parameter

location:conf/iotdb-engine.properties
location:conf/iotdb-datanode.properties

<center>

@@ -287,7 +287,7 @@ IoTDB> SHOW PIPESERVER STATUS

##### **Receiver**

- `vi conf/iotdb-engine.properties` to config the parameters,set the IP white list to 192.168.0.1/1 to receive and only receive data from sender.
- `vi conf/iotdb-datanode.properties` to config the parameters,set the IP white list to 192.168.0.1/1 to receive and only receive data from sender.

```
####################
@@ -420,7 +420,7 @@ It costs 0.134s
```

- Cause by: The receiver is not started or the receiver cannot be connected.
- Solution: Execute `SHOW PIPESERVER` on the receiver side to check if the receiver side is started, if not use `START PIPESERVER` to start; check if the whitelist in `iotdb-engine.properties` on the receiver side contains the sender ip.
- Solution: Execute `SHOW PIPESERVER` on the receiver side to check if the receiver side is started, if not use `START PIPESERVER` to start; check if the whitelist in `iotdb-datanode.properties` on the receiver side contains the sender ip.

- Execute

@@ -25,7 +25,7 @@ This tool has two functions: 1) watermark embedding of the IoTDB query result an

#### Configuration

Watermark is disabled by default in IoTDB. To enable watermark embedding, the first thing is to modify the following fields in the configuration file `iotdb-engine.properties`:
Watermark is disabled by default in IoTDB. To enable watermark embedding, the first thing is to modify the following fields in the configuration file `iotdb-datanode.properties`:

| Name | Example | Explanation |
| ----------------------- | ------------------------------------------------------ | ------------------------------------------------------------ |
@@ -43,7 +43,7 @@ Notes:
- Both of them should be positive integers.
- `embed_row_cycle` controls the ratio of rows watermarked. The smaller the `embed_row_cycle`, the larger the ratio of rows watermarked. When `embed_row_cycle` equals 1, every row is watermarked.
- GroupBasedLSBMethod uses LSB embedding. `embed_lsb_num` controls the number of least significant bits available for watermark embedding. The biggger the `embed_lsb_num`, the larger the varying range of a data point.
- `watermark_secret_key`, `watermark_bit_string` and `watermark_method` should be kept secret from possible attackers. That is, it is your responsiblity to take care of `iotdb-engine.properties`.
- `watermark_secret_key`, `watermark_bit_string` and `watermark_method` should be kept secret from possible attackers. That is, it is your responsiblity to take care of `iotdb-datanode.properties`.

#### Usage Example

@@ -83,29 +83,29 @@ Illustrated as the following figure:

### Type inference

| Data(String Format) | Format Type | iotdb-engine.properties | Default |
|:---:|:---|:---|:---|
| true | boolean | boolean\_string\_infer\_type | BOOLEAN |
| 1 | integer | integer\_string\_infer\_type | FLOAT |
| 17000000(integer > 2^24) | integer | long\_string\_infer\_type | DOUBLE |
| Data(String Format) | Format Type | iotdb-datanode.properties | Default |
|:---:|:---|:------------------------------|:---|
| true | boolean | boolean\_string\_infer\_type | BOOLEAN |
| 1 | integer | integer\_string\_infer\_type | FLOAT |
| 17000000(integer > 2^24) | integer | long\_string\_infer\_type | DOUBLE |
| 1.2 | floating | floating\_string\_infer\_type | FLOAT |
| NaN | nan | nan\_string\_infer\_type | DOUBLE |
| 'I am text' | text | x | x |
| NaN | nan | nan\_string\_infer\_type | DOUBLE |
| 'I am text' | text | x | x |

* Data types can be configured as BOOLEAN, INT32, INT64, FLOAT, DOUBLE, TEXT.

* long_string_infer_type is used to avoid precision loss caused by using integer_string_infer_type=FLOAT to infer num > 2^24.

### Encoding Type

| Data Type | iotdb-engine.properties | Default |
|:---|:---|:---|
| Data Type | iotdb-datanode.properties | Default |
|:---|:---------------------------|:---|
| BOOLEAN | default\_boolean\_encoding | RLE |
| INT32 | default\_int32\_encoding | RLE |
| INT64 | default\_int64\_encoding | RLE |
| FLOAT | default\_float\_encoding | GORILLA |
| DOUBLE | default\_double\_encoding | GORILLA |
| TEXT | default\_text\_encoding | PLAIN |
| INT32 | default\_int32\_encoding | RLE |
| INT64 | default\_int64\_encoding | RLE |
| FLOAT | default\_float\_encoding | GORILLA |
| DOUBLE | default\_double\_encoding | GORILLA |
| TEXT | default\_text\_encoding | PLAIN |

* Encoding types can be configured as PLAIN, RLE, TS_2DIFF, GORILLA, DICTIONARY.

@@ -913,7 +913,7 @@ public class TriggerExample implements Trigger {

You can try this trigger by following the steps below:

* Enable MQTT service by modifying `iotdb-engine.properties`
* Enable MQTT service by modifying `iotdb-datanode.properties`

``` properties
# whether to enable the mqtt service.
@@ -512,7 +512,7 @@ For more user permissions related content, please refer to [Account Management S

## Configurable Properties

When querying by a UDF, IoTDB may prompt that there is insufficient memory. You can resolve the issue by configuring `udf_initial_byte_array_length_for_memory_control`, `udf_memory_budget_in_mb` and `udf_reader_transformer_collector_memory_proportion` in `iotdb-engine.properties` and restarting the server.
When querying by a UDF, IoTDB may prompt that there is insufficient memory. You can resolve the issue by configuring `udf_initial_byte_array_length_for_memory_control`, `udf_memory_budget_in_mb` and `udf_reader_transformer_collector_memory_proportion` in `iotdb-datanode.properties` and restarting the server.



@@ -49,7 +49,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 (`iotdb-engine.properties`)
* system config module (`iotdb-datanode.properties`)
* log config module (`logback.xml`).

For more, see [Config](../Reference/Config-Manual.md) in detail.
@@ -235,5 +235,5 @@ The server can be stopped with ctrl-C or the following script:
The configuration files is in the `conf` folder, includes:

* environment configuration (`iotdb-env.bat`, `iotdb-env.sh`),
* system configuration (`iotdb-engine.properties`)
* system configuration (`iotdb-datanode.properties`)
* log configuration (`logback.xml`).
@@ -27,7 +27,7 @@

## Configuration Files
> under conf directory
1. iotdb-engine.properties
1. iotdb-datanode.properties
2. logback.xml
3. iotdb-env.sh
4. jmx.access
@@ -27,8 +27,8 @@ 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 (`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. What's more, 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-datanode.properties`).
* `iotdb-datanode.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. What's more, Users can configure the information about the TsFile, such as the data size written to the disk per time(`group_size_in_byte`).

* log configuration file (`logback.xml`)

@@ -41,7 +41,7 @@ The second parameter indicates the path of the tsfile to be loaded and the name

AUTOREGISTER option. If the metadata correspond to the timeseries in the tsfile to be loaded does not exist, you can choose whether to create the schema automatically. If this parameter is true, the schema is created automatically. If it is false, the schema will not be created. By default, the schema will be created.

SGLEVEL option. If the storage group correspond to the tsfile does not exist, the user can set the level of storage group through the fourth parameter. By default, it uses the storage group level which is set in `iotdb-engine.properties`.
SGLEVEL option. If the storage group correspond to the tsfile does not exist, the user can set the level of storage group through the fourth parameter. By default, it uses the storage group level which is set in `iotdb-datanode.properties`.

VERIFY option. If this parameter is true, All timeseries in this loading tsfile will be compared with the timeseries in IoTDB. If existing a measurement which has different datatype with the measurement in IoTDB, the loading process will be stopped and exit. If consistence can be promised, setting false for this parameter will be a better choice.

@@ -72,10 +72,10 @@ master 分支作为当前主开发分支,对应下一个未发布的大版本

注意事项:

iotdb-engine.properties 和 IoTDBConfig 默认值需要保持一致。
iotdb-datanode.properties 和 IoTDBConfig 默认值需要保持一致。

如果需要对配置参数进行改动。以下文件需要同时修改:
1. 配置文件:server/src/assembly/resources/conf/iotdb-engine.properties
1. 配置文件:server/src/assembly/resources/conf/iotdb-datanode.properties
2. 代码:IoTDBDescriptor、IoTDBConfig
3. 文档:docs/UserGuide/Reference/Config-Manual.md、docs/zh/UserGuide/Reference/Config-Manual.md

@@ -156,7 +156,7 @@ public class CustomizedJsonPayloadFormatter implements PayloadFormatter {
@Override
public String getName() {
// set the value of mqtt_payload_formatter in iotdb-engine.properties as the following string:
// set the value of mqtt_payload_formatter in iotdb-datanode.properties as the following string:
return "CustomizedJson";
}
}
@@ -169,8 +169,8 @@ public class CustomizedJsonPayloadFormatter implements PayloadFormatter {

在 IoTDB 服务端:
* 创建 ${IOTDB_HOME}/ext/mqtt/ 文件夹, 将刚才的 jar 包放入此文件夹。
* 打开 MQTT 服务参数. (`enable_mqtt_service=true` in `conf/iotdb-engine.properties`)
* 用刚才的实现类中的 getName() 方法的返回值 设置为 `conf/iotdb-engine.properties``mqtt_payload_formatter` 的值,
* 打开 MQTT 服务参数. (`enable_mqtt_service=true` in `conf/iotdb-datanode.properties`)
* 用刚才的实现类中的 getName() 方法的返回值 设置为 `conf/iotdb-datanode.properties``mqtt_payload_formatter` 的值,
, 在本例中,为 `CustomizedJson`
* 启动 IoTDB
* 搞定.
@@ -34,7 +34,7 @@ IoTDB 支持:

一共六种数据类型。

其中 **FLOAT****DOUBLE** 类型的序列,如果编码方式采用 [RLE](Encoding.md) 或 [TS_2DIFF](Encoding.md) 可以指定 MAX_POINT_NUMBER,该项为浮点数的小数点后位数,若不指定则系统会根据配置文件`iotdb-engine.properties`文件中的 [float_precision 项](../Reference/Config-Manual.md) 配置。
其中 **FLOAT****DOUBLE** 类型的序列,如果编码方式采用 [RLE](Encoding.md) 或 [TS_2DIFF](Encoding.md) 可以指定 MAX_POINT_NUMBER,该项为浮点数的小数点后位数,若不指定则系统会根据配置文件`iotdb-datanode.properties`文件中的 [float_precision 项](../Reference/Config-Manual.md) 配置。

当系统中用户输入的数据类型与该时间序列的数据类型不对应时,系统会提醒类型错误,如下所示,二阶差分编码不支持布尔类型:

@@ -34,7 +34,7 @@ mvn clean package -pl schema-engine-rocksdb -am -DskipTests
命令运行结束后,在其 target/schema-engine-rocksdb 中会有一个 lib 文件夹和 conf 文件夹。将 conf 文件夹下的文件拷贝到 server 的 conf 文件夹中,将 lib 文件夹下的文件也拷贝到
server 的 lib 的文件夹中。

在系统配置文件`iotdb-engine.properties`中,将配置项`schema_engine_mode`修改为`Rocksdb_based`, 如:
在系统配置文件`iotdb-datanode.properties`中,将配置项`schema_engine_mode`修改为`Rocksdb_based`, 如:

```
####################
@@ -41,7 +41,7 @@

然后,将 Hadoop 模块的 target jar 包`hadoop-tsfile-X.X.X-jar-with-dependencies.jar`复制到 server 模块的 target lib 文件夹 `.../server/target/iotdb-server-X.X.X/lib`下。

编辑`iotdb-engine.properties`中的用户配置。相关配置项包括:
编辑`iotdb-datanode.properties`中的用户配置。相关配置项包括:

* tsfile\_storage\_fs

@@ -49,7 +49,7 @@

#### 配置参数

配置文件位置:conf/iotdb-engine.properties
配置文件位置:conf/iotdb-datanode.properties

<center>

0 comments on commit 3062bdb

Please sign in to comment.