Skip to content

Update table operations docs with identified gaps#226

Merged
prrao87 merged 1 commit intomainfrom
fix/workflow-1
May 4, 2026
Merged

Update table operations docs with identified gaps#226
prrao87 merged 1 commit intomainfrom
fix/workflow-1

Conversation

@prrao87
Copy link
Copy Markdown
Contributor

@prrao87 prrao87 commented May 4, 2026

Summary

Address three documentation gaps surfaced by the docs audit:

  • Conflict handling for create_table — added a new "Handle existing tables" subsection right after the first basic create example, explaining when to use exist_ok (idempotent open) vs mode="overwrite" (replace), with the schema-validation behaviour and data-loss caveats called out.
  • Tag-based version management — added a new "Tag-Based Versioning" section covering the full tags API (create, list, get_version, update, delete) plus checkout-by-tag. Notes that the Rust SDK uses a separate checkout_tag() method, while Python and TypeScript overload checkout() to accept either a numeric version or a tag string.
  • Tag retention during cleanup — updated the existing optimize() cleanup note to make explicit that tagged versions are exempt from cleanup_older_than pruning and must have their tags removed before they become eligible for deletion.

Code blocks are added into testable snippets and tested with the latest version of LanceDB.

Test plan

  • Python test suite passes
  • TypeScript test suite passes
  • Rust example builds and runs to completion
  • make snippets regenerates without diff after a clean run
  • Rendered docs preview shows three-language code tabs in both new sections
  • All cross-page anchor links resolve

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview May 4, 2026, 1:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@prrao87 prrao87 merged commit 1ea0a97 into main May 4, 2026
2 checks passed
@prrao87 prrao87 deleted the fix/workflow-1 branch May 4, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant