You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by hx...@apache.org on 2020/04/29 06:59:42 UTC

[incubator-iotdb] 01/02: correct the bloom filter setting description

This is an automated email from the ASF dual-hosted git repository.

hxd pushed a commit to branch IOTDB-626
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git

commit cfa11d75295cb343ee4041d775495a88314bdd4b
Author: xiangdong huang <sa...@gmail.com>
AuthorDate: Wed Apr 29 14:45:34 2020 +0800

    correct the bloom filter setting description
---
 docs/UserGuide/3-Server/4-Config Manual.md            | 12 ++++++++++++
 docs/UserGuide/4-Client/5-Programming - TsFile API.md | 12 ------------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/docs/UserGuide/3-Server/4-Config Manual.md b/docs/UserGuide/3-Server/4-Config Manual.md
index 2b3bedb..8717d0f 100644
--- a/docs/UserGuide/3-Server/4-Config Manual.md	
+++ b/docs/UserGuide/3-Server/4-Config Manual.md	
@@ -186,6 +186,18 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
 |Default| The default is 2 digits. Note: The 32-bit floating point number has a decimal precision of 7 bits, and the 64-bit floating point number has a decimal precision of 15 bits. If the setting is out of the range, it will have no practical significance. |
 |Effective|Trigger|
 
+
+* bloomFilterErrorRate
+
+|Name| bloomFilterErrorRate |
+|:---:|:---|
+|Description| The false positive rate of bloom filter in each TsFile. Bloom filter checks whether a given time series is in the tsfile before loading metadata. This can improve the performance of loading metadata and skip the tsfile that doesn't contain specified time series. If you want to learn more about its mechanism, you can refer to: [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).|
+|Type|float, (0, 1)|
+|Default| 0.05 |
+|Effective|After restart system|
+
+
+
 ### Engine Layer
 
 * rpc\_address
diff --git a/docs/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/UserGuide/4-Client/5-Programming - TsFile API.md
index a45d9c1..d2066bb 100644
--- a/docs/UserGuide/4-Client/5-Programming - TsFile API.md	
+++ b/docs/UserGuide/4-Client/5-Programming - TsFile API.md	
@@ -557,17 +557,5 @@ TSFileConfig config = TSFileDescriptor.getInstance().getConfig();
 config.setXXX();
 ```
 
-## Bloom filter
 
-Bloom filter checks whether a given time series is in the tsfile before loading metadata. This can improve the performance of loading metadata and skip the tsfile that doesn't contain specified time series.
-If you want to learn more about its mechanism, you can refer to: [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).
-
-#### configuration 
-
-you can control the false positive rate of bloom filter by the following parameter in the config
-
-```
-# The acceptable error rate of bloom filter, should be in [0.01, 0.1], default is 0.05
-bloomFilterErrorRate=0.05
-```