Class AsyncDuckDB

An interface for the async DuckDB bindings

Hierarchy

AsyncDuckDB

Implements

AsyncDuckDBBindings

Constructors

constructor

new AsyncDuckDB(logger: Logger, worker?: null | Worker): AsyncDuckDB
Parameters
- logger: Logger
- worker: null | Worker = null
Returns AsyncDuckDB
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:49

Accessors

logger

get logger(): Logger
Get the logger

Returns Logger
Implementation of AsyncDuckDBBindings.logger
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:58

Methods

cancelPendingQuery

cancelPendingQuery(conn: number): Promise<boolean>
Cancel a pending query
Parameters
- conn: number
Returns Promise<boolean>
Implementation of AsyncDuckDBBindings.cancelPendingQuery
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:418

closePrepared

closePrepared(conn: number, statement: number): Promise<void>
Close a prepared statement
Parameters
- conn: number
- statement: number
Returns Promise<void>
Implementation of AsyncDuckDBBindings.closePrepared
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:453

collectFileStatistics

collectFileStatistics(name: string, enable: boolean): Promise<void>
Enable file statistics
Parameters
- name: string
- enable: boolean
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:541

connect

connect(): Promise<AsyncDuckDBConnection>
Connect to the database

Returns Promise<AsyncDuckDBConnection>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:378

connectInternal

connectInternal(): Promise<number>
Connect to the database

Returns Promise<number>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:372

copyFileToBuffer

copyFileToBuffer(name: string): Promise<Uint8Array>
Copy a file to a buffer.
Parameters
- name: string
Returns Promise<Uint8Array>
Implementation of AsyncDuckDBBindings.copyFileToBuffer
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:559

copyFileToPath

copyFileToPath(name: string, path: string): Promise<void>
Copy a file to a path.
Parameters
- name: string
- path: string
Returns Promise<void>
Implementation of AsyncDuckDBBindings.copyFileToPath
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:568

createPrepared

createPrepared(conn: number, text: string): Promise<number>
Prepare a statement and return its identifier
Parameters
- conn: number
- text: string
Returns Promise<number>
Implementation of AsyncDuckDBBindings.createPrepared
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:445

detach

detach(): void
Detach from worker

Returns void
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:76

disconnect

disconnect(conn: number): Promise<void>
Disconnect from the database
Parameters
- conn: number
Returns Promise<void>
Implementation of AsyncDuckDBBindings.disconnect
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:384

dropFile

dropFile(name: string): Promise<null>
Try to drop a file
Parameters
- name: string
Returns Promise<null>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:312

dropFiles

dropFiles(): Promise<null>
Try to drop files

Returns Promise<null>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:317

exportFileStatistics

exportFileStatistics(name: string): Promise<FileStatistics>
Export file statistics
Parameters
- name: string
Returns Promise<FileStatistics>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:550

fetchQueryResults

fetchQueryResults(conn: number): Promise<Uint8Array>
Fetch query results
Parameters
- conn: number
Returns Promise<Uint8Array>
Implementation of AsyncDuckDBBindings.fetchQueryResults
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:427

flushFiles

flushFiles(): Promise<null>
Flush all files

Returns Promise<null>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:322

getFeatureFlags

getFeatureFlags(): Promise<number>
Get the feature flags

Returns Promise<number>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:349

getTableNames

getTableNames(conn: number, text: string): Promise<string[]>
Get table names
Parameters
- conn: number
- text: string
Returns Promise<string[]>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:436

getVersion

getVersion(): Promise<string>
Get the version

Returns Promise<string>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:342

globFiles

globFiles(path: string): Promise<WebFile[]>
Glob file infos
Parameters
- path: string
Returns Promise<WebFile[]>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:477

insertArrowFromIPCStream

insertArrowFromIPCStream(conn: number, buffer: Uint8Array, options?: ArrowInsertOptions): Promise<void>
Insert arrow from an ipc stream
Parameters
- conn: number
- buffer: Uint8Array
- Optional options: ArrowInsertOptions
Returns Promise<void>
Implementation of AsyncDuckDBBindings.insertArrowFromIPCStream
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:577

insertCSVFromPath

insertCSVFromPath(conn: number, path: string, options: CSVInsertOptions): Promise<void>
Insert a csv file
Parameters
- conn: number
- path: string
- options: CSVInsertOptions
Returns Promise<void>
Implementation of AsyncDuckDBBindings.insertCSVFromPath
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:592

insertJSONFromPath

insertJSONFromPath(conn: number, path: string, options: JSONInsertOptions): Promise<void>
Insert a json file
Parameters
- conn: number
- path: string
- options: JSONInsertOptions
Returns Promise<void>
Implementation of AsyncDuckDBBindings.insertJSONFromPath
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:612

instantiate

