CereusDB API Documentation
    Preparing search index...

    Interface CereusDBOptions

    interface CereusDBOptions {
        attach?: string[];
        objectStores?: ObjectStoreRegistryConfig;
        onExport?: false | ExportHandler;
        storage?: StorageOptions;
        wasmSource?:
            | BufferSource
            | RequestInfo
            | URL
            | Response
            | Promise<Response>
            | Module;
        wasmUrl?: string;
    }
    Index

    Properties

    attach? objectStores? onExport? storage? wasmSource? wasmUrl?

    Properties

    attach?: string[]

    Persistent databases to open at startup, for example ['opfs://mydb']. Each is created if it does not exist yet.

    objectStores?: ObjectStoreRegistryConfig

    Browser-backed object stores to register at startup.

    onExport?: false | ExportHandler

    Receives files written by COPY ... TO '<file>' and CereusDB.downloadGeoParquet. Defaults to downloadFile (a browser download) when a DOM document is available; pass false to disable exports or a function to handle them yourself (for example in a Web Worker or in Node.js).

    storage?: StorageOptions

    Storage backends for persistent databases, by URL scheme. opfs defaults to an OPFSStorageBackend when the browser supports OPFS; pass false to disable it.

    wasmSource?:
        | BufferSource
        | RequestInfo
        | URL
        | Response
        | Promise<Response>
        | Module

    Preloaded WASM bytes/module for Node or custom loaders.

    wasmUrl?: string

    Custom WASM module URL (for CDN hosting)

    Settings

    Member Visibility

    On This Page

    Properties