Update from code changes: document paginated listTables in TS SDK - #337
Open
mintlify[bot] wants to merge 3 commits into
Open
Update from code changes: document paginated listTables in TS SDK#337mintlify[bot] wants to merge 3 commits into
mintlify[bot] wants to merge 3 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. Added arbitrary-ordering warning for listTables and noted tableNames retains lexical order Source PRs
|
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
The TypeScript SDK added a paginated
listTablesmethod that returns a page of table names alongside an opaquepageTokenfor resuming, and deprecatedtableNames. Under the hood,list_tablesnow pages the object store directly, so its results come back in an arbitrary, backend-defined order whiletable_nameskeeps lexicographical ordering andstart-aftersemantics. This PR documents the new API on the "Open an existing table" section oftables/create.mdx, including a walk-the-pages example, namespace-scoped usage, and a callout about the ordering change.Upstream PRs:
Changes
tables/create.mdxexplaininglistTables, itspageToken/limitoptions, and noting thattableNamesis deprecated.pageTokenis empty and for listing a specific namespace path.listTables/list_tablesreturn tables in arbitrary order and that callers who need lexical ordering withstartAftershould stick with the deprecatedtableNames/table_names.Update history
listTablesfor the TypeScript SDK, including the opaquepageTokenwalk pattern and namespace-scoped listing. Sourced from feat(nodejs): add listTables, deprecate tableNames lancedb#4041.listTables/list_tablesnow return tables in arbitrary order and thattableNames/table_namesretain lexical order andstart-aftersemantics. Sourced from fix(listing)!: page table listings from the store's own cursor lancedb#3979.