Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(metric-engine): support to write rows with sparse primary key encoding #5424

Merged
merged 9 commits into from
Jan 24, 2025

Conversation

WenyXu
Copy link
Member

@WenyXu WenyXu commented Jan 22, 2025

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

#5282

What's changed and what's your intention?

This PR introduces the ability for users to create physical tables with experimental sparse primary key encoding. There are two ways to enable this feature:

Table-Level Configuration

You can specify the sparse primary key encoding directly when creating a table:

CREATE TABLE greptime_physical_table (
    greptime_timestamp TIMESTAMP(3) NOT NULL,
    greptime_value DOUBLE NULL,
    TIME INDEX (greptime_timestamp)
) ENGINE = metric WITH (
    "physical_metric_table" = "",   
    "memtable.type" = "partition_tree",
    "memtable.partition_tree.primary_key_encoding" = "sparse"
);

Engine-Level Configuration

Alternatively, you can enable sparse primary key encoding at the engine level using the config.toml file:

[[region_engine]]
[region_engine.metric]
experimental_sparse_primary_key_encoding = true

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.

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

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.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jan 22, 2025
@WenyXu WenyXu force-pushed the feat/write-kv-with-hint branch from c30542f to 9df1ba2 Compare January 23, 2025 08:02
@WenyXu WenyXu force-pushed the feat/write-kv-with-hint branch 2 times, most recently from e004d28 to 22445c4 Compare January 23, 2025 09:17
@WenyXu WenyXu changed the title feat: support to write rows with sparse primary key encoding feat(metric-engine): support to write rows with sparse primary key encoding Jan 23, 2025
@WenyXu WenyXu marked this pull request as ready for review January 23, 2025 09:44
@WenyXu WenyXu requested review from waynexia, v0y4g3r, evenyag and a team as code owners January 23, 2025 09:44
@WenyXu WenyXu force-pushed the feat/write-kv-with-hint branch 2 times, most recently from b0025f9 to 2fdd03f Compare January 23, 2025 12:01
@WenyXu WenyXu force-pushed the feat/write-kv-with-hint branch from 2fdd03f to a667451 Compare January 23, 2025 12:05
src/metric-engine/src/engine/put.rs Outdated Show resolved Hide resolved
src/mito2/src/memtable/key_values.rs Show resolved Hide resolved
src/mito2/src/memtable/key_values.rs Show resolved Hide resolved
src/metric-engine/src/engine/create.rs Outdated Show resolved Hide resolved
src/mito2/src/request.rs Show resolved Hide resolved
src/mito2/src/sst/parquet/writer.rs Show resolved Hide resolved
src/metric-engine/src/engine/open.rs Outdated Show resolved Hide resolved
src/metric-engine/src/engine/options.rs Outdated Show resolved Hide resolved
Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

@WenyXu WenyXu enabled auto-merge January 24, 2025 06:15
@WenyXu WenyXu force-pushed the feat/write-kv-with-hint branch from fc401ad to 3ace61b Compare January 24, 2025 06:31
@WenyXu WenyXu added this pull request to the merge queue Jan 24, 2025
Merged via the queue into GreptimeTeam:main with commit b107384 Jan 24, 2025
37 checks passed
@WenyXu WenyXu deleted the feat/write-kv-with-hint branch January 24, 2025 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants