prorm API Reference
    Preparing search index...

    Interface PrormOptions

    Everything needed to construct a Prorm instance: which engine to talk to, how to reach it, and the cross-cutting behaviour (pooling, retries, logging, caching) that applies to every query it runs.

    interface PrormOptions {
        dialect: Dialect;
        database?: string;
        username?: string;
        password?: string;
        host?: string;
        port?: number;
        storage?: string;
        logging?: boolean | ((sql: string, timing?: number) => void);
        benchmark?: boolean;
        logQueryParameters?: boolean;
        loggingLevel?: "debug" | "info" | "warn" | "error" | LoggingLevel;
        logSQL?: boolean;
        logSlowQueries?: boolean;
        slowQueryThreshold?: number;
        colors?: boolean;
        pool?: PoolOptions;
        retry?: RetryOptions;
        connectTimeout?: number;
        idleTimeout?: number;
        timezone?: string;
        keepDefaultTimezone?: boolean;
        dialectOptions?: Record<string, any>;
        transactionType?: string;
        isolationLevel?: string;
        raw?: boolean;
        migrationModule?: any;
        migrationStorage?: "table" | "none" | "prorm";
        migrationStorageTableName?: string;
        migrationStorageTableSchema?: string;
        migrationsPath?: string;
        schema?: string;
        searchPath?: string | string[];
        connections?: NamedConnectionOptions[];
        defaultConnection?: string;
    }
    Index
    dialect database? username? password? host? port? storage? logging? benchmark? logQueryParameters? loggingLevel? logSQL? logSlowQueries? slowQueryThreshold? colors? pool? retry? connectTimeout? idleTimeout? timezone? keepDefaultTimezone? dialectOptions? transactionType? isolationLevel? raw? migrationModule? migrationStorage? migrationStorageTableName? migrationStorageTableSchema? migrationsPath? schema? searchPath? connections? defaultConnection?
    dialect: Dialect
    database?: string
    username?: string
    password?: string
    host?: string
    port?: number
    storage?: string
    logging?: boolean | ((sql: string, timing?: number) => void)

    Query logging, following Sequelize's contract: false off, true console.log, or a function called as (sql, timing). A per-query logging overrides this for that call.

    benchmark?: boolean

    Append the elapsed time to each logged query, and log even when logging was never set. Matches Sequelize's benchmark.

    logQueryParameters?: boolean

    Append the values bound to each statement. Off by default: bound values routinely contain credentials and personal data, so this must be opted into deliberately.

    loggingLevel?: "debug" | "info" | "warn" | "error" | LoggingLevel
    logSQL?: boolean
    logSlowQueries?: boolean
    slowQueryThreshold?: number
    colors?: boolean
    pool?: PoolOptions
    retry?: RetryOptions

    Connection pool settings

    connectTimeout?: number

    Connection timeout in milliseconds

    idleTimeout?: number

    Idle timeout in milliseconds

    timezone?: string
    keepDefaultTimezone?: boolean

    Keep the database's default timezone instead of converting to UTC

    dialectOptions?: Record<string, any>

    Additional options to pass to the database driver (e.g., SSL config)

    transactionType?: string
    isolationLevel?: string
    raw?: boolean
    migrationModule?: any
    migrationStorage?: "table" | "none" | "prorm"
    migrationStorageTableName?: string
    migrationStorageTableSchema?: string
    migrationsPath?: string
    schema?: string

    Schema to use for database operations (PostgreSQL)

    searchPath?: string | string[]

    Search path for query resolution (PostgreSQL)

    connections?: NamedConnectionOptions[]

    Additional named connections for cross-database queries

    defaultConnection?: string

    Name of the default connection to use

    Settings
    Member Visibility

    On This Page
    Properties