mirror of
https://github.com/lancedb/lancedb.git
synced 2026-09-04 12:38:38 +00:00
fce45ba9fc
`table_names` is being replaced by `list_tables` across the SDKs, but TypeScript only had `tableNames`. This PR adds `listTables`, which returns a page of table names together with the token that resumes after it, and marks `tableNames` and `TableNamesOptions` deprecated in favor of it. It binds the `Connection::list_tables` that already exists, so nothing in the Rust API changes and nothing existing breaks. `pageToken` is documented as opaque rather than as a table name, since what resumes a listing is the database's to decide — that keeps callers off a detail that is going to change. Stacked on #4040, which fixes a table being dropped at every page boundary. The page-walking test here needs that fix to pass. Review the last commit only until #4040 lands. ## Example ```ts const names = []; let pageToken = undefined; do { const page = await conn.listTables({ pageToken, limit: 100 }); names.push(...page.tables); pageToken = page.pageToken; } while (pageToken); ``` A namespace can be listed by passing its path first, mirroring `tableNames`: ```ts const page = await conn.listTables(["analytics"], { limit: 100 }); ``` Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
7.1 KiB
7.1 KiB
@lancedb/lancedb • Docs
@lancedb/lancedb
Namespaces
Enumerations
Classes
- BooleanQuery
- BoostQuery
- BranchContents
- Branches
- Connection
- HeaderProvider
- Index
- Job
- MakeArrowTableOptions
- MatchQuery
- MaterializedView
- MergeInsertBuilder
- MultiMatchQuery
- NativeJsHeaderProvider
- OAuthHeaderProvider
- PermutationBuilder
- PhraseQuery
- Query
- QueryBase
- Scannable
- Session
- StaticHeaderProvider
- Table
- TagContents
- Tags
- TakeQuery
- VectorColumnOptions
- VectorQuery
Interfaces
- AddColumnsResult
- AddColumnsSql
- AddDataOptions
- AddResult
- AlterColumnsResult
- BranchColumnChange
- BranchColumnSummary
- BranchDiff
- BranchIndexSummary
- BranchRowCountSummary
- BucketStats
- CherryPickError
- CherryPickPreview
- CherryPickResult
- ClientConfig
- ColumnAlteration
- ColumnOrdering
- CompactionStats
- ConnectNamespaceOptions
- ConnectionOptions
- CreateNamespaceOptions
- CreateNamespaceResponse
- CreateTableOptions
- DeleteResult
- DescribeNamespaceResponse
- DirNamespaceConfig
- DropColumnsResult
- DropNamespaceOptions
- DropNamespaceResponse
- ExecutableQuery
- FieldMetadataUpdate
- FragmentStatistics
- FragmentSummaryStats
- FtsOptions
- FtsToken
- FullTextQuery
- FullTextSearchOptions
- GenerationStats
- HnswPqOptions
- HnswSqOptions
- IndexConfig
- IndexOptions
- IndexStatistics
- IvfFlatOptions
- IvfPqOptions
- IvfRqOptions
- JobDescription
- JobFailureInfo
- JobInfo
- ListNamespacesOptions
- ListNamespacesResponse
- ListTablesOptions
- ListTablesResponse
- LsmStats
- LsmWriteSpec
- MaterializedViewDefinition
- MemtableStats
- MergeResult
- NativeOAuthConfig
- OAuthConfig
- OpenTableOptions
- OptimizeOptions
- OptimizeStats
- QueryExecutionOptions
- RefreshColumnResult
- RefreshMaterializedViewResult
- RemovalStats
- RenameTableOptions
- RestNamespaceConfig
- RetryConfig
- ScannableOptions
- ShuffleOptions
- SplitCalculatedOptions
- SplitHashOptions
- SplitRandomOptions
- SplitSequentialOptions
- TableNamesOptions
- TableStatistics
- TimeoutConfig
- TlsConfig
- TokenResponse
- TokenizeOptions
- UpdateFieldMetadataResult
- UpdateOptions
- UpdateResult
- Version
- WriteExecutionOptions
- WriteProgress
Type Aliases
- AnalyzePlanDistributedMetrics
- BaseTokenizer
- Data
- DataLike
- FieldLike
- IntoSql
- IntoVector
- MaterializedViewSelect
- MultiVector
- RecordBatchLike
- SchemaLike
- TableLike
- TokenizeTableOptions