DuckDB-WASM
    Preparing search index...

    Interface DuckDBConfig

    interface DuckDBConfig {
        accessMode?: DuckDBAccessMode;
        allowUnsignedExtensions?: boolean;
        arrowLosslessConversion?: boolean;
        customUserAgent?: string;
        extensionRepository?: string;
        filesystem?: DuckDBFilesystemConfig;
        homeDirectory?: string;
        maximumThreads?: number;
        opfs?: DuckDBOPFSConfig;
        path?: string;
        query?: DuckDBQueryConfig;
        singleThreadedExtensionLoad?: boolean;
        spill?: boolean;
        temporaryDirectory?: string;
        useDirectIO?: boolean;
    }
    Index

    Properties

    accessMode? allowUnsignedExtensions? arrowLosslessConversion? customUserAgent? extensionRepository? filesystem? homeDirectory? maximumThreads? opfs? path? query? singleThreadedExtensionLoad? spill? temporaryDirectory? useDirectIO?

    Properties

    accessMode?: DuckDBAccessMode

    The access mode

    allowUnsignedExtensions?: boolean

    Whether to allow unsigned extensions

    arrowLosslessConversion?: boolean

    Whether to use alternate Arrow conversion that preserves full range and precision of data.

    customUserAgent?: string

    Custom user agent string

    extensionRepository?: string

    The repository extensions are loaded from (custom_extension_repository), the Haybarn core repository (haybarn-extensions.query.farm/core) by default

    filesystem?: DuckDBFilesystemConfig

    The filesystem config

    homeDirectory?: string

    The home directory of DuckDB, opfs://home where the browser has an origin private file system: what DuckDB stores next to the user (persistent secrets) persists across sessions

    maximumThreads?: number

    The maximum number of threads. Note that this will only work with cross-origin isolated sites since it requires SharedArrayBuffers.

    opfs?: DuckDBOPFSConfig

    opfs string

    path?: string

    The database path

    query?: DuckDBQueryConfig

    The query config

    singleThreadedExtensionLoad?: boolean

    Haybarn: run extension LOAD/INSTALL statements with the task scheduler pinned to a single thread.

    When enabled, the bindings bracket each statement that starts with LOAD/INSTALL with SET threads=1 ... SET threads=<previous>. It was the workaround for an intermittent deadlock of extension loads on the threads bundle: the query thread spun while a scheduler thread ran the load, so it never synced the side module the main thread opened. The engine now waits instead of spinning (wait_for_tasks_instead_of_spinning.patch), and loads, autoloads inside queries included, no longer need the bracket.

    Defaults to disabled. A no-op on the base bundle and whenever threads is already 1.

    spill?: boolean

    Spill data that does not fit in memory to the temporary directory, js_buffer://tmp by default: buffers held by the runtime outside the WASM heap. Enabled unless set to false.

    temporaryDirectory?: string

    The temporary directory of DuckDB, overrides the default of the runtime

    useDirectIO?: boolean

    The direct io flag

    Settings

    Member Visibility

    On This Page

    Properties