Class PoolClient

The RxJS wrapper for pg.PoolClient.

Note

A PoolClient is created automatically when connect is called from within Pool. This class is nearly identical to Client, except Client, except a standalone client is disconnected with end(), whereas a PoolClient is released with release().

Public Api

Hierarchy (view full)

Constructors

constructor

Properties

_clientNative

Accessors

onDrain onEnd onError onNotice onNotification

Methods

connect query once unsubscribe release

Constructors

constructor

Properties

Protected _clientNative

_clientNative: Client | PoolClient

Accessors

onDrain

  • get onDrain(): Subject<void>

  • A Subject that emits drain events.

    Returns Subject<void>

onEnd

  • get onEnd(): Subject<void>

  • A Subject that emits end events.

    Returns Subject<void>

onError

  • get onError(): Subject<Error>

  • A Subject that emits error events.

    Returns Subject<Error>

onNotice

  • get onNotice(): Subject<NoticeMessage>

  • A Subject that emits notice events.

    Returns Subject<NoticeMessage>

onNotification

  • get onNotification(): Subject<Notification>

  • A Subject that emits notification events.

    Returns Subject<Notification>

Methods

connect

query

  • query<T, I>(config): Observable<QueryResult<T>>

  • Queries a database, returning query results after all results have been returned.

    Type Parameters

    • T extends QueryResultRow = any
    • I = any[]

    Parameters

    • config: QueryConfig<I> & {
          returnsCursors?: false;
          stream?: false;
      }

      Defines query parameters

    Returns Observable<QueryResult<T>>

  • query<T, I>(config): Observable<T>

  • Queries a database, streaming query results as they are read.

    Type Parameters

    • T = any
    • I = any[]

    Parameters

    Returns Observable<T>

  • query<I>(config): Observable<QueryCursorResult>

  • Queries a database, returning query results by cursor after cursor has read all rows.

    Type Parameters

    • I = any[]

    Parameters

    • config: QueryConfig<I> & {
          returnsCursors: true;
          stream?: false;
      }

      Defines query parameters

    Returns Observable<QueryCursorResult>

  • query<I>(config): Observable<QueryCursorRow>

  • Queries a database, streaming query results as cursor reads rows.

    Type Parameters

    • I = any[]

    Parameters

    Returns Observable<QueryCursorRow>

once

  • once(eventName): Observable<void>

  • Completes after one drain event has been observed.

    Parameters

    • eventName: "drain"

    Returns Observable<void>

  • once(eventName): Observable<void>

  • Completes after one end event has been observed.

    Parameters

    • eventName: "end"

    Returns Observable<void>

  • once(eventName): Observable<Error>

  • Completes after one error has been observed.

    Parameters

    • eventName: "error"

    Returns Observable<Error>

  • once(eventName): Observable<NoticeMessage>

  • Completes after one NoticeMessage has been observed.

    Parameters

    • eventName: "notice"

    Returns Observable<NoticeMessage>

  • once(eventName): Observable<Notification>

  • Completes after one Notification has been observed.

    Parameters

    • eventName: "notification"

    Returns Observable<Notification>

unsubscribe

  • unsubscribe(eventName?): this

  • Unsubscribes from an event subject or all event subjects.

    Parameters

    • Optional eventName: "error" | "end" | "drain" | "notice" | "notification"

      A Client event name

    Returns this

release

  • release<T>(result): Observable<T>

  • Releases a connection opened in connect() and forwards the result of a successful query.

    Type Parameters

    • T

    Parameters

    • result: T

      The result of a successful query, useful for RxJS maps.

    Returns Observable<T>

  • release(): Observable<PoolClient>

  • Releases a connection opened in connect().

    Returns Observable<PoolClient>

Settings

Member Visibility

Theme

On This Page

constructor_clientNativeonDrainonEndonErroronNoticeonNotificationconnectqueryonceunsubscriberelease