Open
docs: add specification page for standard table config keys#8673
Conversation
Co-authored-by: wjones127 <5488879+wjones127@users.noreply.github.com>
Contributor
|
Important This PR touches the Lance format specification. Substantive changes to the format specification — the If this is a meaningful format change:
|
Contributor
|
ACTION NEEDED The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification. For details on the error please inspect the "PR Title Check" action. |
Copilot
AI
changed the title
[WIP] Add documentation page for standard table configurations
docs: add specification page for standard table config keys
Aug 20, 2026
wjones127
marked this pull request as ready for review
August 20, 2026 21:11
wjones127
approved these changes
Aug 20, 2026
wjones127
approved these changes
Aug 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Manifest.configreserves thelance.prefix for the format itself, but there was no single reference listing which keys exist, what they mean, or what values they accept — implementers had to grep the Rust source to find them.Changes
docs/src/format/table/table_config.mddocuments every knownlance.-prefixed config key found in the codebase, with type/format and description, grouped by feature:lance.auto_cleanup.*(interval,older_than,retain_versions,referenced_branch,delete_rate_limit)lance.compaction.*(all 15 keys accepted byCompactionOptions::apply_dataset_config)docs/src/format/table/.pages.docs/src/format/table/index.md, and from the auto-cleanup section indocs/src/guide/read_and_write.md.Example