@lancedb/lancedb • Docs

---

@lancedb/lancedb / Catalog

Class: Catalog

A remote catalog manages databases through the server's root namespace.

Accessors

uri

get uri(): string

The root namespace endpoint.

Returns

string

Methods

connectDatabase()

connectDatabase(name): Promise<Connection>

Connect to an existing database by its logical name.

Parameters

• name: string

Returns

Promise<Connection>

---

createDatabase()

createDatabase(name, options): Promise<Connection>

Create a database, or open an existing database when existOk is true.

Parameters

• name: string

• options = {}

• options.existOk?: boolean

Returns

Promise<Connection>

---

dropDatabase()

dropDatabase(name, options): Promise<void>

Drop an empty database. The server rejects nonempty databases.

Parameters

• name: string

• options = {}

• options.ignoreMissing?: boolean

Returns

Promise<void>

---

listDatabases()

listDatabases(options): Promise<ListDatabasesResponse>

List one page of databases; pass pageToken from a response for the next page.

Parameters

• options = {}

• options.limit?: number

• options.pageToken?: string

Returns

Promise<ListDatabasesResponse>