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(fulltext_index): introduce creator #4249

Closed zhongzc closed 2 days ago

zhongzc commented 2 days 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?

as @coderabbitai

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 days 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

This change set introduces a new fulltext indexing feature leveraging the Tantivy search engine. It includes configuration, creation, and error handling functionalities. Dependencies such as serde, tokio, and tantivy are added to support these features. Additionally, some minor corrections in variable names and consistency adjustments are made in the puffin_manager module.

Changes

Files Change Summary
src/index/Cargo.toml Added dependencies: serde, tantivy with zstd-compression, tantivy-jieba, tokio, and common-test-util.
src/index/src/fulltext_index.rs Introduced Config struct and Analyzer enum to configure fulltext index settings.
src/index/src/fulltext_index/create.rs Added the FulltextIndexCreator trait and methods for text indexing. Exported TantivyFulltextIndexCreator implementation.
src/index/src/fulltext_index/create/tantivy.rs Implemented TantivyFulltextIndexCreator for fulltext indexing with Tantivy, including analyzer configuration and memory management.
src/index/src/fulltext_index/error.rs Introduced structured error handling with the Error enum and Result type alias.
src/index/src/lib.rs Added fulltext_index module.
src/puffin/src/puffin_manager/stager/bounded_stager.rs Corrected the capacity parameter spelling in the new function.
src/puffin/src/puffin_manager/tests.rs Corrected the spelling of capacity variable in function signatures and its usage.

Poem

In the code, where search is found,
New indices now do abound.
With Tantivy's power at our will,
English and Chinese texts we fill.
Serde, Tokio join the stage,
Errors handled, tests engage.
🐇✨ Fulltext searches, fast and sage!


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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 2 days ago

@coderabbitai pause

coderabbitai[bot] commented 2 days ago
Actions performed Reviews paused.
codecov[bot] commented 2 days ago

Codecov Report

Attention: Patch coverage is 95.53073% with 8 lines in your changes missing coverage. Please review.

Project coverage is 84.71%. Comparing base (db5d116) to head (8d965d5). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4249 +/- ## ========================================== - Coverage 85.00% 84.71% -0.29% ========================================== Files 1051 1054 +3 Lines 186627 186950 +323 ========================================== - Hits 158636 158371 -265 - Misses 27991 28579 +588 ```