Interface PostgresStoreOpts

interface PostgresStoreOpts {
    autocreateSchemaTable?: boolean;
    backoff?: boolean | ((attemptNum) => number);
    connect_timeout?: number;
    connection?: Partial<ConnectionParameters>;
    database?: string;
    db?: string;
    debug?: boolean | ((connection, query, parameters, paramTypes) => void);
    fetch_types?: boolean;
    host?: string;
    hostname?: string;
    idle_timeout?: number;
    keep_alive?: null | number;
    max?: number;
    max_lifetime?: null | number;
    no_prepare?: boolean;
    onclose?: ((connId) => void);
    onnotice?: ((notice) => void);
    onparameter?: ((key, value) => void);
    pass?: string | (() => string | Promise<string>);
    password?: string | (() => string | Promise<string>);
    path?: string;
    port?: number;
    prepare?: boolean;
    publications?: string;
    ssl?: boolean | object | "allow" | "require" | "prefer" | "verify-full";
    target_session_attrs?: "read-write" | "read-only" | "primary" | "standby" | "prefer-standby";
    timeout?: number;
    transform?: {
        column?: {
            from?: ((column) => string);
            to?: ((column) => string);
        } | ((column) => string);
        row?: {
            from?: ((row) => any);
        } | ((row) => any);
        undefined?: any;
        value?: {
            from?: ((value, column) => any);
        } | ((value) => any);
    };
    types?: Record<string, PostgresType<unknown>>;
    url?: string;
    user?: string;
    username?: string;
}

Hierarchy

  • Options<Record<string, PostgresType<unknown>>>
    • PostgresStoreOpts

Properties

autocreateSchemaTable? backoff? connect_timeout? connection? database? db? debug? fetch_types? host? hostname? idle_timeout? keep_alive? max? max_lifetime? no_prepare? onclose? onnotice? onparameter? pass? password? path? port? prepare? publications? ssl? target_session_attrs? timeout? transform? types? url? user? username?

Properties

Optional autocreateSchemaTable

autocreateSchemaTable?: boolean

Should the schema table be automatically created (the v0 schema effectively). Defaults to true.

Optional backoff

backoff?: boolean | ((attemptNum) => number)

Type declaration

    • (attemptNum): number

    • Parameters

      • attemptNum: number

      Returns number

Optional connect_timeout

connect_timeout?: number

Connect timeout in seconds

Default

process.env['PGCONNECT_TIMEOUT']

Optional connection

connection?: Partial<ConnectionParameters>

Connection parameters

Optional database

database?: string

Name of database to connect to

Default

process.env['PGDATABASE'] || options.user

Optional db

db?: string

Name of database to connect to (an alias for database)

Optional debug

debug?: boolean | ((connection, query, parameters, paramTypes) => void)

Is called with (connection; query; parameters)

Type declaration

    • (connection, query, parameters, paramTypes): void

    • Parameters

      • connection: number
      • query: string
      • parameters: any[]
      • paramTypes: any[]

      Returns void

Optional fetch_types

fetch_types?: boolean

Automatically fetches types on connect

Default

true

Optional host

host?: string

Inherit Doc

Optional hostname

hostname?: string

Postgres ip address or domain name (an alias for host)

Optional idle_timeout

idle_timeout?: number

Idle connection timeout in seconds

Default

process.env['PGIDLE_TIMEOUT']

Optional keep_alive

keep_alive?: null | number

Optional max

max?: number

Max number of connections

Default

10

Optional max_lifetime

max_lifetime?: null | number

Optional no_prepare

no_prepare?: boolean

Disable prepared mode

Deprecated

use "prepare" option instead

Optional onclose

onclose?: ((connId) => void)

Type declaration

    • (connId): void

    • Parameters

      • connId: number

      Returns void

Optional onnotice

onnotice?: ((notice) => void)

Called when a notice is received

Type declaration

    • (notice): void

    • Called when a notice is received

      Parameters

      • notice: Notice

      Returns void

      Default

      console.log

Default

console.log

Optional onparameter

onparameter?: ((key, value) => void)

(key; value) when a server param change

Type declaration

    • (key, value): void

    • (key; value) when a server param change

      Parameters

      • key: string
      • value: any

      Returns void

Optional pass

pass?: string | (() => string | Promise<string>)

Password of database user (an alias for password)

Type declaration

    • (): string | Promise<string>

    • Returns string | Promise<string>

Optional password

password?: string | (() => string | Promise<string>)

Password of database user

Type declaration

    • (): string | Promise<string>

    • Returns string | Promise<string>

Default

process.env['PGPASSWORD']

Optional path

path?: string

Inherit Doc

Optional port

port?: number

Inherit Doc

Optional prepare

prepare?: boolean

Enables prepare mode.

Default

true

Optional publications

publications?: string

Publications to subscribe to (only relevant when calling sql.subscribe())

Default

'alltables'

Optional ssl

ssl?: boolean | object | "allow" | "require" | "prefer" | "verify-full"

How to deal with ssl (can be a tls.connect option object)

Default

false

Optional target_session_attrs

target_session_attrs?: "read-write" | "read-only" | "primary" | "standby" | "prefer-standby"

Use 'read-write' with multiple hosts to ensure only connecting to primary

Default

process.env['PGTARGETSESSIONATTRS']

Optional timeout

timeout?: number

Idle connection timeout in seconds

Deprecated

use "idle_timeout" option instead

Optional transform

transform?: {
    column?: {
        from?: ((column) => string);
        to?: ((column) => string);
    } | ((column) => string);
    row?: {
        from?: ((row) => any);
    } | ((row) => any);
    undefined?: any;
    value?: {
        from?: ((value, column) => any);
    } | ((value) => any);
}

Transform hooks

Type declaration

  • Optional column?: {
        from?: ((column) => string);
        to?: ((column) => string);
    } | ((column) => string)

    Transforms incoming and outgoing column names

  • Optional row?: {
        from?: ((row) => any);
    } | ((row) => any)

    Transforms entire rows

  • Optional undefined?: any

    Transforms outcoming undefined values

  • Optional value?: {
        from?: ((value, column) => any);
    } | ((value) => any)

    Transforms incoming and outgoing row values

Optional types

types?: Record<string, PostgresType<unknown>>

Array of custom types; see more in the README

Optional url

url?: string

URL to reach the database on.

Optional user

user?: string

Username of database user

Default

process.env['PGUSERNAME'] || process.env['PGUSER'] || require('os').userInfo().username

Optional username

username?: string

Username of database user (an alias for user)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc