Class AsyncDuckDB

An interface for the async DuckDB bindings

Implements

AsyncDuckDBBindings

Constructors

constructor

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

Accessors

config

get config(): DuckDBConfig
Get the logger

Returns DuckDBConfig
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:70

logger

get logger(): Logger
Get the logger

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

Methods

`Private` _runQueryAsync

_runQueryAsync(conn, text): Promise<Uint8Array>
Parameters
- conn: number
- text: string
Returns Promise<Uint8Array>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:435

`Private` _startPendingQueryAsync

_startPendingQueryAsync(conn, text, allowStreamResult?): Promise<null | Uint8Array>
Parameters
- conn: number
- text: string
- allowStreamResult: boolean = false
Returns Promise<null | Uint8Array>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:463

cancelPendingQuery

cancelPendingQuery(conn): 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:485

closePrepared

closePrepared(conn, statement): 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:520

collectFileStatistics

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

connect

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

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

connectInternal

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

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

copyFileToBuffer

copyFileToBuffer(name): 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:637

copyFileToPath

copyFileToPath(name, path): 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:646

createPrepared

createPrepared(conn, text): 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:512

detach

detach(): void
Detach from worker

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

disconnect

disconnect(conn): 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:411

dropFile

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

dropFiles

dropFiles(names?): Promise<null>
Try to drop files
Parameters
- Optional names: string[]
Returns Promise<null>
Implementation of AsyncDuckDBBindings.dropFiles
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:343

exportFileStatistics

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

fetchQueryResults

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

flushFiles

flushFiles(): Promise<null>
Flush all files

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

getFeatureFlags

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

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

getTableNames

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

getVersion

getVersion(): Promise<string>
Get the version

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

globFiles

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

insertArrowFromIPCStream

insertArrowFromIPCStream(conn, buffer, options?): 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:655

insertCSVFromPath

insertCSVFromPath(conn, path, options): 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:670

insertJSONFromPath

insertJSONFromPath(conn, path, options): 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:690

instantiate

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

isDetached

isDetached(): boolean
Is in detached state, no worker defined

Returns boolean
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:322

open

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

ping

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

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

pollPendingQuery

pollPendingQuery(conn): 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:477

registerEmptyFileBuffer

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

registerFileBuffer

registerFileBuffer(name, buffer): 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:586

registerFileHandle

registerFileHandle<HandleType>(name, handle, protocol, directIO): 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:595

registerFileText

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

registerFileURL

registerFileURL(name, url, proto, directIO): 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:557

`Private` registerOPFSFileFromSQL

registerOPFSFileFromSQL(text): Promise<string[]>
Parameters
- text: string
Returns Promise<string[]>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:717

registerOPFSFileName

registerOPFSFileName(name): Promise<void>
Enable file statistics
Parameters
- name: string
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:610

reset

reset(): Promise<null>
Reset the duckdb

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

runPrepared

runPrepared(conn, statement, params): 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:528

runQuery

runQuery(conn, text): 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:420

sendPrepared

sendPrepared(conn, statement, params): 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:536

`Private` shouldOPFSFileHandling

shouldOPFSFileHandling(): boolean
Returns boolean
- Defined in packages/duckdb-wasm/src/parallel/async_bindings.ts:710

startPendingQuery

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

terminate

terminate(): Promise<void>
Kill the worker

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

tokenize

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