Class AbstractDatabasePool<TPool, TPoolClient, TPayload>`Abstract`

Abstract class representing a database pool.

Type Parameters

TPool
The type of the pool.
TPoolClient
The type of the pool client.
TPayload
The type of the job payload.

Index

Constructors

Properties

Methods

close getClient

Constructors

constructor

new AbstractDatabasePool<TPool, TPoolClient, TPayload>(pool): AbstractDatabasePool<TPool, TPoolClient, TPayload>
Creates an instance of AbstractDatabasePool.
Type Parameters
- TPool
- TPoolClient
- TPayload
Parameters
- pool: TPool
  The underlying pool instance.
Returns AbstractDatabasePool<TPool, TPoolClient, TPayload>
- Defined in packages/core/src/AbstractDatabasePool.ts:21

Properties

`Protected` pool

pool: TPool

The underlying pool instance.

Methods

`Abstract` close

close(): Promise<void>
Closes the pool and releases all resources.

Returns Promise<void>
Abstract
Example
```
await pool.close();
```
- Defined in packages/core/src/AbstractDatabasePool.ts:42

`Abstract` getClient

getClient(queueName): Promise<AbstractDatabasePoolClient<TPoolClient, TPayload>>
Gets a client from the pool for the specified queue.
Parameters
- queueName: string
  The name of the queue.
Returns Promise<AbstractDatabasePoolClient<TPoolClient, TPayload>>
- The pool client.
Abstract
Example
```
const client = await pool.getClient('Queue');
```
- Defined in packages/core/src/AbstractDatabasePool.ts:33