prorm API Reference
    Preparing search index...

    Interface ReplicaConnectionConfig

    Configuration for connecting to a replica

    interface ReplicaConnectionConfig {
        name: string;
        host: string;
        port: number;
        database: string;
        username: string;
        password: string;
        dialect: string;
        dialectOptions?: Record<string, any>;
        pool?: { max?: number; min?: number; idle?: number; acquire?: number };
    }
    Index
    name host port database username password dialect dialectOptions? pool?
    name: string

    Unique name for this replica

    host: string

    Connection host

    port: number

    Connection port

    database: string

    Database name

    username: string

    Username

    password: string

    Password

    dialect: string

    Connection dialect (mysql, mariadb, postgres, mssql, sqlite, oracle)

    dialectOptions?: Record<string, any>

    Additional dialect-specific options

    pool?: { max?: number; min?: number; idle?: number; acquire?: number }

    Pool options for this replica

    Settings
    Member Visibility

    On This Page
    Properties