Interface StorageOpenOptions

Options accepted when opening a storage adapter.

interface StorageOpenOptions {
    filePath?: string;
    connectionString?: string;
    readOnly?: boolean;
    adapterOptions?: Record<string, unknown>;
}

Hierarchy (view full)

Properties

filePath?: string

Absolute path to the primary database file (when applicable).

connectionString?: string

Connection string (PostgreSQL, etc.).

readOnly?: boolean

Optional flag to force read-only mode.

adapterOptions?: Record<string, unknown>

Arbitrary adapter-specific options bag.