Class AsyncDuckDB

An interface for the async DuckDB bindings

Hierarchy

  • AsyncDuckDB

Implements

Constructors

  • Parameters

    • logger: Logger
    • worker: null | Worker = null

    Returns AsyncDuckDB

Accessors

Methods

  • Cancel a pending query

    Parameters

    • conn: number

    Returns Promise<boolean>

  • Close a prepared statement

    Parameters

    • conn: number
    • statement: number

    Returns Promise<void>

  • Enable file statistics

    Parameters

    • name: string
    • enable: boolean

    Returns Promise<void>

  • Connect to the database

    Returns Promise<number>

  • Copy a file to a buffer.

    Parameters

    • name: string

    Returns Promise<Uint8Array>

  • Copy a file to a path.

    Parameters

    • name: string
    • path: string

    Returns Promise<void>

  • Prepare a statement and return its identifier

    Parameters

    • conn: number
    • text: string

    Returns Promise<number>

  • Detach from worker

    Returns void

  • Disconnect from the database

    Parameters

    • conn: number

    Returns Promise<void>

  • Try to drop a file

    Parameters

    • name: string

    Returns Promise<null>

  • Try to drop files

    Returns Promise<null>

  • Export file statistics

    Parameters

    • name: string

    Returns Promise<FileStatistics>

  • Fetch query results

    Parameters

    • conn: number

    Returns Promise<Uint8Array>

  • Flush all files

    Returns Promise<null>

  • Get the feature flags

    Returns Promise<number>

  • Get table names

    Parameters

    • conn: number
    • text: string

    Returns Promise<string[]>

  • Get the version

    Returns Promise<string>

  • Glob file infos

    Parameters

    • path: string

    Returns Promise<WebFile[]>

  • Open the database

    Parameters

    Returns Promise<null>

  • Open a new database

    Parameters

    Returns Promise<void>

  • Ping the worker thread

    Returns Promise<any>

  • Poll a pending query

    Parameters

    • conn: number

    Returns Promise<null | Uint8Array>

  • Register an empty file buffer.

    Parameters

    • name: string

    Returns Promise<void>

  • Register a file buffer.

    Parameters

    • name: string
    • buffer: Uint8Array

    Returns Promise<void>

  • Register a file handle.

    Type Parameters

    • HandleType

    Parameters

    Returns Promise<void>

  • Register file text

    Parameters

    • name: string
    • text: string

    Returns Promise<void>

  • Reset the duckdb

    Returns Promise<null>

  • Execute a prepared statement and return the full result

    Parameters

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

    Returns Promise<Uint8Array>

  • Run a query

    Parameters

    • conn: number
    • text: string

    Returns Promise<Uint8Array>

  • Execute a prepared statement and stream the result

    Parameters

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

    Returns Promise<Uint8Array>

  • Start a pending query

    Parameters

    • conn: number
    • text: string

    Returns Promise<null | Uint8Array>

  • Kill the worker

    Returns Promise<void>

  • Tokenize a script text

    Parameters

    • text: string

    Returns Promise<ScriptTokens>

Generated using TypeDoc