Interface DuckDBRuntime

The duckdb runtime

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

Properties

_files? _udfFunctions prepareDBFileHandle? prepareFileHandle? prepareFileHandles?

Methods

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

Properties

Optional _files

_files?: Map<string, any>

_udfFunctions

_udfFunctions: Map<number, UDFFunction>

Optional prepareDBFileHandle

prepareDBFileHandle?: ((path, protocol) => Promise<PreparedDBFileHandle[]>)

Type declaration

Optional prepareFileHandle

prepareFileHandle?: ((path, protocol) => Promise<PreparedDBFileHandle[]>)

Type declaration

Optional prepareFileHandles

prepareFileHandles?: ((path, protocol) => Promise<PreparedDBFileHandle[]>)

Type declaration

Methods

callScalarUDF

checkDirectory

checkFile

closeFile

createDirectory

dropFile

getDefaultDataProtocol

getLastFileModificationTime

glob

listDirectoryEntries

moveFile

openFile

progressUpdate

readFile

removeDirectory

removeFile

syncFile

testPlatformFeature

truncateFile

writeFile

Settings

Member Visibility

Theme

On This Page

_files_udfFunctionsprepareDBFileHandleprepareFileHandleprepareFileHandlescallScalarUDFcheckDirectorycheckFilecloseFilecreateDirectorydropFilegetDefaultDataProtocolgetLastFileModificationTimegloblistDirectoryEntriesmoveFileopenFileprogressUpdatereadFileremoveDirectoryremoveFilesyncFiletestPlatformFeaturetruncateFilewriteFile