Class DuckDBBindingsBase`Abstract`

The proxy for either the browser- order node-based DuckDB API

Hierarchy

DuckDBBindingsBase

Implements

DuckDBBindings

Constructors

constructor

new DuckDBBindingsBase(logger: Logger, runtime: DuckDBRuntime): DuckDBBindingsBase
Parameters
- logger: Logger
- runtime: DuckDBRuntime
Returns DuckDBBindingsBase
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:48

Accessors

logger

get logger(): Logger
Get the logger

Returns Logger
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:55

mod

get mod(): DuckDBModule
Get the instance

Returns DuckDBModule
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:59

pthread

get pthread(): null | PThread
Get the instance

Returns null | PThread
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:63

Methods

cancelPendingQuery

cancelPendingQuery(conn: number): boolean
Cancel a pending query
Parameters
- conn: number
Returns boolean
Implementation of DuckDBBindings.cancelPendingQuery
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:205

closePrepared

closePrepared(conn: number, statement: number): void
Close a prepared statement
Parameters
- conn: number
- statement: number
Returns void
Implementation of DuckDBBindings.closePrepared
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:284

collectFileStatistics

collectFileStatistics(file: string, enable: boolean): void
Enable tracking of file statistics
Parameters
- file: string
- enable: boolean
Returns void
Implementation of DuckDBBindings.collectFileStatistics
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:522

connect

connect(): DuckDBConnection
Connect to database

Returns DuckDBConnection
Implementation of DuckDBBindings.connect
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:146

copyFileToBuffer

copyFileToBuffer(name: string): Uint8Array
Write a file to a buffer
Parameters
- name: string
Returns Uint8Array
Implementation of DuckDBBindings.copyFileToBuffer
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:509

copyFileToPath

copyFileToPath(name: string, path: string): void
Write a file to a path
Parameters
- name: string
- path: string
Returns void
Implementation of DuckDBBindings.copyFileToPath
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:501

createPrepared

createPrepared(conn: number, text: string): number
Prepare a statement and return its identifier
Parameters
- conn: number
- text: string
Returns number
Implementation of DuckDBBindings.createPrepared
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:274

createScalarFunction

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

disconnect

disconnect(conn: number): void
Disconnect from database
Parameters
- conn: number
Returns void
Implementation of DuckDBBindings.disconnect
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:151

dropFile

dropFile(name: string): void
Drop file
Parameters
- name: string
Returns void
Implementation of DuckDBBindings.dropFile
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:481

dropFiles

dropFiles(): void
Drop files

Returns void
Implementation of DuckDBBindings.dropFiles
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:489

exportFileStatistics

exportFileStatistics(file: string): FileStatistics
Export file statistics
Parameters
- file: string
Returns FileStatistics
Implementation of DuckDBBindings.exportFileStatistics
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:529

fetchQueryResults

fetchQueryResults(conn: number): Uint8Array
Fetch query results
Parameters
- conn: number
Returns Uint8Array
Implementation of DuckDBBindings.fetchQueryResults
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:209

flushFiles

flushFiles(): void
Flush all files

Returns void
Implementation of DuckDBBindings.flushFiles
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:497

getFeatureFlags

getFeatureFlags(): number
Get the feature flags

Returns number
Implementation of DuckDBBindings.getFeatureFlags
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:130

getTableNames

getTableNames(conn: number, text: string): string[]
Get table names
Parameters
- conn: number
- text: string
Returns string[]
Implementation of DuckDBBindings.getTableNames
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:219

getVersion

getVersion(): string
Get the version

Returns string
Implementation of DuckDBBindings.getVersion
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:120

globFiles

globFiles(path: string): WebFile[]
Glob file infos
Parameters
- path: string
Returns WebFile[]
Implementation of DuckDBBindings.globFiles
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:396

insertArrowFromIPCStream

insertArrowFromIPCStream(conn: number, buffer: Uint8Array, options?: ArrowInsertOptions): void
Insert record batches from an arrow ipc stream
Parameters
- conn: number
- buffer: Uint8Array
- Optional options: ArrowInsertOptions
Returns void
Implementation of DuckDBBindings.insertArrowFromIPCStream
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:325

insertCSVFromPath

insertCSVFromPath(conn: number, path: string, options: CSVInsertOptions): void
Insert csv from path
Parameters
- conn: number
- path: string
- options: CSVInsertOptions
Returns void
Implementation of DuckDBBindings.insertCSVFromPath
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:346

insertJSONFromPath

insertJSONFromPath(conn: number, path: string, options: JSONInsertOptions): void
Insert json from path
Parameters
- conn: number
- path: string
- options: JSONInsertOptions
Returns void
Implementation of DuckDBBindings.insertJSONFromPath
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:371

instantiate

