Class DatabaseService

A singleton, non-unit service that stores and retrieves database connections by name.

Hierarchy

AppClass
- DatabaseService

Index

Constructors

constructor

Properties

Accessors

appClassApplication

Methods

Constructors

constructor

new DatabaseService(): DatabaseService

Inherited from AppClass.constructor

Returns DatabaseService

Properties

Protected Readonly connections

connections: {} = {}

Mapping of connection name -> connection instance for connections registered with this service.

Type declaration

[key: string]: Connection

Protected logging

logging: Logging

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

Protected container

container(): Container

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

Returns Container

get

get(name?: string): Connection

- Defined in src/orm/DatabaseService.ts:44
Get a connection instance by its name. Throws if none exists.

Parameters
- name: string = 'default'
Returns Connection

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

has

has(name: string): boolean

- Defined in src/orm/DatabaseService.ts:36
Returns true if a connection is registered with the given name.

Parameters
- name: string
Returns boolean

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

names

names(): string[]

- Defined in src/orm/DatabaseService.ts:55
Return an array of the names of all registered connections.

Returns string[]

register

register(name: string, connection: Connection): DatabaseService

- Defined in src/orm/DatabaseService.ts:23
Register a new connection instance by name.

Parameters
- name: string
- connection: Connection
Returns DatabaseService

uniqueName

uniqueName(): string

- Defined in src/orm/DatabaseService.ts:60
Get a guaranteed-unique connection name.

Returns string

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

Extollo is a free & libre application framework in TypeScript.