instantiate(mainModuleURL: string, pthreadWorkerURL?: null | string, progress?: ((progress: InstantiationProgress) => void)): Promise<null>
Open the database
Parameters
- mainModuleURL: string
- pthreadWorkerURL: null | string = null
- progress: ((progress: InstantiationProgress) => void) = ...
  - - (progress: InstantiationProgress): void
    - Parameters
      
      progress: InstantiationProgress
      
      Returns void
Returns Promise<null>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:328

open

open(config: DuckDBConfig): Promise<void>
Open a new database
Parameters
- config: DuckDBConfig
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:359

ping

ping(): Promise<any>
Ping the worker thread

Returns Promise<any>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:307

pollPendingQuery

pollPendingQuery(conn: number): Promise<null | Uint8Array>
Poll a pending query
Parameters
- conn: number
Returns Promise<null | Uint8Array>
Implementation of AsyncDuckDBBindings.pollPendingQuery
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:410

registerEmptyFileBuffer

registerEmptyFileBuffer(name: string): Promise<void>
Register an empty file buffer.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:508

registerFileBuffer

registerFileBuffer(name: string, buffer: Uint8Array): Promise<void>
Register a file buffer.
Parameters
- name: string
- buffer: Uint8Array
Returns Promise<void>
Implementation of AsyncDuckDBBindings.registerFileBuffer
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:517

registerFileHandle

registerFileHandle<HandleType>(name: string, handle: HandleType, protocol: DuckDBDataProtocol, directIO: boolean): Promise<void>
Register a file handle.
Type Parameters
- HandleType
Parameters
- name: string
- handle: HandleType
- protocol: DuckDBDataProtocol
- directIO: boolean
Returns Promise<void>
Implementation of AsyncDuckDBBindings.registerFileHandle
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:526

registerFileText

registerFileText(name: string, text: string): Promise<void>
Register file text
Parameters
- name: string
- text: string
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:485

registerFileURL

registerFileURL(name: string, url: string, proto: DuckDBDataProtocol, directIO: boolean): Promise<void>
Register a file path.
Parameters
- name: string
- url: string
- proto: DuckDBDataProtocol
- directIO: boolean
Returns Promise<void>
Implementation of AsyncDuckDBBindings.registerFileURL
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:490

reset

reset(): Promise<null>
Reset the duckdb

Returns Promise<null>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:301

runPrepared

runPrepared(conn: number, statement: number, params: any[]): Promise<Uint8Array>
Execute a prepared statement and return the full result
Parameters
- conn: number
- statement: number
- params: any[]
Returns Promise<Uint8Array>
Implementation of AsyncDuckDBBindings.runPrepared
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:461

runQuery

runQuery(conn: number, text: string): Promise<Uint8Array>
Run a query
Parameters
- conn: number
- text: string
Returns Promise<Uint8Array>
Implementation of AsyncDuckDBBindings.runQuery
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:393

sendPrepared

sendPrepared(conn: number, statement: number, params: any[]): Promise<Uint8Array>
Execute a prepared statement and stream the result
Parameters
- conn: number
- statement: number
- params: any[]
Returns Promise<Uint8Array>
Implementation of AsyncDuckDBBindings.sendPrepared
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:469

startPendingQuery

startPendingQuery(conn: number, text: string): Promise<null | Uint8Array>
Start a pending query
Parameters
- conn: number
- text: string
Returns Promise<null | Uint8Array>
Implementation of AsyncDuckDBBindings.startPendingQuery
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:402

terminate

terminate(): Promise<void>
Kill the worker

Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:88

tokenize

tokenize(text: string): Promise<ScriptTokens>
Tokenize a script text
Parameters
- text: string
Returns Promise<ScriptTokens>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:365

Class AsyncDuckDB

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

logger: Logger

worker: null | Worker = null

Returns AsyncDuckDB

Accessors

logger

Returns Logger

Methods

cancelPendingQuery

Parameters

conn: number

Returns Promise<boolean>

closePrepared

Parameters

conn: number

statement: number

Returns Promise<void>

collectFileStatistics

Parameters

name: string

enable: boolean

Returns Promise<void>

connect

Returns Promise<AsyncDuckDBConnection>

connectInternal

Returns Promise<number>

copyFileToBuffer

Parameters

name: string

Returns Promise<Uint8Array>

copyFileToPath

Parameters

name: string

path: string

Returns Promise<void>

createPrepared

Parameters

conn: number

text: string

Returns Promise<number>

detach

Returns void

disconnect

Parameters

conn: number

Returns Promise<void>

dropFile

Parameters

name: string

Returns Promise<null>

dropFiles

Returns Promise<null>

exportFileStatistics

Parameters

name: string

Returns Promise<FileStatistics>

fetchQueryResults

Parameters

conn: number

Returns Promise<Uint8Array>

flushFiles

Returns Promise<null>

getFeatureFlags

Returns Promise<number>

getTableNames

Parameters

conn: number

text: string

Returns Promise<string[]>

getVersion

Returns Promise<string>

`Optional` options: ArrowInsertOptions