Update table operations docs with identified gaps#226
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
Address three documentation gaps surfaced by the docs audit:
create_table— added a new "Handle existing tables" subsection right after the first basic create example, explaining when to useexist_ok (idempotent open)vsmode="overwrite"(replace), with the schema-validation behaviour and data-loss caveats called out.checkout_tag()method, while Python and TypeScript overloadcheckout()to accept either a numeric version or a tag string.optimize()cleanup note to make explicit that tagged versions are exempt fromcleanup_older_thanpruning 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
make snippetsregenerates without diff after a clean run