Class Connection

Abstract base class for database connections.

abstract

Hierarchy

AppClass
- Connection
  - PostgresConnection

Index

Constructors

constructor

Properties

Accessors

appClassApplication

Methods

Constructors

constructor

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

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

Properties

Protected bus

Readonly config

config: any = {}

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 AppClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Abstract asTransaction

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

- Defined in src/orm/connection/Connection.ts:76
Execute all queries logged to this connection during the closure as a transaction in the database.

Type parameters
- T
Parameters
- closure: () => Awaitable<T>
  - - (): Awaitable<T>
    - Returns Awaitable<T>
Returns Awaitable<T>

Abstract close

close(): Promise<void>

- Defined in src/orm/connection/Connection.ts:63
Close the connection.

Returns Promise<void>

Promise

Protected container

container(): Container

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

Returns Container

Abstract dialect

dialect(): SQLDialect

- Defined in src/orm/connection/Connection.ts:44
Returns SQLDialect

getBoundMethod

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

Inherited from AppClass.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

Abstract init

init(): Promise<void>

- Defined in src/orm/connection/Connection.ts:50
Open the connection.

Returns Promise<void>

Promise

Protected make

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

Inherited from AppClass.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

Abstract query

query(query: string): Promise<QueryResult>

- Defined in src/orm/connection/Connection.ts:57
Execute an SQL query and get the result.

Parameters
- query: string
Returns Promise<QueryResult>

Promise

Protected queryExecuted

queryExecuted(query: string): Promise<void>

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

Parameters
- query: string
Returns Promise<void>

Abstract schema

schema(name?: string): Schema

- Defined in src/orm/connection/Connection.ts:69
Get a Schema on this connection.

Parameters
- Optional name: string
Returns Schema

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

Extollo is a free & libre application framework in TypeScript.