You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by bu...@apache.org on 2025/07/03 02:25:46 UTC
(skywalking-banyandb) branch main updated: Add documentation for skipping index (#666)
This is an automated email from the ASF dual-hosted git repository.
butterbright pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
The following commit(s) were added to refs/heads/main by this push:
new cf0f13e9 Add documentation for skipping index (#666)
cf0f13e9 is described below
commit cf0f13e9a0d97da9632726ccb8c291ff6b128feb
Author: Huang Youliang <bu...@gmail.com>
AuthorDate: Thu Jul 3 10:25:40 2025 +0800
Add documentation for skipping index (#666)
* Add documentation for skipping index
---
docs/concept/data-model.md | 2 +-
docs/concept/tsdb.md | 11 ++++++-----
docs/menu.yml | 2 +-
3 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/docs/concept/data-model.md b/docs/concept/data-model.md
index 00a6a522..42c9cb1c 100644
--- a/docs/concept/data-model.md
+++ b/docs/concept/data-model.md
@@ -264,7 +264,7 @@ tags:
type: TYPE_INVERTED
```
-IndexRule supports selecting two distinct kinds of index structures. The `INVERTED` index is the primary option when users set up an index rule. It's suitable for most tag indexing due to a better memory usage ratio and query performance.
+IndexRule supports several kinds of index structures. The `INVERTED` index is suitable for measure tag indexing due to better query performance. The `SKIPPING` index is optimized for the majority of stream tags, which prioritizes efficient space utilization. The `TREE` index is designed for storing hierarchical data.
```yaml
metadata:
diff --git a/docs/concept/tsdb.md b/docs/concept/tsdb.md
index ed2fdcf8..3a4aa8c8 100644
--- a/docs/concept/tsdb.md
+++ b/docs/concept/tsdb.md
@@ -57,8 +57,8 @@ The `primary.bin` file contains the index of each [block](#Block). Through it, t
Notably, for data of the `Stream` type, since there are no field columns, the `fields.bin` file does not exist, while the rest of the structure is entirely consistent with the `Measure` type.
-
-
+
+
## Block
@@ -68,10 +68,11 @@ The diagram below shows the detailed fields within each block. The block is the
In measure's timestamp file, there are version fields to record the version of the data. The version field is used to deduplicate. It determine the latest data when the data's timestamp are identical. Only the latest data will be returned to the user.
-
+
-Unlike the measure, there are element ids in the stream's timestamp file. The element id is used to identify the data of the same series. The data with the same timestamp but different element id will both be stored in the TSDB.
-
+Unlike the measure, there are element ids in the stream's timestamp file. The element id is used to identify the data of the same series. The data with the same timestamp but different element id will both be stored in the TSDB. This introduces a series of new files, named "*.tff", which contain bloom filters for each tag, enabling efficient skipping of irrelevant data. Additionally, min/max fields are added to the "*.tfm" file to further aid in skipping blocks.
+
+
## Write Path
diff --git a/docs/menu.yml b/docs/menu.yml
index 4e2d28ec..4561aabf 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -139,7 +139,7 @@ catalog:
path: "/operation/lifecycle"
- name: "File Format"
catalog:
- - name: "v1.2.0"
+ - name: "v1.3.0"
path: "/concept/tsdb"
- name: "Concepts"
catalog: