DatabaseManager | @fiquu/database-manager-mongoose

Hierarchy

DatabaseManager

Index

Properties

clients

Methods

Properties

clients

clients: DatabaseClientsMap

Gets a database client by name.

returns: The database clients map.

Methods

add

add(name: string, config: DatabaseClientConfig): void

- Defined in index.ts:63
Adds a named database client with the provided config.

Parameters
- name: string
  
  The client name.
- config: DatabaseClientConfig
  
  The client config.
Returns void

The created client.

connect

connect(name: string): Promise<Connection>

- Defined in index.ts:72
Connects a named client to the database.

Parameters
- name: string
  
  The client name.
Returns Promise<Connection>

The current client connection.

connection

connection(name: string): Connection

- Defined in index.ts:53
Retrieves a client's connection.

Parameters
- name: string
  
  The client name.
Returns Connection

The client's connection if any.

disconnect

disconnect(name: string, force?: boolean): Promise<void>

- Defined in index.ts:82
Disconnects a named client from the database.

Parameters
- name: string
  
  The client name.
- Optional force: boolean
  
  Whether to force disconnection.
Returns Promise<void>

A promise to the disconnection.

disconnectAll

disconnectAll(force?: boolean): Promise<void>

- Defined in index.ts:89
Disconnects all clients from their databases.

Parameters
- Optional force: boolean
  
  Whether to force disconnection.
Returns Promise<void>

Generated using TypeDoc