DuckDB-WASM
    Preparing search index...

    Interface DuckDBRuntime

    The duckdb runtime

    interface DuckDBRuntime {
        _files?: Map<string, any>;
        _udfFunctions: Map<number, UDFFunction>;
        checkpointFiles?: () => Promise<void>;
        mountOPFS?: () => Promise<void>;
        prepareDBFileHandle?: (
            path: string,
            protocol: DuckDBDataProtocol,
        ) => Promise<PreparedDBFileHandle[]>;
        prepareFileHandle?: (
            path: string,
            protocol: DuckDBDataProtocol,
        ) => Promise<PreparedDBFileHandle[]>;
        prepareFileHandles?: (
            path: string[],
            protocol: DuckDBDataProtocol,
            mode?: OPFSAccessMode,
        ) => Promise<PreparedDBFileHandle[]>;
        callScalarUDF(
            mod: DuckDBModule,
            response: number,
            funcId: number,
            descPtr: number,
            descSize: number,
            ptrsPtr: number,
            ptrsSize: number,
        ): void;
        checkDirectory(
            mod: DuckDBModule,
            pathPtr: number,
            pathLen: number,
        ): boolean;
        checkFile(mod: DuckDBModule, pathPtr: number, pathLen: number): boolean;
        closeFile(mod: DuckDBModule, fileId: number): void;
        createDirectory(mod: DuckDBModule, pathPtr: number, pathLen: number): void;
        dropFile(mod: DuckDBModule, fileNamePtr: number, fileNameLen: number): void;
        getDefaultDataProtocol(mod: DuckDBModule): number;
        getLastFileModificationTime(mod: DuckDBModule, fileId: number): number;
        glob(mod: DuckDBModule, pathPtr: number, pathLen: number): void;
        listDirectoryEntries(
            mod: DuckDBModule,
            pathPtr: number,
            pathLen: number,
        ): boolean;
        moveFile(
            mod: DuckDBModule,
            fromPtr: number,
            fromLen: number,
            toPtr: number,
            toLen: number,
        ): void;
        openFile(mod: DuckDBModule, fileId: number, flags: FileFlags): void;
        progressUpdate(final: number, percentage: number, iteration: number): void;
        readFile(
            mod: DuckDBModule,
            fileId: number,
            buffer: number,
            bytes: number,
            location: number,
        ): number;
        removeDirectory(mod: DuckDBModule, pathPtr: number, pathLen: number): void;
        removeFile(mod: DuckDBModule, pathPtr: number, pathLen: number): void;
        setLogger?(logger: Logger): void;
        syncFile(mod: DuckDBModule, fileId: number): void;
        testPlatformFeature(mod: DuckDBModule, feature: number): boolean;
        truncateFile(mod: DuckDBModule, fileId: number, newSize: number): void;
        writeFile(
            mod: DuckDBModule,
            fileId: number,
            buffer: number,
            bytes: number,
            location: number,
        ): number;
    }
    Index

    Properties

    _files? _udfFunctions checkpointFiles? mountOPFS? prepareDBFileHandle? prepareFileHandle? prepareFileHandles?

    Methods

    callScalarUDF checkDirectory checkFile closeFile createDirectory dropFile getDefaultDataProtocol getLastFileModificationTime glob listDirectoryEntries moveFile openFile progressUpdate readFile removeDirectory removeFile setLogger? syncFile testPlatformFeature truncateFile writeFile

    Properties

    Optional_files

    _files?: Map<string, any>

    _udfFunctions

    _udfFunctions: Map<number, UDFFunction>
    checkpointFiles?: () => Promise<void>

    Finish file operations that could only be completed asynchronously, called between queries

    mountOPFS?: () => Promise<void>

    Mount the origin private file system, a no-op where there is none

    prepareDBFileHandle?: (
        path: string,
        protocol: DuckDBDataProtocol,
    ) => Promise<PreparedDBFileHandle[]>
    prepareFileHandle?: (
        path: string,
        protocol: DuckDBDataProtocol,
    ) => Promise<PreparedDBFileHandle[]>
    prepareFileHandles?: (
        path: string[],
        protocol: DuckDBDataProtocol,
        mode?: OPFSAccessMode,
    ) => Promise<PreparedDBFileHandle[]>

    Methods

    • Parameters

      • mod: DuckDBModule
      • response: number
      • funcId: number
      • descPtr: number
      • descSize: number
      • ptrsPtr: number
      • ptrsSize: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods