lancedb icon indicating copy to clipboard operation
lancedb copied to clipboard
verified publisher icon lancedb

docs: update indexing and compaction docs

Open rpgreen opened this issue 11 months ago • 1 comments

Summary by CodeRabbit

  • Documentation
    • Clarified and expanded explanations of data management concepts in LanceDB.
    • Added notes on automatic background fragment compaction and incremental reindexing support in LanceDB Cloud/Enterprise.
    • Updated details on disabling interim exhaustive kNN search during background reindexing.
    • Improved formatting and removed outdated FTS reindexing subsection.

rpgreen avatar Apr 28 '25 13:04 rpgreen

Walkthrough

The documentation for data management in LanceDB was updated to clarify and expand explanations regarding version metadata overhead, compaction, and reindexing. Notable changes include specifying that both LanceDB Cloud and Enterprise support automatic background fragment compaction and automatic incremental reindexing for various index types. The role of the fast_search parameter during background reindexing was also added. Formatting improvements and the removal of a subsection on FTS reindexing details were made.

Changes

File(s) Change Summary
docs/src/concepts/data_management.md Clarified and expanded documentation on version metadata, compaction, and reindexing; improved formatting; updated Cloud/Enterprise feature descriptions; added details on fast_search parameter; removed FTS reindexing subsection.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LanceDB OSS
    participant LanceDB Cloud/Enterprise

    User->>LanceDB Cloud/Enterprise: Add or modify data
    activate LanceDB Cloud/Enterprise
    LanceDB Cloud/Enterprise-->>LanceDB Cloud/Enterprise: Automatically trigger incremental reindexing (vector, scalar, FTS)
    deactivate LanceDB Cloud/Enterprise

    User->>LanceDB OSS: Add or modify data
    Note right of LanceDB OSS: Requires manual reindexing

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

CodeRabbit Configuration 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 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 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.

coderabbitai[bot] avatar Apr 28 '25 13:04 coderabbitai[bot]