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

[zhongzc]

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:

1. Avoid using the default strategy of automatically creating an inverted index for the primary key.
2. Manually exclude some primary key columns from indexing.
3. Manually add some non-primary key columns to create indexes.
4. 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.

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

Attention: Patch coverage is 89.66790% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.82%. Comparing base (7a4276c) to head (22a38d9).
Report is 25 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4929      +/-   ##
==========================================
- Coverage   84.17%   83.82%   -0.35%     
==========================================
  Files        1137     1143       +6     
  Lines      210050   212022    +1972     
==========================================
+ Hits       176808   177738     +930     
- Misses      33242    34284    +1042     

[fengjiachun]

LGTM

[waynexia]

Rest LGTM.

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

[killme2008]

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

[zhongzc]

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

Already considered

greptimedb/src/sql/src/statements.rs

Lines 481 to 493 in 4a8183f

	// To keep compatibility,
	// 1. if inverted index columns is not set, leave it empty meaning primary key columns will be used
	// 2. if inverted index columns is set and non-empty, set selected columns to be inverted indexed
	// 3. if inverted index columns is set and empty, set primary key columns to be non-inverted indexed explicitly
	if let Some(inverted_index_cols) = invereted_index_cols {
	if inverted_index_cols.is_empty() {
	if primary_keys.contains(&column.name().value) {
	column_schema = column_schema.set_inverted_index(false);
	}
	} else if inverted_index_cols.contains(&column.name().value) {
	column_schema = column_schema.set_inverted_index(true);
	}
	}