Class DuckDBConnection

A thin helper to bind the connection id and talk record batches

Index

Constructors

Methods

cancelSent close createScalarFunction getTableNames insertArrowFromIPCStream insertArrowTable insertCSVFromPath insertJSONFromPath prepare query send useUnsafe

Constructors

constructor

new DuckDBConnection(bindings: DuckDBBindings, conn: number): DuckDBConnection
Constructor
Parameters
- bindings: DuckDBBindings
- conn: number
Returns DuckDBConnection
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:13

Methods

cancelSent

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

Returns boolean
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:67

close

close(): void
Close a connection

Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:19

createScalarFunction

createScalarFunction(
    name: string,
    returns: DataType,
    func: (...args: any[]) => void,
): void
Create a scalar function
Parameters
- name: string
- returns: DataType
- func: (...args: any[]) => void
Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:83

getTableNames

getTableNames(query: string): string[]
Get table names
Parameters
- query: string
Returns string[]
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:72

insertArrowFromIPCStream

insertArrowFromIPCStream(buffer: Uint8Array, options: ArrowInsertOptions): void
Insert an arrow table from an ipc stream
Parameters
- buffer: Uint8Array
- options: ArrowInsertOptions
Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:93

insertArrowTable

insertArrowTable(table: Table, options: ArrowInsertOptions): void
Insert an arrow table
Parameters
- table: Table
- options: ArrowInsertOptions
Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:88

insertCSVFromPath

insertCSVFromPath(path: string, options: CSVInsertOptions): void
Inesrt csv file from path
Parameters
- path: string
- options: CSVInsertOptions
Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:98

insertJSONFromPath

insertJSONFromPath(path: string, options: JSONInsertOptions): void
Insert json file from path
Parameters
- path: string
- options: JSONInsertOptions
Returns void
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:102

prepare

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

query

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

send

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

useUnsafe

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