Class DuckDBBindingsBaseAbstract

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

Hierarchy

  • DuckDBBindingsBase

Implements

Constructors

Accessors

  • get logger(): Logger
  • Get the logger

    Returns Logger

  • get mod(): DuckDBModule
  • Get the instance

    Returns DuckDBModule

  • get pthread(): null | PThread
  • Get the instance

    Returns null | PThread

Methods

  • Cancel a pending query

    Parameters

    • conn: number

    Returns boolean

  • Close a prepared statement

    Parameters

    • conn: number
    • statement: number

    Returns void

  • Enable tracking of file statistics

    Parameters

    • file: string
    • enable: boolean

    Returns void

  • Write a file to a buffer

    Parameters

    • name: string

    Returns Uint8Array

  • Write a file to a path

    Parameters

    • name: string
    • path: string

    Returns void

  • Prepare a statement and return its identifier

    Parameters

    • conn: number
    • text: string

    Returns number

  • 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

  • Disconnect from database

    Parameters

    • conn: number

    Returns void

  • Drop file

    Parameters

    • name: string

    Returns void

  • Drop files

    Returns void

  • Fetch query results

    Parameters

    • conn: number

    Returns Uint8Array

  • Flush all files

    Returns void

  • Get the feature flags

    Returns number

  • Get table names

    Parameters

    • conn: number
    • text: string

    Returns string[]

  • Get the version

    Returns string

  • Glob file infos

    Parameters

    • path: string

    Returns WebFile[]

  • Open a database with a config

    Parameters

    Returns void

  • Poll a pending query

    Parameters

    • conn: number

    Returns null | Uint8Array

  • Register a file buffer

    Parameters

    • name: string
    • buffer: Uint8Array

    Returns void

  • Register a file object URL

    Type Parameters

    • HandleType

    Parameters

    Returns void

  • Register file text

    Parameters

    • name: string
    • text: string

    Returns void

  • Register a file object URL

    Parameters

    Returns void

  • Reset the database

    Returns void

  • Execute a prepared statement and return the full result

    Parameters

    • conn: number
    • statement: number
    • params: any[]

    Returns Uint8Array

  • Send a query and return the full result

    Parameters

    • conn: number
    • text: string

    Returns Uint8Array

  • Execute a prepared statement and stream the result

    Parameters

    • conn: number
    • statement: number
    • params: any[]

    Returns 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

  • Tokenize a script

    Parameters

    • text: string

    Returns ScriptTokens

Generated using TypeDoc