feat(index): support SQL to specify inverted index columns #4929

zhongzc · 2024-11-03T22:04:27Z

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?

Allow specifying inverted index columns and support the following scenarios:

Avoid using the default strategy of automatically creating an inverted index for the primary key.
Manually exclude some primary key columns from indexing.
Manually add some non-primary key columns to create indexes.
Do not create an inverted index.

SQL statement example:

CREATE TABLE t (
  "ts" TIMESTAMP,
  "host" STRING,
  "job" STRING,
  "val" DOUBLE,
  TIME INDEX("ts"),
  PRIMARY KEY("host", "job"),
  INVERTED INDEX("job", "val")
);

Checklist

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

…ols-to-engine

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

coderabbitai · 2024-11-03T22:04:34Z

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 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.

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

…ols-to-engine

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

codecov · 2024-11-04T09:12:54Z

Codecov Report

Attention: Patch coverage is 88.33333% with 35 lines in your changes missing coverage. Please review.

Project coverage is 83.97%. Comparing base (7a4276c) to head (4a8183f).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4929      +/-   ##
==========================================
- Coverage   84.17%   83.97%   -0.20%     
==========================================
  Files        1137     1137              
  Lines      210050   210227     +177     
==========================================
- Hits       176808   176540     -268     
- Misses      33242    33687     +445

fengjiachun

LGTM

waynexia

Rest LGTM.

We may consider adding support for specifying this in the "column constrain" position in a follow-up PR

waynexia · 2024-11-07T14:24:45Z

src/api/src/v1/column_def.rs

 /// Key used to store fulltext options in gRPC column options.
 const FULLTEXT_GRPC_KEY: &str = "fulltext";
+/// Key used to store inverted index options in gRPC column options.
+const INVERTED_INDEX_GRPC_KEY: &str = "inverted_index";


random think: no grpc key for vector index(

waynexia · 2024-11-07T14:26:51Z

src/datatypes/src/schema/column_schema.rs

+    pub fn is_inverted_indexed(&self) -> bool {
+        self.metadata
+            .get(INVERTED_INDEX_KEY)
+            .map(|v| v == "true")


should we ignore case in this comparison?

waynexia · 2024-11-07T14:28:56Z

src/mito2/src/read/scan_region.rs

+        let pk_as_inverted_index = !self
+            .version
+            .metadata
+            .column_metadatas
+            .iter()
+            .any(|c| c.column_schema.has_inverted_index_key());


Would it be better to put this "default" logic on someplace closer to protocol layer rather than on storage engine layer?

waynexia · 2024-11-07T14:29:59Z

src/mito2/src/sst/index.rs

@@ -292,6 +277,35 @@ impl<'a> IndexerBuilder<'a> {

        None
    }
+
+    fn inverted_indexed_column_ids(&self) -> HashSet<ColumnId> {


Seems duplicated with the one in ScanRegion

killme2008 · 2024-11-08T15:12:59Z

Do we consider the compatibility with the old data? @zhongzc

zhongzc added 5 commits October 27, 2024 21:58

feat(index): support building inverted index for the field column

59361bb

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

feat(index): support SQL to specify inverted index columns

1ea51e3

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

Merge remote-tracking branch 'origin/main' into zhongzc/sql-indexed-c…

c02eefc

…ols-to-engine

test: fix sqlness

146e19a

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

fix: consider compatibility

82508f4

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

zhongzc requested review from evenyag, v0y4g3r, waynexia and a team as code owners November 3, 2024 22:04

github-actions bot added the docs-required This change requires docs update. label Nov 3, 2024

sunng87 mentioned this pull request Nov 3, 2024

Update docs for feat(index): support SQL to specify inverted index columns GreptimeTeam/docs#1261

Open

zhongzc added 3 commits November 3, 2024 22:10

polish

f6667cb

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

Merge remote-tracking branch 'origin/main' into zhongzc/sql-indexed-c…

a01ed57

…ols-to-engine

compatibility

78d9243

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

zhongzc force-pushed the zhongzc/sql-indexed-cols-to-engine branch from 601b6fb to 78d9243 Compare November 4, 2024 08:47

fix

4a8183f

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>

fengjiachun approved these changes Nov 5, 2024

View reviewed changes

waynexia approved these changes Nov 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(index): support SQL to specify inverted index columns #4929

feat(index): support SQL to specify inverted index columns #4929

zhongzc commented Nov 3, 2024

coderabbitai bot commented Nov 3, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Nov 4, 2024 •

edited

Loading

fengjiachun left a comment

waynexia left a comment

waynexia Nov 7, 2024

waynexia Nov 7, 2024

waynexia Nov 7, 2024

waynexia Nov 7, 2024

killme2008 commented Nov 8, 2024

feat(index): support SQL to specify inverted index columns #4929

Are you sure you want to change the base?

feat(index): support SQL to specify inverted index columns #4929

Conversation

zhongzc commented Nov 3, 2024

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Nov 3, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Nov 4, 2024 • edited Loading

Codecov Report

fengjiachun left a comment

Choose a reason for hiding this comment

waynexia left a comment

Choose a reason for hiding this comment

waynexia Nov 7, 2024

Choose a reason for hiding this comment

waynexia Nov 7, 2024

Choose a reason for hiding this comment

waynexia Nov 7, 2024

Choose a reason for hiding this comment

waynexia Nov 7, 2024

Choose a reason for hiding this comment

killme2008 commented Nov 8, 2024

codecov bot commented Nov 4, 2024 •

edited

Loading