instantiate(onProgress?: ((progress: InstantiationProgress) => void)): Promise<DuckDBBindingsBase>
Instantiate the database
Parameters
- onProgress: ((progress: InstantiationProgress) => void) = ...
  - - (progress: InstantiationProgress): void
    - Parameters
      
      progress: InstantiationProgress
      
      Returns void
Returns Promise<DuckDBBindingsBase>
Implementation of DuckDBBindings.instantiate
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:72

open

open(config: DuckDBConfig): void
Open a database with a config
Parameters
- config: DuckDBConfig
Returns void
Implementation of DuckDBBindings.open
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:102

pollPendingQuery

pollPendingQuery(conn: number): null | Uint8Array
Poll a pending query
Parameters
- conn: number
Returns null | Uint8Array
Implementation of DuckDBBindings.pollPendingQuery
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:192

registerFileBuffer

registerFileBuffer(name: string, buffer: Uint8Array): void
Register a file buffer
Parameters
- name: string
- buffer: Uint8Array
Returns void
Implementation of DuckDBBindings.registerFileBuffer
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:431

registerFileHandle

registerFileHandle<HandleType>(name: string, handle: HandleType, protocol: DuckDBDataProtocol, directIO: boolean): void
Register a file object URL
Type Parameters
- HandleType
Parameters
- name: string
- handle: HandleType
- protocol: DuckDBDataProtocol
- directIO: boolean
Returns void
Implementation of DuckDBBindings.registerFileHandle
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:447

registerFileText

registerFileText(name: string, text: string): void
Register file text
Parameters
- name: string
- text: string
Returns void
Implementation of DuckDBBindings.registerFileText
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:426

registerFileURL

registerFileURL(name: string, url: string, proto: DuckDBDataProtocol, directIO?: boolean): void
Register a file object URL
Parameters
- name: string
- url: string
- proto: DuckDBDataProtocol
- directIO: boolean = false
Returns void
Implementation of DuckDBBindings.registerFileURL
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:410

reset

reset(): void
Reset the database

Returns void
Implementation of DuckDBBindings.reset
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:111

runPrepared

runPrepared(conn: number, statement: number, params: any[]): Uint8Array
Execute a prepared statement and return the full result
Parameters
- conn: number
- statement: number
- params: any[]
Returns Uint8Array
Implementation of DuckDBBindings.runPrepared
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:293

runQuery

runQuery(conn: number, text: string): Uint8Array
Send a query and return the full result
Parameters
- conn: number
- text: string
Returns Uint8Array
Implementation of DuckDBBindings.runQuery
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:164

sendPrepared

sendPrepared(conn: number, statement: number, params: any[]): Uint8Array
Execute a prepared statement and stream the result
Parameters
- conn: number
- statement: number
- params: any[]
Returns Uint8Array
Implementation of DuckDBBindings.sendPrepared
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:309

startPendingQuery

startPendingQuery(conn: number, text: string): null | Uint8Array
Start a pending query asynchronously. This method returns either the arrow ipc schema or null. On null, the query has to be executed using pollPendingQuery until that returns != null. Results can then be fetched using fetchQueryResults
Parameters
- conn: number
- text: string
Returns null | Uint8Array
Implementation of DuckDBBindings.startPendingQuery
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:179

tokenize

tokenize(text: string): ScriptTokens
Tokenize a script
Parameters
- text: string
Returns ScriptTokens
Implementation of DuckDBBindings.tokenize
- Defined in packages/duckdb-wasm/src/bindings/bindings_base.ts:135

Class DuckDBBindingsBaseAbstract

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

logger: Logger

runtime: DuckDBRuntime

Returns DuckDBBindingsBase

Accessors

logger

Returns Logger

mod

Returns DuckDBModule

pthread

Returns null | PThread

Methods

cancelPendingQuery

Parameters

conn: number

Returns boolean

closePrepared

Parameters

conn: number

statement: number

Returns void

collectFileStatistics

Parameters

file: string

enable: boolean

Returns void

connect

Returns DuckDBConnection

copyFileToBuffer

Parameters

name: string

Returns Uint8Array

copyFileToPath

Parameters

name: string

path: string

Returns void

createPrepared

Parameters

conn: number

text: string

Returns number

createScalarFunction

Parameters

conn: number

name: string

returns: DataType<Type, any>

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

Parameters

Rest ...args: any[]

Returns void

Returns void

disconnect

Parameters

conn: number

Returns void

dropFile

Parameters

name: string

Returns void

dropFiles

Returns void

exportFileStatistics

Parameters

file: string

Returns FileStatistics

fetchQueryResults

Parameters

conn: number

Returns Uint8Array

flushFiles

Class DuckDBBindingsBase`Abstract`

`Rest` ...args: any[]

`Optional` options: ArrowInsertOptions