Class AsyncDuckDBConnection

A thin helper to memoize the connection id

Index

Constructors

Accessors

Methods

cancelSent close getTableNames insertArrowFromIPCStream insertArrowTable insertCSVFromPath insertJSONFromPath prepare query send useUnsafe

Constructors

constructor

new AsyncDuckDBConnection(
bindings: AsyncDuckDB,
conn: number,
): AsyncDuckDBConnection
Parameters
- bindings: AsyncDuckDB
- conn: number
Returns AsyncDuckDBConnection
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:13

Accessors

bindings

get bindings(): AsyncDuckDB
Access the database bindings

Returns AsyncDuckDB
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:19

Methods

cancelSent

cancelSent(): Promise<boolean>
Cancel a query that was sent earlier

Returns Promise<boolean>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:80

close

close(): Promise<void>
Disconnect from the database

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

getTableNames

getTableNames(query: string): Promise<string[]>
Get table names
Parameters
- query: string
Returns Promise<string[]>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:85

insertArrowFromIPCStream

insertArrowFromIPCStream(
buffer: Uint8Array,
options: ArrowInsertOptions,
): Promise<void>
Insert an arrow table from an ipc stream
Parameters
- buffer: Uint8Array
- options: ArrowInsertOptions
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:103

insertArrowTable

insertArrowTable(table: Table, options: ArrowInsertOptions): Promise<void>
Insert an arrow table
Parameters
- table: Table
- options: ArrowInsertOptions
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:98

insertCSVFromPath

insertCSVFromPath(text: string, options: CSVInsertOptions): Promise<void>
Insert csv file from path
Parameters
- text: string
- options: CSVInsertOptions
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:107

insertJSONFromPath

insertJSONFromPath(text: string, options: JSONInsertOptions): Promise<void>
Insert json file from path
Parameters
- text: string
- options: JSONInsertOptions
Returns Promise<void>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:111

prepare

prepare<T extends { [key: string]: DataType<Type, any> } = any>(
text: string,
): Promise<AsyncPreparedStatement<T>>
Create a prepared statement
Type Parameters
- T extends { [key: string]: DataType<Type, any> } = any
Parameters
- text: string
Returns Promise<AsyncPreparedStatement<T>>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:90

query

query<T extends { [key: string]: DataType<Type, any> } = any>(
text: string,
): Promise<Table<T>>
Run a query
Type Parameters
- T extends { [key: string]: DataType<Type, any> } = any
Parameters
- text: string
Returns Promise<Table<T>>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:34

send

send<T extends { [key: string]: DataType<Type, any> } = any>(
text: string,
allowStreamResult?: boolean,
): Promise<AsyncRecordBatchStreamReader<T>>
Send a query
Type Parameters
- T extends { [key: string]: DataType<Type, any> } = any
Parameters
- text: string
- allowStreamResult: boolean = false
Returns Promise<AsyncRecordBatchStreamReader<T>>
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:51

useUnsafe

useUnsafe<R>(callback: (bindings: AsyncDuckDB, conn: number) => R): R
Brave souls may use this function to consume the underlying connection id
Type Parameters
- R
Parameters
- callback: (bindings: AsyncDuckDB, conn: number) => R
Returns R
- Defined in packages/duckdb-wasm/src/parallel/async_connection.ts:29