Skip to content

Conversation

@wjones127
Copy link
Contributor

This document doesn't change the spec but instead writes down what the existing code does. So I'm not sure it needs a vote. However, I would like to get lots of eyes on it and have multiple approvals if possible.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 18, 2025
Copy link
Collaborator

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this

@github-actions
Copy link
Contributor

Documentation Review

This is a well-written specification document that clearly explains the existing index handling behavior. The diagrams add valuable visual context.

No critical issues found. The documentation is clear, accurate, and well-organized.

Minor observations (non-blocking):

  1. Typo on line ~129: "singificant" should be "significant" in the compaction section.

  2. Line ~95: The phrase "The allows reuse" appears to be missing a word - should likely be "This allows reuse".

Overall, this is an excellent addition to the format specification.

@github-actions
Copy link
Contributor

PR Review: docs: add specification for handling indices

This is a well-written documentation PR that formalizes the existing index behavior. The explanations are clear and the diagrams add significant value.

Minor Issues

P1: Typos in the documentation

There are a couple of typos that should be fixed before merging:

  1. In "Index Storage" section: "The allows reuse" should be "This allows reuse"
  2. In "Compaction and remapping" section: "singificant write ampliciation" should be "significant write amplification"

Observations

The documentation covers the key concepts well:

  • Index segment model with fragment bitmaps
  • Handling of deleted/invalidated rows
  • Three compaction strategies with clear trade-offs
  • Stable row ID feature marked as experimental

The design principles (on-demand loading, progressive loading, immutability) are clearly articulated and match the existing implementation behavior.


Reviewed with Claude Code

@wjones127 wjones127 merged commit 38125f1 into lance-format:main Dec 30, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants