Skip to content

@sqlrooms/db / DbConnector

Type Alias: DbConnector

DbConnector = Pick<DuckDbConnector, "initialize" | "destroy" | "execute" | "query" | "queryJson"> & object

Connector interface for direct, in-runtime query execution.

It extends the common query API and optionally exposes catalog introspection.

Type Declaration

NameType
capabilities?DbConnectorCapabilities
listDatabases()?() => Promise<CatalogDatabase[]>
listSchemas()?(database?) => Promise<CatalogSchema[]>
listTables()?(args?) => Promise<CatalogTable[]>
describeTable()?(args) => Promise<CatalogTableDetails | undefined>