Class PostgresConnection

An implementation of a database Connection for dealing with PostgreSQL servers.

Hierarchy

Connection
- PostgresConnection

Index

Constructors

constructor

Properties

Accessors

appClassApplication

Methods

Constructors

constructor

new PostgresConnection(name: string, config?: any): PostgresConnection

Inherited from Connection.constructor
- Defined in src/orm/connection/Connection.ts:28
Parameters
- name: string
- config: any = {}
Returns PostgresConnection

Properties

Protected bus

Protected Optional client

client: Client

The pg database client.

Readonly config

config: any = {}

Protected Readonly logging

logging: Logging

Readonly name

name: string

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

Methods

Protected app

app(): Application

Inherited from Connection.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

asTransaction

asTransaction<T>(closure: () => Awaitable<T>): Promise<T>

Overrides Connection.asTransaction
- Defined in src/orm/connection/PostgresConnection.ts:77
Type parameters
- T
Parameters
- closure: () => Awaitable<T>
  - - (): Awaitable<T>
    - Returns Awaitable<T>
Returns Promise<T>

close

close(): Promise<void>

Overrides Connection.close
- Defined in src/orm/connection/PostgresConnection.ts:43
Returns Promise<void>

Protected container

container(): Container

Inherited from Connection.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

dialect

dialect(): SQLDialect

Overrides Connection.dialect
- Defined in src/orm/connection/PostgresConnection.ts:33
Returns SQLDialect

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from Connection.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

init

init(): Promise<void>

Overrides Connection.init
- Defined in src/orm/connection/PostgresConnection.ts:37
Returns Promise<void>

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from Connection.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

query

query(query: string): Promise<QueryResult>

Overrides Connection.query
- Defined in src/orm/connection/PostgresConnection.ts:50
Parameters
- query: string
Returns Promise<QueryResult>

Protected queryExecuted

queryExecuted(query: string): Promise<void>

Inherited from Connection.queryExecuted
- Defined in src/orm/connection/Connection.ts:83
Fire a QueryExecutedEvent for the given query string.

Parameters
- query: string
Returns Promise<void>

schema

schema(name?: string): Schema

Overrides Connection.schema
- Defined in src/orm/connection/PostgresConnection.ts:88
Parameters
- Optional name: string
Returns Schema

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.