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 2020/04/30 01:18:27 UTC
[incubator-iotdb] branch master updated: [IOTDB-626] Fix UserGuide
error of v0.9.x (#1123)
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/incubator-iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 35de74a [IOTDB-626] Fix UserGuide error of v0.9.x (#1123)
35de74a is described below
commit 35de74ac857c7da4c71941415e8e0634cd5843fe
Author: Xiangdong Huang <hx...@qq.com>
AuthorDate: Thu Apr 30 09:18:16 2020 +0800
[IOTDB-626] Fix UserGuide error of v0.9.x (#1123)
* correct the bloom filter setting description
* remove incorrect docs in v0.9.0
---
docs/UserGuide/3-Server/4-Config Manual.md | 12 ++++++++++++
docs/UserGuide/4-Client/5-Programming - TsFile API.md | 12 ------------
docs/zh/UserGuide/3-Server/4-Config Manual.md | 13 +++++++++++++
docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md | 13 -------------
site/src/main/.vuepress/config.js | 6 ++----
5 files changed, 27 insertions(+), 29 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
-```
diff --git a/docs/zh/UserGuide/3-Server/4-Config Manual.md b/docs/zh/UserGuide/3-Server/4-Config Manual.md
index 73ad3f1..7e77992 100644
--- a/docs/zh/UserGuide/3-Server/4-Config Manual.md
+++ b/docs/zh/UserGuide/3-Server/4-Config Manual.md
@@ -157,6 +157,19 @@
|默认值| 默认为2位。注意：32位浮点数的十进制精度为7位，64位浮点数的十进制精度为15位。如果设置超过机器精度将没有实际意义。|
|改后生效方式|触发生效|
+
+* bloomFilterErrorRate
+
+|名字| bloomFilterErrorRate |
+|:---:|:---|
+|描述| bloom过滤器的误报率. 在加载元数据之前 Bloom filter 可以检查给定的时间序列是否在 TsFile 中。这可以优化加载元数据的性能，并跳过不包含指定时间序列的 TsFile。如果你想了解更多关于它的细节，你可以参考: [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).|
+|类型|浮点数, 范围为(0, 1)|
+|默认值| 0.05 |
+|改后生效方式|重启生效|
+
+
+
+
### 引擎层配置
* back\_loop\_period\_in\_second
diff --git a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
index f657664..99987cd 100644
--- a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
+++ b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md
@@ -553,16 +553,3 @@ TSFileConfig config = TSFileDescriptor.getInstance().getConfig();
config.setXXX();
```
-## Bloom filter
-
-在加载元数据之前 Bloom filter 可以检查给定的时间序列是否在 TsFile 中。这可以优化加载元数据的性能，并跳过不包含指定时间序列的 TsFile。
-如果你想了解更多关于它的细节，你可以参考: [wiki page of bloom filter](https://en.wikipedia.org/wiki/Bloom_filter).
-
-#### 配置
-
-您可以通过修改 TsFileConfig 中的配置项来控制bloom过滤器的误报率：
-
-```
-# The acceptable error rate of bloom filter, should be in [0.01, 0.1], default is 0.05
-bloomFilterErrorRate=0.05
-```
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index a2b0eb4..eff5ed5 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -271,8 +271,7 @@ var config = {
['6-System Tools/4-Watermark Tool','Watermark Tool'],
['6-System Tools/5-Log Visualizer','Log Visualizer'],
['6-System Tools/6-Query History Visualization Tool','Query History Visualization Tool'],
- ['6-System Tools/7-Monitor and Log Tools','Monitor and Log Tools'],
- ['6-System Tools/8-Load External Tsfile','Load External Tsfile']
+ ['6-System Tools/7-Monitor and Log Tools','Monitor and Log Tools']
]
},
{
@@ -686,8 +685,7 @@ var config = {
['6-System Tools/4-Watermark Tool','水印工具'],
['6-System Tools/5-Log Visualizer','日志可视化工具'],
['6-System Tools/6-Query History Visualization Tool','查询历史可视化工具'],
- ['6-System Tools/7-Monitor and Log Tools','监控与日志工具'],
- ['6-System Tools/8-Load External Tsfile','加载外部tsfile文件']
+ ['6-System Tools/7-Monitor and Log Tools','监控与日志工具']
]
},
{