Class DuckDBConnection

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

Hierarchy

DuckDBConnection

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:59

close

close(): void
Close a connection

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

createScalarFunction

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

getTableNames

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

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:85

insertArrowTable

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

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:90

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:94

prepare

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

query

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

send

send<T>(text: string): Promise<RecordBatchStreamReader<T>>
Send a query
Type Parameters
- T extends {
  [key: string]: arrow.DataType;
  } = any
Parameters
- text: string
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)
  - - (bindings: DuckDBBindings, conn: number): R
    - Parameters
      
      bindings: DuckDBBindings
      
      conn: number
      
      Returns R
Returns R
- Defined in packages/duckdb-wasm/src/bindings/connection.ts:24

Class DuckDBConnection

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

bindings: DuckDBBindings

conn: number

Returns DuckDBConnection

Methods

cancelSent

Returns boolean

close

Returns void

createScalarFunction

Parameters

name: string

returns: DataType<Type, any>

func: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

getTableNames

Parameters

query: string

Returns string[]

insertArrowFromIPCStream

Parameters

buffer: Uint8Array

options: ArrowInsertOptions

Returns void

insertArrowTable

Parameters

table: Table<any>

options: ArrowInsertOptions

Returns void

insertCSVFromPath

Parameters

path: string

options: CSVInsertOptions

Returns void

insertJSONFromPath

Parameters

path: string

options: JSONInsertOptions

Returns void

prepare

Type Parameters

T extends { [key: string]: arrow.DataType; } = any

Parameters

text: string

Returns PreparedStatement<any>

query

Type Parameters

T extends { [key: string]: arrow.DataType; } = any

Parameters

text: string

Returns Table<T>

send

Type Parameters

T extends { [key: string]: arrow.DataType; } = any

Parameters

text: string

Returns Promise<RecordBatchStreamReader<T>>

useUnsafe

Type Parameters

R

Parameters

callback: ((bindings: DuckDBBindings, conn: number) => R)

Parameters

bindings: DuckDBBindings

conn: number

Returns R

Returns R

Settings

Member Visibility

Theme

`Rest` ...args: any[]

T extends {
[key: string]: arrow.DataType;
} = any

T extends {
[key: string]: arrow.DataType;
} = any

T extends {
[key: string]: arrow.DataType;
} = any