Class DuckDbConnector

constructor

• new DuckDbConnector(config: DuckDbConnectorConfig): DuckDbConnector

  Parameters

  • config: DuckDbConnectorConfig

  Returns DuckDbConnector

Readonlycapabilities

Optional Readonlydatabase

Readonlydialect

Readonlyengine

Readonlyid

Readonlyname

close

• close(): Promise<void>

  Returns Promise<void>

connect

• connect(): Promise<void>

  Returns Promise<void>

execute

• execute(sql: string, opts?: ExecuteOptions): Promise<ResultSet>

  Parameters

  • sql: string
  • Optionalopts: ExecuteOptions

  Returns Promise<ResultSet>

explain

• explain(sql: string, opts?: ExecuteOptions): Promise<ResultSet>

  Parameters

  • sql: string
  • Optionalopts: ExecuteOptions

  Returns Promise<ResultSet>

introspect

• introspect(): Promise<SchemaCatalog>

  Returns Promise<SchemaCatalog>

registeredTables

• registeredTables(): readonly string[]

  Names currently registered from files.

  Returns readonly string[]

registerFile

• registerFile(file: FileSource): Promise<string>

  Register a file as a view. Duplicate names are versioned; large files stream. Returns the actual table name used.

  Parameters

  • file: FileSource

  Returns Promise<string>

unregisterFile

• unregisterFile(table: string): Promise<void>

  Remove a previously registered file source (view for data files, table for a .sql dump).

  Parameters

  • table: string

  Returns Promise<void>