prorm API Reference
    Preparing search index...

    Interface DorisStoreOptions

    Connection options for DorisStore (map onto mysql2 connection config).

    interface DorisStoreOptions {
        host?: string;
        port?: number;
        user?: string;
        password?: string;
        database?: string;
        connectionOptions?: Record<string, unknown>;
        client?: MysqlConnectionLike;
    }
    Index
    host? port? user? password? database? connectionOptions? client?
    host?: string
    port?: number
    user?: string
    password?: string
    database?: string
    connectionOptions?: Record<string, unknown>

    Escape hatch for any other mysql2 connection option.

    client?: MysqlConnectionLike

    A pre-built mysql2 connection/pool (or compatible mock). When provided, connect() uses it directly and skips require('mysql2/promise'). This is how tests inject a mock without the real driver installed.

    Settings
    Member Visibility

    On This Page
    Properties