@ckirg/corelib - v0.4.1
    Preparing search index...

    Interface SqliteConfig

    Configuration for SQLite dialect.

    interface SqliteConfig {
        authToken?: string;
        dialect: "sqlite";
        getTraceId?: () => string | undefined;
        journalMode?: "WAL" | "DELETE";
        localPath?: string;
        logger?: StrictLogger;
        maxConnections?: number;
        mode: DbMode;
        paramRedactor?: ParamRedactor;
        synchronous?: "NORMAL" | "FULL";
        timeoutMs?: number;
        url: string;
    }

    Hierarchy (View Summary)

    Index
    authToken? dialect getTraceId? journalMode? localPath? logger? maxConnections? mode paramRedactor? synchronous? timeoutMs? url
    authToken?: string
    dialect: "sqlite"

    Database dialect to use.

    getTraceId?: () => string | undefined

    Optional provider for a logical-operation trace id, threaded onto query logs so an AI can follow one operation across many queries/requests. The consuming app populates it (e.g. from an AsyncLocalStorage request/operation context); corelib stays ALS-ignorant.

    journalMode?: "WAL" | "DELETE"

    Opt-in SQLite journal mode. When set on a local-file url, connect() issues PRAGMA journal_mode=<value> immediately after opening the connection. Has no effect on remote libsql (Turso) urls. Default: undefined (no PRAGMA issued — preserves existing behavior).

    localPath?: string
    logger?: StrictLogger

    Logger instance (defaults to global logger.child({ section: 'Database' })).

    maxConnections?: number
    mode: DbMode

    Operation mode.

    paramRedactor?: ParamRedactor

    Opt-in param logging for the Flight-Recorder query traces. When set, each query's params are passed through this redactor and logged under params on query: exec. Unset (the default) means params are NOT logged. Use the exported defaultRedactor (or a stricter one); the consuming project owns the residual leak risk.

    synchronous?: "NORMAL" | "FULL"

    Opt-in SQLite synchronous mode. Issued as PRAGMA synchronous=<value> when journalMode is also set and the url is a local file. "NORMAL" cuts per-commit fsync cost (~120ms → ~1-5ms for WAL appends). Default: undefined (no PRAGMA issued).

    timeoutMs?: number

    Query timeout in milliseconds.

    url: string

    Database URL (e.g., 'file:local.db' for SQLite, 'postgres://user:pass@host/db' for Postgres).

    Settings
    Member Visibility

    On This Page
    Properties