docs: dedicated Branches guide with merge_insert promotion and SDK bumps#297
Merged
Conversation
…DK bumps Split branching out of the versioning guide into a standalone, snippet-driven Branches page. It covers the full lifecycle (create, write, reopen, delete), promoting branch data back to main with merge_insert (there is no automatic merge yet), and building vector/FTS indexes on a branch in isolation. Adds OSS and Enterprise connection sections reused from the quickstart snippets. Bump test SDK pins to versions with branch support and regenerate snippets: Python lancedb 0.34.0, TypeScript and Rust 0.31.0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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.
What
Splits table branching out of the versioning guide into a standalone, snippet-driven Branches page (
docs/tables/branching.mdx), added to the Table operations nav right after Versioning.The page is a ground-up rewrite through the lens of a new user:
<Badge color="red">Enterprise</Badge>connection sections, reusing the quickstart connection snippets.create/write/reopen/delete, each its own subsection with staged snippets.main— states clearly that automatic merge isn't supported yet, and shows how to promote branch data back tomainviamerge_insert(keyed upsert), which slots into a normal ingestion job.Trims the old branching section in
versioning.mdxdown to a pointer.SDK version bumps
Bumps the test-suite SDK pins to versions that support branches, and regenerates snippets accordingly:
lancedb0.33.0→0.34.0@lancedb/lancedb0.30.0→0.31.0lancedb0.30.0→0.31.0Verification
All branch snippets live in real tests and were run against the bumped SDKs:
pytest test_tables.py::test_branchespassed (0.34.0)jestbranch test passed (0.31.0)cargo run --example tablespassed, no panics (0.31.0); caught and fixed thecheckout_branch(name, None)signature change at 0.31.0mint devrun to test local server andmint broken-linksclean🤖 Generated with Claude Code