Class Connection`Abstract`

Abstract base class for database connections.

Abstract

Hierarchy

AppClass
- Connection
  - PostgresConnection
  - SQLiteConnection

Index

Constructors

Properties

bus config name

Accessors

appClassApplication

Methods

app asTransaction close container dialect getBoundMethod init make normalizeRow query queryExecuted schema

Constructors

constructor

new Connection(name: string, config?: any): Connection
Parameters
- name: string
  
  The name of this connection
  
  Type
  string
- config: any = {}
  
  This connection's config object
Returns Connection
Overrides AppClass.constructor
- Defined in src/orm/connection/Connection.ts:31

Properties

`Protected` `Readonly` bus

bus: Bus<Event>

`Readonly` config

config: any = {}

This connection's config object

`Readonly` name

name: string

The name of this connection

Accessors

`Private` appClassApplication

get appClassApplication(): Application
The global application instance.

Returns Application
Inherited from AppClass.appClassApplication
- Defined in src/lifecycle/AppClass.ts:31

Methods

`Protected` app

app(): Application
Get the global Application.

Returns Application
Inherited from AppClass.app
- Defined in src/lifecycle/AppClass.ts:36

`Abstract` asTransaction

asTransaction<T>(closure: (() => Awaitable<T>)): Awaitable<T>
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>
- Defined in src/orm/connection/Connection.ts:77

`Abstract` close

close(): Promise<void>
Close the connection.

Returns
Promise

Returns Promise<void>
- Defined in src/orm/connection/Connection.ts:64

`Protected` container

container(): Container
Get the global Container.

Returns Container
Inherited from AppClass.container
- Defined in src/lifecycle/AppClass.ts:41

`Abstract` dialect

dialect(): SQLDialect
Returns SQLDialect
- Defined in src/orm/connection/Connection.ts:45

getBoundMethod

getBoundMethod(methodName: string): ((...args: any[]) => any)
Get the method with the given name from this class, bound to this class.

Returns
function
Parameters
- methodName: string
Returns ((...args: any[]) => any)
- - (...args: any[]): any
  - Get the method with the given name from this class, bound to this class.
    
    Returns
    function
    Parameters
    - Rest ...args: any[]
    Returns any
Inherited from AppClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55

`Abstract` init

init(): Promise<void>
Open the connection.

Returns
Promise

Returns Promise<void>
- Defined in src/orm/connection/Connection.ts:51

`Protected` make

make<T>(target: any, ...parameters: any[]): T
Call the make() method on the global container.
Type Parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T
Inherited from AppClass.make
- Defined in src/lifecycle/AppClass.ts:46

normalizeRow

normalizeRow(row: QueryRow, fields: Collection<ModelField>): QueryRow
Normalize a query row before it is used by the framework. This helps account for differences in return values from the dialects.
Parameters
- row: QueryRow
- fields: Collection<ModelField>
Returns QueryRow
- Defined in src/orm/connection/Connection.ts:86

`Abstract` query

query(query: string): Promise<QueryResult>
Execute an SQL query and get the result.

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

`Protected` queryExecuted

queryExecuted(query: string): Promise<void>
Protected
Fire a QueryExecutedEvent for the given query string.
Parameters
- query: string
Returns Promise<void>
- Defined in src/orm/connection/Connection.ts:95

`Abstract` schema

schema(name?: string): Schema
Get a Schema on this connection.
Parameters
- Optional name: string
Returns Schema
- Defined in src/orm/connection/Connection.ts:70