feat: bloom filter as fulltext index v2 (Part 1) #5406

zhongzc · 2025-01-20T06:59:02Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Introduced Tokenizer and Analyzer
Added BloomFilterFulltextIndexCreator as an alternative to TantivyFulltextIndexCreator

PR Checklist

Please convert it to a draft if some of the following conditions are not met.

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.
API changes are backward compatible.
Schema or data changes are backward compatible.

Signed-off-by: Zhenchi <[email protected]>

…loom

coderabbitai · 2025-01-20T06:59:08Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

killme2008

Good job!

src/index/src/fulltext_index/create.rs

src/index/src/fulltext_index/tokenizer.rs

src/mito2/src/sst/index/fulltext_index/creator.rs

killme2008 · 2025-01-20T07:56:11Z

src/index/src/fulltext_index/tokenizer.rs

+
+impl Tokenizer for EnglishTokenizer {
+    fn tokenize<'a>(&self, text: &'a str) -> Vec<&'a str> {
+        text.split(|c: char| !c.is_alphabetic())


So it will drop the not-alphabetic words such as numbers, operators, etc.?

I think the tokenizer needs some unit test cases.

good catch. I have changed it to is_alphanumeric which is consistent with tantivy

killme2008 · 2025-01-20T07:59:39Z

I think v1 and v2 may not be good names, what about using specific implementation names such as tantivy and bloomfilter?

Signed-off-by: Zhenchi <[email protected]>

zhongzc · 2025-01-20T09:16:33Z

I think v1 and v2 may not be good names, what about using specific implementation names such as tantivy and bloomfilter?

I have changed the enum variants to Tantivy and Bloom. Is it necessary to change the blob type as well?

greptimedb/src/mito2/src/sst/index/fulltext_index.rs

Lines 18 to 19 in 2bb4daf

    
           const INDEX_BLOB_TYPE_V1: &str = "greptime-fulltext-index-v1"; 
        
           const INDEX_BLOB_TYPE_V2: &str = "greptime-fulltext-index-v2";

Signed-off-by: Zhenchi <[email protected]>

fengjiachun

LGTM

killme2008 · 2025-01-21T03:17:56Z

I think v1 and v2 may not be good names, what about using specific implementation names such as tantivy and bloomfilter?

I have changed the enum variants to Tantivy and Bloom. Is it necessary to change the blob type as well?

greptimedb/src/mito2/src/sst/index/fulltext_index.rs

Lines 18 to 19 in 2bb4daf

const INDEX_BLOB_TYPE_V1: &str = "greptime-fulltext-index-v1";

const INDEX_BLOB_TYPE_V2: &str = "greptime-fulltext-index-v2";

Yes, I believe so. The names are more meaningful to users.

Copilot reviewed 25 out of 40 changed files in this pull request and generated no comments.

Files not reviewed (15)

src/index/src/fulltext_index/tokenizer.rs: Evaluated as low risk
src/index/src/bloom_filter.rs: Evaluated as low risk
src/index/src/inverted_index/create/sort/intermediate_rw/codec_v1.rs: Evaluated as low risk
src/index/src/fulltext_index.rs: Evaluated as low risk
src/index/src/inverted_index/create/sort/external_sort.rs: Evaluated as low risk
src/index/src/inverted_index/create.rs: Evaluated as low risk
src/index/src/inverted_index/create/sort/intermediate_rw.rs: Evaluated as low risk
src/index/src/bloom_filter/creator/finalize_segment.rs: Evaluated as low risk
src/index/src/inverted_index/create/sort/merge_stream.rs: Evaluated as low risk
src/index/src/bloom_filter/applier.rs: Evaluated as low risk
src/index/src/inverted_index/create/sort.rs: Evaluated as low risk
src/common/base/src/range_read.rs: Evaluated as low risk
src/index/src/bloom_filter/creator.rs: Evaluated as low risk
src/index/src/inverted_index.rs: Evaluated as low risk
src/index/src/fulltext_index/create.rs: Evaluated as low risk

zhongzc added 2 commits January 20, 2025 06:58

feat: bloom filter as fulltext index v2

f754d51

Signed-off-by: Zhenchi <[email protected]>

Merge remote-tracking branch 'origin/main' into zhongzc/fulltext-v2-b…

cdc9834

…loom

zhongzc requested review from evenyag, v0y4g3r, waynexia and a team as code owners January 20, 2025 06:59

zhongzc changed the title ~~feat: bloom filter as fulltext index v2~~ feat: bloom filter as fulltext index v2 (Part 1) Jan 20, 2025

github-actions bot added the docs-not-required This change does not impact docs. label Jan 20, 2025

killme2008 reviewed Jan 20, 2025

View reviewed changes

zhongzc marked this pull request as draft January 20, 2025 08:54

zhongzc added 3 commits January 20, 2025 09:02

add unit tests for tokenizer

047fd3a

Signed-off-by: Zhenchi <[email protected]>

address comments

6ca5e00

Signed-off-by: Zhenchi <[email protected]>

address comments

2bb4daf

Signed-off-by: Zhenchi <[email protected]>

refactor dup vars

78e1d90

Signed-off-by: Zhenchi <[email protected]>

zhongzc marked this pull request as ready for review January 20, 2025 09:35

fengjiachun approved these changes Jan 21, 2025

View reviewed changes

waynexia requested a review from Copilot January 21, 2025 03:34

Copilot AI reviewed Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: bloom filter as fulltext index v2 (Part 1) #5406

feat: bloom filter as fulltext index v2 (Part 1) #5406

zhongzc commented Jan 20, 2025 •

edited

Loading

coderabbitai bot commented Jan 20, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

killme2008 left a comment

killme2008 Jan 20, 2025

zhongzc Jan 20, 2025

killme2008 commented Jan 20, 2025

zhongzc commented Jan 20, 2025

fengjiachun left a comment

killme2008 commented Jan 21, 2025

feat: bloom filter as fulltext index v2 (Part 1) #5406

Are you sure you want to change the base?

feat: bloom filter as fulltext index v2 (Part 1) #5406

Conversation

zhongzc commented Jan 20, 2025 • edited Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

PR Checklist

coderabbitai bot commented Jan 20, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

killme2008 left a comment

Choose a reason for hiding this comment

killme2008 Jan 20, 2025

Choose a reason for hiding this comment

zhongzc Jan 20, 2025

Choose a reason for hiding this comment

killme2008 commented Jan 20, 2025

zhongzc commented Jan 20, 2025

fengjiachun left a comment

Choose a reason for hiding this comment

killme2008 commented Jan 21, 2025

Choose a reason for hiding this comment

zhongzc commented Jan 20, 2025 •

edited

Loading