GreptimeTeam / greptimedb

An open-source, cloud-native, distributed time-series database with PromQL/SQL/Python supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
3.96k stars 282 forks source link

feat: Implements `merge_mode` region options #4208

Closed evenyag closed 1 week ago

evenyag commented 1 week ago

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 implements a new region option update_mode to control how to update existing rows by key. There are two update modes available:

Memtables have individual dedup implementations so they can't reuse the DedupReader. To avoid repeating the dedup logic for each memtable, this PR implements a new iterator LastNotNullIter as a wrapper for the memtable iter. LastNotNullIter splits batches and invokes the LastNotNull dedup strategy to dedup them. The LastNotNullIter only takes effect when update_mode is LastNotNull.

After this PR, I will expose the option to table options and add some sqlness tests.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The recent changes introduce a MergeMode option across various components of the mito2 module to handle time series data merging strategies during compaction, scanning, and memtable operations. Updated classes, structures, and functions now accommodate a merge_mode parameter, influencing the handling of duplicate rows. Additionally, new tests ensure the correct implementation of these features.

Changes

File(s) Change Summary
.../benches/memtable_bench.rs Introduced MergeMode::LastRow in the creation of TimeSeriesMemtable for benchmarks.
.../compaction.rs Added CompactionSstReaderBuilder with merge_mode for compaction tasks.
.../compaction/compactor.rs Replaced build_sst_reader with CompactionSstReaderBuilder, included update_mode parameter.
.../compaction/window.rs Added merge_mode field in the struct within tests.
.../engine.rs Added update_mode_test module.
.../engine/merge_mode_test.rs Included tests for merge_mode functionality.
.../memtable.rs, .../memtable/partition_tree.rs, .../memtable/time_series.rs Added MergeMode to configurations and memtable constructs.
.../read/dedup.rs Introduced LastNotNullIter for custom deduplication strategies.
.../read/scan_region.rs, .../read/seq_scan.rs Integrated MergeMode in ScanInput and adjusted DedupReader for new strategy.
.../region/opener.rs, .../region/options.rs Added merge_mode field to RegionOptions, updated memtable_builder.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Engine
    participant CompactionSstReaderBuilder
    participant ScanInput

    User ->> Engine: Start compaction
    Engine ->> CompactionSstReaderBuilder: Initialize with MergeMode
    Engine ->> CompactionSstReaderBuilder: Build SST reader
    CompactionSstReaderBuilder ->> Engine: Return SST reader
    Engine ->> ScanInput: Configure with MergeMode
    ScanInput ->> Engine: Initiate scanning
    Engine ->> User: Return compaction results

Poem

On data fields where time's in play, A merge mode comes to save the day. With LastRow set and columns bright, Rows combine in seamless flight. Rabbits coding, lines so neat, Bugs defeated, a code complete! πŸ‡πŸ“œβœ¨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 97.17742% with 14 lines in your changes missing coverage. Please review.

Project coverage is 84.60%. Comparing base (948c869) to head (11936c4). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4208 +/- ## ========================================== - Coverage 84.85% 84.60% -0.25% ========================================== Files 1040 1042 +2 Lines 183023 183488 +465 ========================================== - Hits 155297 155238 -59 - Misses 27726 28250 +524 ```
killme2008 commented 1 week ago

I am not convinced that UpdateMode is an appropriate term. It is utilized during scanning to combine duplicate rows, but referred to as UpdateMode. Personally, I would like MergeMode or ScanMergeMode like that.

fengjiachun commented 1 week ago

I am not convinced that UpdateMode is an appropriate term. It is utilized during scanning to combine duplicate rows, but referred to as UpdateMode. Personally, I would like MergeMode or ScanMergeMode like that.

UpdateMode seems to be viewed from the perspective of writing. cc @evenyag

evenyag commented 1 week ago

I am not convinced that UpdateMode is an appropriate term. It is utilized during scanning to combine duplicate rows, but referred to as UpdateMode. Personally, I would like MergeMode or ScanMergeMode like that.

UpdateMode seems to be viewed from the perspective of writing. cc @evenyag

Good idea. MergeMode may be proper.

killme2008 commented 1 week ago

@evenyag Don't forget to change the PR title and content.

evenyag commented 1 week ago

@coderabbitai pause

coderabbitai[bot] commented 1 week ago
Actions performed Reviews paused.