qiaojialin commented on a change in pull request #4013:
URL: https://github.com/apache/iotdb/pull/4013#discussion_r720080083
##########
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 毫秒的操作。 |
+|类型| Int32 |
+|默认值| 100 |
|改后生效方式|触发生效|
-### 引擎层配置
+### 目录配置
+
+* system\_dir
+
+|名字| system\_dirs |
+|:---:|:---|
+|描述| IoTDB 元数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
+|类型| String |
+|默认值| data/system（Windows：data\\system） |
+|改后生效方式|触发生效|
* data\_dirs
|名字| data\_dirs |
|:---:|:---|
|描述| IoTDB 数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型|String|
-|默认值| data/data |
+|类型| String |
+|默认值| data/data（Windows：data\\data） |
|改后生效方式|触发生效|
-* system\_dirs
+* multi\_dir\_strategy
-|名字| system\_dirs |
+|名字| multi\_dir\_strategy |
|:---:|:---|
-|描述| IoTDB 元数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型|String|
-|默认值| data/system |
+|描述| IoTDB 在 tsfile\_dir 中为 TsFile 选择目录时采用的策略。可使用简单类名或类名全称。系统提供以下三种策略：<br>1.
SequenceStrategy：IoTDB 按顺序从 tsfile\_dir 中选择目录，依次遍历 tsfile\_dir
中的所有目录，并不断轮循；<br>2. MaxDiskUsableSpaceFirstStrategy：IoTDB 优先选择 tsfile\_dir
中对应磁盘空余空间最大的目录；<br>3. MinFolderOccupiedSpaceFirstStrategy：IoTDB 优先选择
tsfile\_dir 中已使用空间最小的目录；<br>4.
UserDfineStrategyPackage（用户自定义策略）<br>您可以通过以下方法完成用户自定义策略：<br>1. 继承
cn.edu.tsinghua.iotdb.conf.directories.strategy.DirectoryStrategy 类并实现自身的
Strategy 方法；<br>2. 将实现的类的完整类名（包名加类名，UserDfineStrategyPackage）填写到该配置项；<br>3. 将该类
jar 包添加到工程中。 |
+|类型| String |
+|默认值| MaxDiskUsableSpaceFirstStrategy |
|改后生效方式|触发生效|
-* wal\_dirs
+* wal\_dir
-|名字| wal\_dirs |
+|名字| wal\_dir |
|:---:|:---|
|描述| IoTDB 写前日志存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型|String|
-|默认值| data/wal |
+|类型| String |
+|默认值| data/wal（Windows：data\\wal） |
|改后生效方式|触发生效|
-* enable\_wal
+* tsfile\_storage\_fs
-|名字| enable\_wal |
+|名字| tsfile\_storage\_fs |
|:---:|:---|
-|描述| 是否开启写前日志，默认值为 true 表示开启，配置成 false 表示关闭 |
-|类型|Bool|
-|默认值| true |
-|改后生效方式|触发生效|
+|描述| Tsfile 和相关数据文件的存储文件系统。目前支持 LOCAL（本地文件系统）和 HDFS 两种 |
+|类型| String |
+|默认值| LOCAL |
+|改后生效方式|仅允许在第一次启动服务前修改|
-* enable\_discard\_out\_of\_order\_data
+* core\_site\_path
-|名字| enable\_discard\_out\_of\_order\_data |
+|名字| core\_site\_path |
|:---:|:---|
-|描述| 是否删除无序数据，默认值为 false 表示关闭 |
-|类型|Bool|
-|默认值| false |
-|改后生效方式|触发生效|
+|描述| 在 Tsfile 和相关数据文件存储到 HDFS 的情况下用于配置 core-site.xml 的绝对路径 |
+|类型| String |
+|默认值| /etc/hadoop/conf/core-site.xml |
+|改后生效方式|重启服务生效|
-* tag\_attribute\_total\_size
+* hdfs\_site\_path
-|名字| tag\_attribute\_total\_size |
+|名字| hdfs\_site\_path |
|:---:|:---|
-|描述| 每个时间序列标签和属性的最大持久化字节数|
-|类型| Int32 |
-|默认值| 700 |
-|改后生效方式|仅允许在第一次启动服务前修改|
+|描述| 在 Tsfile 和相关数据文件存储到 HDFS 的情况下用于配置 hdfs-site.xml 的绝对路径 |
+|类型| String |
+|默认值| /etc/hadoop/conf/hdfs-site.xml |
+|改后生效方式|重启服务生效|
-* enable\_partial\_insert
+* hdfs\_ip
-|名字| enable\_partial\_insert |
+|名字| hdfs\_ip |
+|:---:|:---|
+|描述| 在 Tsfile 和相关数据文件存储到 HDFS 的情况下用于配置 HDFS 的 IP。**如果配置了多于 1 个 hdfs\_ip，则表明启用了
Hadoop HA**|
+|类型| String |
+|默认值|localhost |
+|改后生效方式|重启服务生效|
+
+* hdfs\_port
+
+|名字| hdfs\_port |
+|:---:|:---|
+|描述| 在 Tsfile 和相关数据文件存储到 HDFS 的情况下用于配置 HDFS 的端口 |
+|类型| String |
+|默认值| 9000 |
+|改后生效方式|重启服务生效|
+
+* dfs\_nameservices
+
+|名字| hdfs\_nameservices |
|:---:|:---|
-|描述| 在一次 insert 请求中，如果部分测点写入失败，是否继续写入其他测点|
-|类型| Bool |
+|描述| 在使用 Hadoop HA 的情况下用于配置 HDFS 的 nameservices |
+|类型| String |
+|默认值| hdfsnamespace |
+|改后生效方式|重启服务生效|
+
+* dfs\_ha\_namenodes
+
+|名字| hdfs\_ha\_namenodes |
+|:---:|:---|
+|描述| 在使用 Hadoop HA 的情况下用于配置 HDFS 的 nameservices 下的 namenodes |
+|类型| String |
+|默认值| nn1,nn2 |
+|改后生效方式|重启服务生效|
+
+* dfs\_ha\_automatic\_failover\_enabled
+
+|名字| dfs\_ha\_automatic\_failover\_enabled |
+|:---:|:---|
+|描述| 在使用 Hadoop HA 的情况下用于配置是否使用失败自动切换 |
+|类型| Boolean |
|默认值| true |
|改后生效方式|重启服务生效|
-* mtree\_snapshot\_interval
+* dfs\_client\_failover\_proxy\_provider
-|名字| mtree\_snapshot\_interval |
+|名字| dfs\_client\_failover\_proxy\_provider |
|:---:|:---|
-|描述| 创建 MTree snapshot 时至少累积的 mlog 日志行数。单位为日志行数|
-|类型| Int32 |
-|默认值| 100000 |
+|描述| 在使用 Hadoop HA 且使用失败自动切换的情况下配置失败自动切换的实现方式 |
+|类型| String |
+|默认值|
org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider |
|改后生效方式|重启服务生效|
-* mlog\_buffer\_size
+* hdfs\_use\_kerberos
-|名字| mlog\_buffer\_size |
+|名字| hdfs\_use\_kerberos |
|:---:|:---|
-|描述| mlog 的 buffer 大小 |
-|类型|Int32|
-|默认值| 1048576 |
-|改后生效方式|触发生效|
+|描述| 是否使用 kerberos 验证访问 hdfs |
+|类型| String |
+|默认值| false |
+|改后生效方式|重启服务生效|
-* force\_wal\_period\_in\_ms
+* kerberos\_keytab\_file_path
-|名字| force\_wal\_period\_in\_ms |
+|名字| kerberos\_keytab\_file_path |
|:---:|:---|
-|描述| 写前日志定期刷新到磁盘的周期，单位毫秒，有可能丢失至多 force\_wal\_period\_in\_ms 毫秒的操作。 |
-|类型|Int32|
-|默认值| 100 |
-|改后生效方式|触发生效|
+|描述| kerberos keytab file 的完整路径 |
+|类型| String |
+|默认值| /path |
+|改后生效方式|重启服务生效|
-* flush\_wal\_threshold
+* kerberos\_principal
-|名字| flush\_wal\_threshold |
+|名字| kerberos\_principal |
|:---:|:---|
-|描述| 写前日志的条数达到该值之后，刷新到磁盘，有可能丢失至多 flush\_wal\_threshold 个操作 |
-|类型|Int32|
-|默认值| 10000 |
+|描述| Kerberos 认证原则 |
+|类型| String |
+|默认值| your principal |
+|改后生效方式|重启服务生效|
+
+### 存储引擎配置
+
+* timestamp\_precision
+
+|名字| timestamp\_precision |
+|:---:|:---|
+|描述| 时间戳精度，支持 ms、us、ns |
+|类型|String |
+|默认值| ms |
|改后生效方式|触发生效|
+* default\_ttl
+
+|名字| default\_ttl |
+|:---:|:---|
+|描述| ttl 时间，单位 ms|
Review comment:
```suggestion
|描述| 数据保留时间，会丢弃 now()-default\_ttl 之前的数据，单位 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]
