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 2022/11/26 08:53:31 UTC
[iotdb] branch master updated: Add wal parameters in the documentation (#8183)
This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new d8397b4e79 Add wal parameters in the documentation (#8183)
d8397b4e79 is described below
commit d8397b4e796e15db276e2f7ab173016603be9b46
Author: Alan Choo <43...@users.noreply.github.com>
AuthorDate: Sat Nov 26 16:53:25 2022 +0800
Add wal parameters in the documentation (#8183)
---
docs/UserGuide/Reference/Common-Config-Manual.md | 90 ++++++++++++++++++++
.../zh/UserGuide/Reference/Common-Config-Manual.md | 95 ++++++++++++++++++++--
2 files changed, 178 insertions(+), 7 deletions(-)
diff --git a/docs/UserGuide/Reference/Common-Config-Manual.md b/docs/UserGuide/Reference/Common-Config-Manual.md
index 8d218f1635..463d777073 100644
--- a/docs/UserGuide/Reference/Common-Config-Manual.md
+++ b/docs/UserGuide/Reference/Common-Config-Manual.md
@@ -938,6 +938,96 @@ Trigger way: The client sends the command(sql) `load configuration` to the IoTDB
### Write Ahead Log Configuration
+* wal\_mode
+
+| Name | wal\_mode |
+|:-----------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | The write mode of wal. For DISABLE mode, the system will disable wal. For SYNC mode, the system will submit wal synchronously, write request will not return until its wal is fsynced to the disk successfully. For ASYNC mode, the system will submit wal asynchronously, write request will return immediately no matter its wal is fsynced to the disk successfully. |
+| Type | String |
+| Default | ASYNC |
+| Effective | After restart system |
+
+* max\_wal\_nodes\_num
+
+| Name | max\_wal\_nodes\_num |
+|:-----------:|:---------------------------------------------------------------------------------------------------------------------------------------|
+| Description | Max number of wal nodes, each node corresponds to one wal directory. The default value 0 means the number is determined by the system. |
+| Type | int32 |
+| Default | 0 |
+| Effective | After restart system |
+
+* fsync\_wal\_delay\_in\_ms
+
+| Name | fsync\_wal\_delay\_in\_ms |
+|:-----------:|:--------------------------------------------------------------|
+| Description | Duration a wal flush operation will wait before calling fsync |
+| Type | int32 |
+| Default | 3 |
+| Effective | hot-load |
+
+* wal\_buffer\_size\_in\_byte
+
+| Name | wal\_buffer\_size\_in\_byte |
+|:-----------:|:-----------------------------|
+| Description | Buffer size of each wal node |
+| Type | int32 |
+| Default | 16777216 |
+| Effective | After restart system |
+
+* wal\_buffer\_queue\_capacity
+
+| Name | wal\_buffer\_queue\_capacity |
+|:-----------:|:-------------------------------------------|
+| Description | Blocking queue capacity of each wal buffer |
+| Type | int32 |
+| Default | 50 |
+| Effective | After restart system |
+
+* wal\_file\_size\_threshold\_in\_byte
+
+| Name | wal\_file\_size\_threshold\_in\_byte |
+|:-----------:|:-------------------------------------|
+| Description | Size threshold of each wal file |
+| Type | int32 |
+| Default | 10485760 |
+| Effective | hot-load |
+
+* wal\_min\_effective\_info\_ratio
+
+| Name | wal\_min\_effective\_info\_ratio |
+|:-----------:|:----------------------------------------------------|
+| Description | Minimum ratio of effective information in wal files |
+| Type | double |
+| Default | 0.1 |
+| Effective | hot-load |
+
+* wal\_memtable\_snapshot\_threshold\_in\_byte
+
+| Name | wal\_memtable\_snapshot\_threshold\_in\_byte |
+|:-----------:|:----------------------------------------------------------------|
+| Description | MemTable size threshold for triggering MemTable snapshot in wal |
+| Type | int64 |
+| Default | 8388608 |
+| Effective | hot-load |
+
+* max\_wal\_memtable\_snapshot\_num
+
+| Name | max\_wal\_memtable\_snapshot\_num |
+|:-----------:|:--------------------------------------|
+| Description | MemTable's max snapshot number in wal |
+| Type | int32 |
+| Default | 1 |
+| Effective | hot-load |
+
+* delete\_wal\_files\_period\_in\_ms
+
+| Name | delete\_wal\_files\_period\_in\_ms |
+|:-----------:|:------------------------------------------------------------|
+| Description | The period when outdated wal files are periodically deleted |
+| Type | int64 |
+| Default | 20000 |
+| Effective | hot-load |
+
### TsFile Configurations
* group\_size\_in\_byte
diff --git a/docs/zh/UserGuide/Reference/Common-Config-Manual.md b/docs/zh/UserGuide/Reference/Common-Config-Manual.md
index 43d48801f8..1e84d62963 100644
--- a/docs/zh/UserGuide/Reference/Common-Config-Manual.md
+++ b/docs/zh/UserGuide/Reference/Common-Config-Manual.md
@@ -994,14 +994,95 @@ IoTDB ConfigNode 和 DataNode 的通用配置参数位于 `conf` 目录下。
### 写前日志配置
-* wal\_buffer\_size
+* wal\_mode
+
+| 名字 | wal\_mode |
+|:------:|:------------------------------------------------------------------------------------|
+| 描述 | 写前日志的写入模式. DISABLE 模式下会关闭写前日志；SYNC 模式下写入请求会在成功写入磁盘后返回； ASYNC 模式下写入请求返回时可能尚未成功写入磁盘后。 |
+| 类型 | String |
+| 默认值 | ASYNC |
+| 改后生效方式 | 重启服务生效 |
+
+* max\_wal\_nodes\_num
+
+| 名字 | max\_wal\_nodes\_num |
+|:------:|:-----------------------------|
+| 描述 | 写前日志节点的最大数量，默认值 0 表示数量由系统控制。 |
+| 类型 | int32 |
+| 默认值 | 0 |
+| 改后生效方式 | 重启服务生效 |
-|名字| wal\_buffer\_size |
-|:---:|:---|
-|描述| 写前日志的 buffer 大小 |
-|类型|int32|
-|默认值| 16777216 |
-|改后生效方式|热加载|
+* fsync\_wal\_delay\_in\_ms
+
+| 名字 | fsync\_wal\_delay\_in\_ms |
+|:------:|:--------------------------|
+| 描述 | 写前日志调用 fsync 前的等待时间 |
+| 类型 | int32 |
+| 默认值 | 3 |
+| 改后生效方式 | 热加载 |
+
+* wal\_buffer\_size\_in\_byte
+
+| 名字 | wal\_buffer\_size\_in\_byte |
+|:------:|:----------------------------|
+| 描述 | 写前日志的 buffer 大小 |
+| 类型 | int32 |
+| 默认值 | 16777216 |
+| 改后生效方式 | 重启服务生效 |
+
+* wal\_buffer\_queue\_capacity
+
+| 名字 | wal\_buffer\_queue\_capacity |
+|:------:|:-----------------------------|
+| 描述 | 写前日志阻塞队列大小上限 |
+| 类型 | int32 |
+| 默认值 | 50 |
+| 改后生效方式 | 重启服务生效 |
+
+* wal\_file\_size\_threshold\_in\_byte
+
+| 名字 | wal\_file\_size\_threshold\_in\_byte |
+|:------:|:-------------------------------------|
+| 描述 | 写前日志文件封口阈值 |
+| 类型 | int32 |
+| 默认值 | 10485760 |
+| 改后生效方式 | 热加载 |
+
+* wal\_min\_effective\_info\_ratio
+
+| 名字 | wal\_min\_effective\_info\_ratio |
+|:------:|:---------------------------------|
+| 描述 | 写前日志最小有效信息比 |
+| 类型 | double |
+| 默认值 | 0.1 |
+| 改后生效方式 | 热加载 |
+
+* wal\_memtable\_snapshot\_threshold\_in\_byte
+
+| 名字 | wal\_memtable\_snapshot\_threshold\_in\_byte |
+|:------:|:---------------------------------------------|
+| 描述 | 触发写前日志中内存表快照的内存表大小阈值 |
+| 类型 | int64 |
+| 默认值 | 8388608 |
+| 改后生效方式 | 热加载 |
+
+* max\_wal\_memtable\_snapshot\_num
+
+| 名字 | max\_wal\_memtable\_snapshot\_num |
+|:------:|:----------------------------------|
+| 描述 | 写前日志中内存表的最大数量上限 |
+| 类型 | int32 |
+| 默认值 | 1 |
+| 改后生效方式 | 热加载 |
+
+* delete\_wal\_files\_period\_in\_ms
+
+| 名字 | delete\_wal\_files\_period\_in\_ms |
+|:------:|:-----------------------------------|
+| 描述 | 删除写前日志的检查间隔 |
+| 类型 | int64 |
+| 默认值 | 20000 |
+| 改后生效方式 | 热加载 |
### TsFile 配置