Skip to content

docs: add specification page for standard table config keys - #8673

Open
wjones127 with Copilot wants to merge 2 commits into
mainfrom
copilot/create-spec-page-table-configurations
Open

docs: add specification page for standard table config keys#8673
wjones127 with Copilot wants to merge 2 commits into
mainfrom
copilot/create-spec-page-table-configurations

Conversation

Copilot AI commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Manifest.config reserves the lance. 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

  • New spec page: docs/src/format/table/table_config.md documents every known lance.-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 by CompactionOptions::apply_dataset_config)
  • Navigation: registered the page in docs/src/format/table/.pages.
  • Cross-links: linked from the Manifest section and "Related Specifications" in docs/src/format/table/index.md, and from the auto-cleanup section in docs/src/guide/read_and_write.md.

Example

| Key                                       | Type                  | Description                                          |
|--------------------------------------------|-----------------------|-------------------------------------------------------|
| `lance.auto_cleanup.interval`               | Non-negative integer  | Commits between automatic cleanup runs. `0`/unset disables it. |
| `lance.compaction.target_rows_per_fragment` | Non-negative integer  | Row-count threshold below which a fragment is a compaction candidate. |

Co-authored-by: wjones127 <5488879+wjones127@users.noreply.github.com>
@github-actions github-actions Bot added the A-format On-disk format: protos and format spec docs label Aug 20, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Important

This PR touches the Lance format specification.

Substantive changes to the format specification — the .proto definitions
and the spec docs under docs/src/format/ — require a PMC vote before merge.
Minor edits such as typo fixes, wording, or formatting are excluded; use your
judgment.

If this is a meaningful format change:

  • Start a vote following the Lance community voting process.
    Format specification modifications need 3 binding +1 votes (excluding the
    proposer), held on GitHub Discussions, with a minimum voting period of 1 week.
  • Once the vote passes, link the completed vote in this PR. It should not be
    merged until the vote is linked.

@github-actions

Copy link
Copy Markdown
Contributor

ACTION NEEDED
Lance follows the Conventional Commits specification for release automation.

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
Copilot AI requested a review from wjones127 August 20, 2026 20:56
@wjones127
wjones127 marked this pull request as ready for review August 20, 2026 21:11
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 20, 2026
@wjones127 wjones127 removed the A-format On-disk format: protos and format spec docs label Aug 20, 2026
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.

docs: create a spec page listing all standard table configurations

2 participants