mirror of https://github.com/lancedb/lancedb.git synced 2026-08-28 17:08:43 +00:00

Files

T

Will Jones fce45ba9fc feat(nodejs): add listTables, deprecate tableNames (#4041 )

`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>

2026-08-24 16:25:14 -07:00

675 B

Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / TableNamesOptions

Interface: TableNamesOptions

Deprecated

Use ListTablesOptions with Connection.listTables instead.

Properties

limit?

optional limit: number;

An optional limit to the number of results to return.

startAfter?

optional startAfter: string;

If present, only return names that come lexicographically after the supplied value.

This can be combined with limit to implement pagination by setting this to the last table name from the previous page.

675 B Raw Blame History