Class RedisDatabaseConnector

Redis database connector implementation.

See

https://redis.io/ - Redis documentation
https://github.com/redis/node-redis - Node Redis client

Implements

DatabaseConnector

Constructors

constructor

new RedisDatabaseConnector(
config: Config<RedisDatabaseConfig>,
logger: Logger,
): RedisDatabaseConnector
Creates a new connector instance.
Parameters
- config: Config<RedisDatabaseConfig>
  The database config instance
- logger: Logger
  The logger instance
Returns RedisDatabaseConnector
- Defined in packages/database/src/redis-database-connector.ts:45

Methods

close

close(): Promise<void>
Closes the database connection.

Returns Promise<void>
A promise that resolves when the connection is closed
Implementation of DatabaseConnector.close
- Defined in packages/database/src/redis-database-connector.ts:78

connect

connect(): Promise<void>
Establishes the database connection.

Returns Promise<void>
A promise that resolves when the connection is established
Implementation of DatabaseConnector.connect
- Defined in packages/database/src/redis-database-connector.ts:72

getConnection

getConnection<T>(): T
Retrieves the underlying connection object.

This method uses a type assertion to return the connection as the requested type. It is the caller's responsibility to ensure the correct type is used.
Type Parameters
- T
  The expected type of the connection
Returns T
The database connection cast to type T
Implementation of DatabaseConnector.getConnection
- Defined in packages/database/src/redis-database-connector.ts:68

`Static`register

register(container: DIContainer): void
Register connector instance as singleton in DI container.
Parameters
- container: DIContainer
  DI container to register in
Returns void
- Defined in packages/database/src/redis-database-connector.ts:27