feat(metric-engine): introduce index options from metric engine #5374

WenyXu · 2025-01-15T15:27:18Z

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?

This PR introduces index options to the metric engine, addressing scenarios with high cardinality where inverted index files can grow excessively large. By allowing users to specify index types and parameters, such as skipping indexes with customizable granularity, users can better control index behavior and optimize storage.

For example:
In this case, all auto-added columns will apply the index options specified by the user.

CREATE TABLE phy (
    ts TIMESTAMP TIME INDEX, 
    val DOUBLE
) ENGINE=metric WITH (
    "physical_metric_table" = "", 
    "index.type" = "skipping", 
    "index.granularity" = "8192"
);

If a logical table is created on the physical table:

CREATE TABLE t1 (
    ts TIMESTAMP TIME INDEX, 
    val DOUBLE, 
    host STRING PRIMARY KEY
) ENGINE=metric WITH (
    "on_physical_table" = "phy"
);

The resulting physical table will have the following schema:

+-------+---------------------------------------------------------------------------------+
| Table | Create Table                                                                    |
+-------+---------------------------------------------------------------------------------+
| phy   | CREATE TABLE IF NOT EXISTS "phy" (                                              |
|       |   "ts" TIMESTAMP(3) NOT NULL,                                                   |
|       |   "val" DOUBLE NULL,                                                            |
|       |   "host" STRING NULL SKIPPING INDEX WITH(granularity = '8192', type = 'BLOOM'), |
|       |   TIME INDEX ("ts"),                                                            |
|       |   PRIMARY KEY ("host"),                                                         |
|       | )                                                                               |
|       |                                                                                 |
|       | ENGINE=metric                                                                   |
|       | WITH(                                                                           |
|       |   'index.granularity' = '8192',                                                 |
|       |   'index.type' = 'skipping',                                                    |
|       |   physical_metric_table = ''                                                    |
|       | )                                                                               |
+-------+---------------------------------------------------------------------------------+

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.

coderabbitai · 2025-01-15T15:27:25Z

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.

zhongzc · 2025-01-16T13:20:46Z

tests/cases/standalone/common/create/create_metric_table.result

@@ -71,6 +71,27 @@ DESC TABLE phy;
 | job        | String               | PRI | YES  |         | TAG           |
 +------------+----------------------+-----+------+---------+---------------+

+SHOW CREATE TABLE phy;


Why can’t see the __table_id and __tsid columns?

The __table_id and __tsid are internal columns, and these columns and column options will be generated via the metric engine.

src/metric-engine/src/engine/create.rs

zhongzc · 2025-01-16T13:31:08Z

src/metric-engine/src/engine/create.rs

@@ -529,7 +542,8 @@ impl MetricEngineInner {
                DATA_SCHEMA_TSID_COLUMN_NAME,
                ConcreteDataType::uint64_datatype(),
                false,
-            ),
+            )
+            .with_inverted_index(false),


Let's clean up

greptimedb/src/metric-engine/src/engine/options.rs

Lines 36 to 39 in 7eaabb3

options.insert(

"index.inverted_index.ignore_column_ids".to_string(),

IGNORE_COLUMN_IDS_FOR_DATA_REGION.iter().join(","),

);

zhongzc · 2025-01-16T13:33:34Z

src/metric-engine/src/data_region.rs

@@ -142,6 +148,19 @@ impl DataRegion {

                c.column_id = new_column_id_start + delta as u32;
                c.column_schema.set_nullable();
+                match index_options {
+                    IndexOptions::Inverted => {
+                        c.column_schema.set_inverted_index(true);


This is an incompatible change. Once the schema of a certain column is explicitly set to have an inverted key, the condition for indexing the tag by default will be destroyed.

Yes... it's ok for the newly created table. But it's problematic to alter these options.

WenyXu requested review from waynexia, v0y4g3r and a team as code owners January 15, 2025 15:27

github-actions bot added docs-not-required This change does not impact docs. docs-required This change requires docs update. and removed docs-not-required This change does not impact docs. labels Jan 15, 2025

sunng87 mentioned this pull request Jan 15, 2025

Update docs for feat(metric-engine): introduce index options from metric engine GreptimeTeam/docs#1476

Open

github-actions bot added docs-not-required This change does not impact docs. and removed docs-required This change requires docs update. labels Jan 15, 2025

WenyXu requested a review from fengjiachun January 15, 2025 15:36

WenyXu mentioned this pull request Jan 15, 2025

Tracking Issue: Sparse primary key codec #5282

Open

6 tasks

WenyXu force-pushed the feat/metric-table-index-options branch from c26eb4a to f8e301a Compare January 15, 2025 15:56

WenyXu requested a review from evenyag as a code owner January 15, 2025 16:14

WenyXu added 10 commits January 16, 2025 08:35

feat(metric-engine): introduce index options from metric engine

0adeec0

chore: fmt toml

4b2d415

test: add sqlness test

45904ab

fix: ignore internal columns

854fe61

chore: remove unused dep

dc3e020

chore: update sqlness result

6974830

chore: ignore metric engine internal columns

a1b6c97

chore: refine code styling

290be1f

test: update sqlness test

9f7915f

refactor: refactor create_table_constraints

edea1c6

WenyXu force-pushed the feat/metric-table-index-options branch from 3f1c718 to edea1c6 Compare January 16, 2025 08:41

zhongzc reviewed Jan 16, 2025

View reviewed changes

src/metric-engine/src/engine/create.rs Show resolved Hide resolved

zhongzc reviewed Jan 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(metric-engine): introduce index options from metric engine #5374

feat(metric-engine): introduce index options from metric engine #5374

WenyXu commented Jan 15, 2025 •

edited

Loading

coderabbitai bot commented Jan 15, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

zhongzc Jan 16, 2025

WenyXu Jan 16, 2025

zhongzc Jan 16, 2025

zhongzc Jan 16, 2025

WenyXu Jan 16, 2025

	options.insert(
	"index.inverted_index.ignore_column_ids".to_string(),
	IGNORE_COLUMN_IDS_FOR_DATA_REGION.iter().join(","),
	);

feat(metric-engine): introduce index options from metric engine #5374

Are you sure you want to change the base?

feat(metric-engine): introduce index options from metric engine #5374

Conversation

WenyXu commented Jan 15, 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 15, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

zhongzc Jan 16, 2025

Choose a reason for hiding this comment

WenyXu Jan 16, 2025

Choose a reason for hiding this comment

zhongzc Jan 16, 2025

Choose a reason for hiding this comment

zhongzc Jan 16, 2025

Choose a reason for hiding this comment

WenyXu Jan 16, 2025

Choose a reason for hiding this comment

WenyXu commented Jan 15, 2025 •

edited

Loading