GreptimeTeam / greptimedb

An Open-Source, Cloud-Native, Unified Time Series Database for Metrics, Events, and Logs with SQL/PromQL supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
4k stars 289 forks source link

feat(fulltext_index): integrate full-text indexer with sst writer #4302

Closed zhongzc closed 1 week ago

zhongzc commented 1 week 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?

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 changes introduce and integrate comprehensive full-text indexing capabilities into the Mito engine. Configurations for index creation during flush, compaction, and querying, along with memory thresholds, are introduced. New public constants and methods handle the configuration schema and error-handling mechanisms. The full-text index functionalities are integrated across key components, including compaction, flushing, and caching processes, enhancing the overall indexing and search capabilities of the engine.

Changes

Files Change Summary
config/config.md, config/datanode.example.toml, config/standalone.example.toml Introduced configuration options for full-text indexing, including settings for index creation on flush, compaction, and query, and memory threshold for index creation.
src/datatypes/src/schema.rs, src/datatypes/src/schema/column_schema.rs Added FulltextAnalyzer and FulltextOptions, constants for full-text keys, and methods in ColumnSchema for retrieving full-text options.
src/mito2/src/access_layer.rs, src/mito2/src/cache/write_cache.rs Incorporated fulltext_index_config into the AccessLayer and WriteCache structs.
src/mito2/src/compaction/compactor.rs, src/mito2/src/flush.rs Added handling of fulltext_index_config in compaction and flush tasks, integrating full-text indexing into these processes.
src/mito2/src/config.rs, src/mito2/src/error.rs Added FulltextIndexConfig struct with configurations and new error variants for full-text indexing.
src/mito2/src/sst/file.rs, src/mito2/src/sst/index.rs, src/mito2/src/sst/index/fulltext_index.rs Included FulltextIndex in FileMeta, IndexType, and added methods for full-text index availability and creation.
src/mito2/src/sst/index/fulltext_index/creator.rs Introduced SstIndexCreator and SingleCreator structs for creating and managing full-text indexes, with methods for updating, finishing, and aborting index creation.
src/mito2/src/sst/index/indexer/abort.rs, src/mito2/src/sst/index/indexer/finish.rs, src/mito2/src/sst/index/indexer/update.rs Added functions for aborting, finishing, and updating full-text indexes within the Indexer implementation.
src/mito2/src/sst/index/intermediate.rs, src/mito2/src/test_util.rs Added base_dir to IntermediateManager and methods for generating fulltext index paths. Adjusted test utilities for new full-text configurations.
tests-integration/tests/http.rs Added configuration section [region_engine.mito.fulltext_index] with settings for full-text indexing in integration tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Configuration
    participant MitoEngine
    participant Indexer
    participant Storage

    User->>Configuration: Configure full-text index settings
    Configuration->>MitoEngine: Pass settings
    MitoEngine->>Indexer: Initialize with full-text index config
    Indexer->>Storage: Create/Update indexes during flush or compaction
    Storage-->>Indexer: Return index metadata
    Indexer-->>MitoEngine: Update active index
    MitoEngine-->>User: Provide search capabilities

Poem

In the engine, new indexes bloom, Full-text now pierces the query's gloom. On flush and compaction, they take their place, Enhancing search with elegant grace. Memory thresholds guide the way, For faster finds, without delay. Here's to data, swift and bright, 🐰 A joyful hop to indexing's new height! 📚✨


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 1 week ago

@coderabbitai pause

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

Codecov Report

Attention: Patch coverage is 61.34615% with 201 lines in your changes missing coverage. Please review.

Project coverage is 84.88%. Comparing base (f71b7b9) to head (5189593). Report is 8 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4302 +/- ## ========================================== - Coverage 85.29% 84.88% -0.41% ========================================== Files 1066 1060 -6 Lines 188636 187534 -1102 ========================================== - Hits 160889 159188 -1701 - Misses 27747 28346 +599 ```