Interface ConnectionManagerContract

Connection manager to manage database connections.

interface ConnectionManagerContract {
    connections: Map<string, ConnectionNode>;
    add(connectionName, config): void;
    close(connectionName): Promise<void>;
    closeAll(): Promise<void>;
    connect(connectionName): void;
    get(connectionName): ConnectionNode;
    has(connectionName): boolean;
    isConnected(connectionName): boolean;
}

Index

Properties

Methods

add close closeAll connect get has isConnected

Properties

connections

connections: Map<string, ConnectionNode>

List of registered connections.

Methods

add

add(connectionName, config): void
Add a new connection.
Parameters
- connectionName: string
- config: MongodbConnectionConfig
Returns void
- Defined in adonis-typings/database.ts:77

close

close(connectionName): Promise<void>
Close a connection.
Parameters
- connectionName: string
Returns Promise<void>
- Defined in adonis-typings/database.ts:102

closeAll

closeAll(): Promise<void>
Close all managed connections.

Returns Promise<void>
- Defined in adonis-typings/database.ts:107

connect

connect(connectionName): void
Initiate a connection. It is a noop if the connection is already initiated.
Parameters
- connectionName: string
Returns void
- Defined in adonis-typings/database.ts:82

get

get(connectionName): ConnectionNode
Get a connection.
Parameters
- connectionName: string
Returns ConnectionNode
- Defined in adonis-typings/database.ts:87

has

has(connectionName): boolean
Returns whether the connection is managed by the manager.
Parameters
- connectionName: string
Returns boolean
- Defined in adonis-typings/database.ts:92

isConnected

isConnected(connectionName): boolean
Returns whether the connection is connected.
Parameters
- connectionName: string
Returns boolean
- Defined in adonis-typings/database.ts:97