@lancedb/lancedb • Docs

---

@lancedb/lancedb / connectCatalog

Function: connectCatalog()

function connectCatalog(endpoint, options): Promise<Catalog>

Connect to an HTTP(S) catalog endpoint. Catalog requests omit database-selection headers; opened database connections inherit authentication and client options.

Parameters

• endpoint: string

• options: CatalogOptions = {}

Returns

Promise<Catalog>

Example

const catalog = await connectCatalog("https://my-server.example", { apiKey: "secret" });
const db = await catalog.createDatabase("analytics", { existOk: true });
for await (const name of catalog.listDatabases({ pageLimit: 20 })) {
  console.log(name);
}