Skip to content

@lancedb/lancedb • Docs


@lancedb/lancedb / CatalogOptions

Interface: CatalogOptions

Options shared by a catalog and the database connections it returns.

Extends

  • Omit<NativeCatalogOptions, "oauthConfig">

Properties

apiKey?

optional apiKey: string;

Inherited from

Omit.apiKey


clientConfig?

optional clientConfig: ClientConfig;

Inherited from

Omit.clientConfig


headerProvider?

optional headerProvider: HeaderProvider | () => Record<string, string> | Promise<Record<string, string>>;

Called for each request to supply authentication headers.


oauthConfig?

optional oauthConfig: OAuthConfig;

readConsistencyInterval?

optional readConsistencyInterval: number;

Inherited from

Omit.readConsistencyInterval


sqlHostOverride?

optional sqlHostOverride: string;

SQL service endpoint inherited by database connections.

Inherited from

Omit.sqlHostOverride