docs: document table branches in versioning guide#267
Open
mintlify[bot] wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Consolidated this PR with the reviewed snippet/test work by @brendanclement from #263: branches now stay in the versioning guide, use generated snippets, and avoid adding a separate branches page/sidebar entry. This PR is updated and left open for review/merge. |
prrao87
added
the
needs_new_release
brendanclement
approved these changes
Jun 9, 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
2 participants
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.
Summary
Documents the new table branch APIs (Python, TypeScript, Rust) added in lancedb/lancedb#3490.
Changes
tables/versioning.mdxcovering when to use branches, how to create and write to a branch (including forking from a specific version), how to reopen a branch from a table handle or directly viaopen_table, and how to list/delete branches.checkout(version)so users pick the right primitive.Context
The upstream change adds
branches.create/checkout/list/deleteon the table handle plus abranchoption onopen_table, all backed by Lance's branchable dataset history. Branches are writable forks ofmain, so they belong with the existing versioning + tags guidance rather than as a standalone page.