[iotdb] branch master updated: fix wal buffer annotation (#2311)

[qi...@apache.org]

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 63c2aad  fix wal buffer annotation (#2311)
63c2aad is described below

commit 63c2aadffb6e5ec6eed0a6298f318aac1805f5b1
Author: HouliangQi <ne...@163.com>
AuthorDate: Sat Dec 26 13:31:42 2020 +0800

    fix wal buffer annotation (#2311)
---
 server/src/assembly/resources/conf/iotdb-engine.properties     | 5 +++--
 server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java | 5 +++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/server/src/assembly/resources/conf/iotdb-engine.properties b/server/src/assembly/resources/conf/iotdb-engine.properties
index 538d972..5e2fe20 100644
--- a/server/src/assembly/resources/conf/iotdb-engine.properties
+++ b/server/src/assembly/resources/conf/iotdb-engine.properties
@@ -177,8 +177,9 @@ timestamp_precision=ms
 # data.
 # default_ttl=36000000
 
-# Size of log buffer in each log node(in byte).
-# If WAL is enabled and the size of a insert plan is larger than this parameter, then the insert plan will be rejected by WAL
+# The size of the log buffer in each log node (in bytes). Due to the double buffer mechanism,
+# if WAL is enabled and the size of the inserted plan is greater than one-half of this parameter,
+# then the insert plan will be rejected by WAL.
 # If it sets a value smaller than 0, use the default value 16777216
 wal_buffer_size=16777216
 
diff --git a/server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java b/server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java
index 48db870..fe5d584 100644
--- a/server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java
+++ b/server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java
@@ -202,8 +202,9 @@ public class IoTDBConfig {
   private long forceWalPeriodInMs = 100;
 
   /**
-   * Size of log buffer in each log node(in byte). If WAL is enabled and the size of a insert plan
-   * is larger than this parameter, then the insert plan will be rejected by WAL.
+   * The size of the log buffer in each log node (in bytes). Due to the double buffer mechanism, if
+   * WAL is enabled and the size of the inserted plan is greater than one-half of this parameter,
+   * then the insert plan will be rejected by WAL.
    */
   private int walBufferSize = 16 * 1024 * 1024;