qiaojialin commented on a change in pull request #4013:
URL: https://github.com/apache/iotdb/pull/4013#discussion_r720077476
##########
File path: docs/zh/UserGuide/Appendix/Config-Manual.md
##########
@@ -82,190 +82,276 @@
系统配置项是 IoTDB Server 运行的核心配置,它主要用于设置 IoTDB Server 文件层和引擎层的参数,便于用户根据自身需求调整
Server
的相关配置,以达到较好的性能表现。系统配置项可分为两大模块:文件层配置项和引擎层配置项。用户可以通过`iotdb-engine.properties`,
文件查看和修改两种配置项的内容。在 0.7.0 版本中字符串类型的配置项大小写敏感。
-### 文件层配置
+### RPC配置
-* compressor
+* rpc\_address
-|名字|compressor|
+|名字| rpc\_address |
|:---:|:---|
-|描述|数据压缩方法|
-|类型|枚举 String : “UNCOMPRESSED”, “SNAPPY”, “LZ4”|
-|默认值| SNAPPY |
-|改后生效方式|触发生效|
+|描述| rpc地址 |
+|类型| String |
+|默认值| 0.0.0.0|
+|改后生效方式|重启服务生效|
-* group\_size\_in\_byte
+* rpc\_port
-|名字|group\_size\_in\_byte|
+|名字| rpc\_port |
|:---:|:---|
-|描述|每次将内存中的数据写入到磁盘时的最大写入字节数|
-|类型|Int32|
-|默认值| 134217728 |
-|改后生效方式|触发生效|
+|描述| jdbc 服务监听端口。请确认该端口不是系统保留端口并且未被占用。|
+|类型| Short Int : [0,65535] |
+|默认值| 6667 |
+|改后生效方式|重启服务生效|
-* max\_number\_of\_points\_in\_page
+* rpc\_thrift\_compression\_enable
-|名字| max\_number\_of\_points\_in\_page |
+|名字| rpc\_thrift\_compression\_enable |
|:---:|:---|
-|描述|一个页中最多包含的数据点(时间戳-值的二元组)数量|
-|类型|Int32|
-|默认值| 1048576 |
-|改后生效方式|触发生效|
+|描述| 是否启用 thrift 的压缩机制。|
+|类型| Boolean |
+|默认值| false |
+|改后生效方式|重启服务生效|
-* max\_degree\_of\_index\_node
+* rpc\_advanced\_compression\_enable
-|名字| max\_degree\_of\_index\_node |
+|名字| rpc\_advanced\_compression\_enable |
|:---:|:---|
-|描述|元数据索引树的最大度(即每个节点的最大子节点个数)|
-|类型|Int32|
-|默认值| 256 |
-|改后生效方式|仅允许在第一次启动服务前修改|
+|描述| 是否启用 thrift 的自定制压缩机制。|
+|类型| Boolean |
+|默认值| false |
+|改后生效方式|重启服务生效|
-* max\_string\_length
+* rpc\_max\_concurrent\_client\_num
-|名字| max\_string\_length |
+|名字| rpc\_max\_concurrent\_client\_num |
|:---:|:---|
-|描述|针对字符串类型的数据,单个字符串最大长度,单位为字符|
-|类型|Int32|
-|默认值| 128 |
-|改后生效方式|触发生效|
+|描述| 最大连接数。|
+|类型| Short Int : [0,65535] |
+|默认值| 65535 |
+|改后生效方式|重启服务生效|
-* page\_size\_in\_byte
+* thrift\_max\_frame\_size
-|名字| page\_size\_in\_byte |
+|名字| thrift\_max\_frame\_size |
|:---:|:---|
-|描述|内存中每个列写出时,写成的单页最大的大小,单位为字节|
-|类型|Int32|
-|默认值| 65536 |
+|描述| RPC 请求/响应的最大字节数|
+|类型| long |
+|默认值| 536870912 (默认值512MB,应大于等于 512 * 1024 * 1024) |
+|改后生效方式|重启服务生效|
+
+* thrift\_init\_buffer\_size
+
+|名字| thrift\_init\_buffer\_size |
+|:---:|:---|
+|描述| 字节数 |
+|类型| long |
+|默认值| 1024 |
+|改后生效方式|重启服务生效|
+
+
+### 写前日志配置
+
+* enable\_wal
+
+|名字| enable\_wal |
+|:---:|:---|
+|描述| 是否开启前写日志,默认值为 true 表示开启,配置成 false 表示关闭 |
+|类型| Boolean|
+|默认值| true |
|改后生效方式|触发生效|
-* time\_encoder
+* enable\_discard\_out\_of\_order\_data
-|名字| time\_encoder |
+|名字| enable\_discard\_out\_of\_order\_data |
|:---:|:---|
-|描述| 时间列编码方式|
-|类型|枚举 String: “TS_2DIFF”,“PLAIN”,“RLE”|
-|默认值| TS_2DIFF |
+|描述| 是否删除无序数据,默认值为 false 表示关闭 |
+|类型| Boolean |
+|默认值| false |
|改后生效方式|触发生效|
-* value\_encoder
+* flush\_wal\_threshold
-|名字| value\_encoder |
+|名字| flush\_wal\_threshold |
|:---:|:---|
-|描述| value 列编码方式|
-|类型|枚举 String: “TS_2DIFF”,“PLAIN”,“RLE”|
-|默认值| PLAIN |
+|描述| 写前日志的条数达到该值之后,刷新到磁盘,有可能丢失至多 flush\_wal\_threshold 个操作 |
Review comment:
```suggestion
|描述| 写前日志的条数达到该值之后,持久化到磁盘,有可能丢失至多 flush\_wal\_threshold 个操作 |
```
##########
File path: docs/zh/UserGuide/Appendix/Config-Manual.md
##########
@@ -82,190 +82,276 @@
系统配置项是 IoTDB Server 运行的核心配置,它主要用于设置 IoTDB Server 文件层和引擎层的参数,便于用户根据自身需求调整
Server
的相关配置,以达到较好的性能表现。系统配置项可分为两大模块:文件层配置项和引擎层配置项。用户可以通过`iotdb-engine.properties`,
文件查看和修改两种配置项的内容。在 0.7.0 版本中字符串类型的配置项大小写敏感。
-### 文件层配置
+### RPC配置
-* compressor
+* rpc\_address
-|名字|compressor|
+|名字| rpc\_address |
|:---:|:---|
-|描述|数据压缩方法|
-|类型|枚举 String : “UNCOMPRESSED”, “SNAPPY”, “LZ4”|
-|默认值| SNAPPY |
-|改后生效方式|触发生效|
+|描述| rpc地址 |
+|类型| String |
+|默认值| 0.0.0.0|
+|改后生效方式|重启服务生效|
-* group\_size\_in\_byte
+* rpc\_port
-|名字|group\_size\_in\_byte|
+|名字| rpc\_port |
|:---:|:---|
-|描述|每次将内存中的数据写入到磁盘时的最大写入字节数|
-|类型|Int32|
-|默认值| 134217728 |
-|改后生效方式|触发生效|
+|描述| jdbc 服务监听端口。请确认该端口不是系统保留端口并且未被占用。|
+|类型| Short Int : [0,65535] |
+|默认值| 6667 |
+|改后生效方式|重启服务生效|
-* max\_number\_of\_points\_in\_page
+* rpc\_thrift\_compression\_enable
-|名字| max\_number\_of\_points\_in\_page |
+|名字| rpc\_thrift\_compression\_enable |
|:---:|:---|
-|描述|一个页中最多包含的数据点(时间戳-值的二元组)数量|
-|类型|Int32|
-|默认值| 1048576 |
-|改后生效方式|触发生效|
+|描述| 是否启用 thrift 的压缩机制。|
+|类型| Boolean |
+|默认值| false |
+|改后生效方式|重启服务生效|
-* max\_degree\_of\_index\_node
+* rpc\_advanced\_compression\_enable
-|名字| max\_degree\_of\_index\_node |
+|名字| rpc\_advanced\_compression\_enable |
|:---:|:---|
-|描述|元数据索引树的最大度(即每个节点的最大子节点个数)|
-|类型|Int32|
-|默认值| 256 |
-|改后生效方式|仅允许在第一次启动服务前修改|
+|描述| 是否启用 thrift 的自定制压缩机制。|
+|类型| Boolean |
+|默认值| false |
+|改后生效方式|重启服务生效|
-* max\_string\_length
+* rpc\_max\_concurrent\_client\_num
-|名字| max\_string\_length |
+|名字| rpc\_max\_concurrent\_client\_num |
|:---:|:---|
-|描述|针对字符串类型的数据,单个字符串最大长度,单位为字符|
-|类型|Int32|
-|默认值| 128 |
-|改后生效方式|触发生效|
+|描述| 最大连接数。|
+|类型| Short Int : [0,65535] |
+|默认值| 65535 |
+|改后生效方式|重启服务生效|
-* page\_size\_in\_byte
+* thrift\_max\_frame\_size
-|名字| page\_size\_in\_byte |
+|名字| thrift\_max\_frame\_size |
|:---:|:---|
-|描述|内存中每个列写出时,写成的单页最大的大小,单位为字节|
-|类型|Int32|
-|默认值| 65536 |
+|描述| RPC 请求/响应的最大字节数|
+|类型| long |
+|默认值| 536870912 (默认值512MB,应大于等于 512 * 1024 * 1024) |
+|改后生效方式|重启服务生效|
+
+* thrift\_init\_buffer\_size
+
+|名字| thrift\_init\_buffer\_size |
+|:---:|:---|
+|描述| 字节数 |
+|类型| long |
+|默认值| 1024 |
+|改后生效方式|重启服务生效|
+
+
+### 写前日志配置
+
+* enable\_wal
+
+|名字| enable\_wal |
+|:---:|:---|
+|描述| 是否开启前写日志,默认值为 true 表示开启,配置成 false 表示关闭 |
+|类型| Boolean|
+|默认值| true |
|改后生效方式|触发生效|
-* time\_encoder
+* enable\_discard\_out\_of\_order\_data
-|名字| time\_encoder |
+|名字| enable\_discard\_out\_of\_order\_data |
|:---:|:---|
-|描述| 时间列编码方式|
-|类型|枚举 String: “TS_2DIFF”,“PLAIN”,“RLE”|
-|默认值| TS_2DIFF |
+|描述| 是否删除无序数据,默认值为 false 表示关闭 |
+|类型| Boolean |
+|默认值| false |
|改后生效方式|触发生效|
-* value\_encoder
+* flush\_wal\_threshold
-|名字| value\_encoder |
+|名字| flush\_wal\_threshold |
|:---:|:---|
-|描述| value 列编码方式|
-|类型|枚举 String: “TS_2DIFF”,“PLAIN”,“RLE”|
-|默认值| PLAIN |
+|描述| 写前日志的条数达到该值之后,刷新到磁盘,有可能丢失至多 flush\_wal\_threshold 个操作 |
+|类型| Int32 |
+|默认值| 10000 |
|改后生效方式|触发生效|
-* float\_precision
+* force\_wal\_period\_in\_ms
-|名字| float\_precision |
+|名字| force\_wal\_period\_in\_ms |
|:---:|:---|
-|描述| 浮点数精度,为小数点后数字的位数 |
-|类型|Int32|
-|默认值| 默认为 2 位。注意:32 位浮点数的十进制精度为 7 位,64 位浮点数的十进制精度为 15 位。如果设置超过机器精度将没有实际意义。|
+|描述| 写前日志定期刷新到磁盘的周期,单位毫秒,有可能丢失至多 force\_wal\_period\_in\_ms 毫秒的操作。 |
Review comment:
```suggestion
|描述| 写前日志定期持久化到磁盘的周期,单位毫秒,有可能丢失至多 force\_wal\_period\_in\_ms 毫秒的操作。 |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]