Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PgPool

A of [PostgreSQL connections] PgConnection.

Hierarchy

  • any
    • PgPool

Index

Methods

Methods

connectHandler

  • connectHandler(handler: ((res: SqlConnection) => void) | Handler<SqlConnection>): PgPool

  • Parameters

    • handler: ((res: SqlConnection) => void) | Handler<SqlConnection>

    Returns PgPool

connectionProvider

  • connectionProvider(provider: (arg: Context) => PromiseLike<SqlConnection>): PgPool

  • Parameters

    • provider: (arg: Context) => PromiseLike<SqlConnection>
        • (arg: Context): PromiseLike<SqlConnection>

        • Parameters

          • arg: Context

          Returns PromiseLike<SqlConnection>

    Returns PgPool

Static client

  • client(): SqlClient
  • client(options: PoolOptions): SqlClient
  • client(connectionUri: string): SqlClient
  • client(connectionUri: string, options: PoolOptions): SqlClient
  • client(vertx: Vertx, connectionUri: string): SqlClient
  • client(vertx: Vertx, poolOptions: PoolOptions): SqlClient
  • client(vertx: Vertx, connectionUri: string, options: PoolOptions): SqlClient
  • client(database: PgConnectOptions, options: PoolOptions): SqlClient
  • client(vertx: Vertx, database: PgConnectOptions, options: PoolOptions): SqlClient
  • client(vertx: Vertx, databases: PgConnectOptions, options: PoolOptions): SqlClient
  • client(databases: PgConnectOptions, options: PoolOptions): SqlClient
  • client(vertx: Vertx, databases: any, options: PoolOptions): SqlClient
  • client(databases: any, options: PoolOptions): SqlClient

  • Like {@link PgPool#client} with default options.

    Returns SqlClient

  • Like {@link PgPool#client} with database retrieved from the environment variables.

    Parameters

    • options: PoolOptions

    Returns SqlClient

  • Like {@link PgPool#pool} with default options.

    Parameters

    • connectionUri: string

    Returns SqlClient

  • Like {@link PgPool#client} with database retrieved from the connectionUri.

    Parameters

    • connectionUri: string
    • options: PoolOptions

    Returns SqlClient

  • Like {@link PgPool#client} with default options.

    Parameters

    • vertx: Vertx
    • connectionUri: string

    Returns SqlClient

  • Like {@link PgPool#client} with database retrieved from the environment variables.

    Parameters

    • vertx: Vertx
    • poolOptions: PoolOptions

    Returns SqlClient

  • Like {@link PgPool#client} with database build from connectionUri.

    Parameters

    • vertx: Vertx
    • connectionUri: string
    • options: PoolOptions

    Returns SqlClient

  • Create a client backed by a connection pool to the PostgreSQL database configured with the given options.

    Parameters

    Returns SqlClient

  • Like {@link PgPool#client} with a specific instance.

    Parameters

    Returns SqlClient

  • Like {@link PgPool#client} with a specific instance.

    Parameters

    Returns SqlClient

  • Create a client backed by a connection pool to the PostgreSQL databases with round-robin selection. Round-robin is applied when a new connection is created by the pool.

    Parameters

    Returns SqlClient

  • Like {@link PgPool#client} with a specific instance.

    Parameters

    • vertx: Vertx
    • databases: any
    • options: PoolOptions

    Returns SqlClient

  • Create a client backed by a connection pool to the PostgreSQL databases. The supplier is called to provide the options when a new connection is created by the pool.

    Parameters

    • databases: any
    • options: PoolOptions

    Returns SqlClient

Static pool

  • pool(): PgPool
  • pool(options: PoolOptions): PgPool
  • pool(connectionUri: string): PgPool
  • pool(connectionUri: string, options: PoolOptions): PgPool
  • pool(vertx: Vertx, connectionUri: string): PgPool
  • pool(vertx: Vertx, options: PoolOptions): PgPool
  • pool(vertx: Vertx, connectionUri: string, poolOptions: PoolOptions): PgPool
  • pool(database: PgConnectOptions, options: PoolOptions): PgPool
  • pool(vertx: Vertx, database: PgConnectOptions, options: PoolOptions): PgPool
  • pool(databases: PgConnectOptions, poolOptions: PoolOptions): PgPool
  • pool(vertx: Vertx, databases: PgConnectOptions, poolOptions: PoolOptions): PgPool
  • pool(databases: any, poolOptions: PoolOptions): PgPool
  • pool(vertx: Vertx, databases: any, poolOptions: PoolOptions): PgPool

  • Like {@link PgPool#pool} with a default poolOptions.

    Returns PgPool

  • Like {@link PgPool#pool} with connectOptions build from the environment variables.

    Parameters

    • options: PoolOptions

    Returns PgPool

  • Like {@link PgPool#pool} with a default poolOptions.

    Parameters

    • connectionUri: string

    Returns PgPool

  • Like {@link PgPool#pool} with connectOptions build from connectionUri.

    Parameters

    • connectionUri: string
    • options: PoolOptions

    Returns PgPool

  • Like {@link PgPool#pool} with default options.

    Parameters

    • vertx: Vertx
    • connectionUri: string

    Returns PgPool

  • Like {@link PgPool#pool} with the database retrieved from the environment variables.

    Parameters

    • vertx: Vertx
    • options: PoolOptions

    Returns PgPool

  • Like {@link PgPool#pool} with database retrieved from the given connectionUri.

    Parameters

    • vertx: Vertx
    • connectionUri: string
    • poolOptions: PoolOptions

    Returns PgPool

  • Create a connection pool to the PostgreSQL database configured with the given options.

    Parameters

    Returns PgPool

  • Like {@link PgPool#pool} with a specific instance.

    Parameters

    Returns PgPool

  • Create a connection pool to the PostgreSQL databases with round-robin selection. Round-robin is applied when a new connection is created by the pool.

    Parameters

    Returns PgPool

  • Like {@link PgPool#pool} with a specific instance.

    Parameters

    Returns PgPool

  • Create a connection pool to the PostgreSQL databases. The supplier is called to provide the options when a new connection is created by the pool.

    Parameters

    • databases: any
    • poolOptions: PoolOptions

    Returns PgPool

  • Like {@link PgPool#pool} with a specific instance.

    Parameters

    • vertx: Vertx
    • databases: any
    • poolOptions: PoolOptions

    Returns PgPool

Generated using TypeDoc