GreptimeTeam / greptimedb

An open-source, cloud-native, unified time series database for metrics, logs and events with SQL/PromQL supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
4.23k stars 303 forks source link

refactor(inverted_index): integrate puffin manager with sst indexer #4285

Closed zhongzc closed 3 months ago

zhongzc commented 3 months ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

4246

What's changed and what's your intention?

...to make room for the addition of full-text indexer

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months 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 update introduces a new configuration parameter region_engine.mito.inverted_index.compress to control the compression of inverted index data. It also refactors the handling and management of inverted index creation, including restructuring indexer logic and updating various modules. Additionally, deprecated settings are replaced, and new default values are defined. Error handling and configuration are streamlined, enhancing the robustness and maintainability of the system.

Changes

File(s) Change Summary
config/config.md, .../datanode.example.toml, .../standalone.example.toml Added new configuration compress for inverted index data. Deprecated intermediate_path.
src/mito2/src/access_layer.rs Introduced OperationType enum. Refactored SstWriteRequest to use InvertedIndexConfig.
src/mito2/src/cache/write_cache.rs Added PuffinManagerFactory. Updated WriteCache methods.
src/mito2/src/compaction/compactor.rs Removed old index configuration. Added inverted_index_config. Refined index determination during compaction.
src/mito2/src/config.rs Added compress field to InvertedIndexConfig struct.
src/mito2/src/engine/basic_test.rs Updated assertion value in test_region_usage function.
src/mito2/src/error.rs Removed PuffinFinish variant from Error enum.
src/mito2/src/flush.rs Refactored SstWriteRequest and RegionFlushTask logic.
src/mito2/src/read/scan_region.rs Updated import paths for SstIndexApplierBuilder and SstIndexApplierRef.
src/mito2/src/sst/index.rs, src/mito2/src/sst/index/indexer.rs Introduced new indexer module structure. Updated index creation logic.
src/mito2/src/sst/index/indexer/abort.rs, src/mito2/src/sst/index/indexer/finish.rs Added methods for aborting and finishing index processes.
src/mito2/src/sst/index/indexer/update.rs Introduced methods for updating inverted index within Indexer struct.
.../sst/index/inverted_index.rs, .../sst/index/inverted_index/applier.rs Updated module structure for managing inverted index.
.../sst/index/inverted_index/applier/builder.rs Updated import paths for SstIndexApplierBuilder.
.../sst/index/inverted_index/applier/builder/{between.rs, comparison.rs, eq_list.rs, in_list.rs} Updated import paths for SstIndexApplierBuilder in respective modules.
.../sst/index/inverted_index/applier/builder/regex_match.rs Updated import paths for SstIndexApplierBuilder and related tests.

Poem

In the code fields, changes bloom,
Inverted indexes do resume.
Compress or not, the choice's here,
Enhancements bring much cheer!
Refactored paths and fresher air,
Errors handled with much care.
The system stands robust, a new frontier! 🌸


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.
zhongzc commented 3 months ago

@coderabbitai pause

coderabbitai[bot] commented 3 months ago
Actions performed Reviews paused.
codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 78.57143% with 78 lines in your changes missing coverage. Please review.

Project coverage is 85.02%. Comparing base (6e2c21d) to head (133d354). Report is 9 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4285 +/- ## ========================================== + Coverage 84.96% 85.02% +0.05% ========================================== Files 1061 1066 +5 Lines 188124 188473 +349 ========================================== + Hits 159845 160251 +406 + Misses 28279 28222 -57 ```