DatabaseManager

Description

Database connection management factories for different database types.

Classes

CockRoachDBManagerFactory

Defined in: packages/core/src/core/databasemanager/cockroachdb/CockroachDBManagerFactory.ts:36

CockroachDB database manager factory using TypeORM.

Supports both URL-based and connection object configuration.

Example

// URL-based connection
const factory = new CockRoachDBManagerFactory(
  { url: 'postgresql://user:pass@host:26257/db?sslmode=verify-full' },
  [UserEntity, OrderEntity]
);

// Connection object
const factory = new CockRoachDBManagerFactory(
  { host: 'localhost', port: 26257, username: 'root', database: 'mydb' },
  [UserEntity]
);

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new CockRoachDBManagerFactory(
   connection, 
   entities?, 
   synchronize?, 
   logging?): CockRoachDBManagerFactory;

Defined in: packages/core/src/core/databasemanager/cockroachdb/CockroachDBManagerFactory.ts:46

Parameters

connection

CockroachUrl | CockroachConnection

entities?

any[] = []

synchronize?

boolean = true

logging?

boolean = false

Returns

CockRoachDBManagerFactory

Methods

dbConnection()

dbConnection(): void;

Defined in: packages/core/src/core/databasemanager/cockroachdb/CockroachDBManagerFactory.ts:59

Initialize the database connection.

Returns

void

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<{
}>;

Defined in: packages/core/src/core/databasemanager/cockroachdb/CockroachDBManagerFactory.ts:61

Get or create a database connection.

Returns

Promise<{ }>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): Promise<boolean>;

Defined in: packages/core/src/core/databasemanager/cockroachdb/CockroachDBManagerFactory.ts:109

Get the current connection status.

Returns

Promise<boolean>

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

---

DummyDBManagerFactory

Defined in: packages/core/src/core/databasemanager/DummyDBManagerFactory.ts:11

Dummy database manager factory for testing purposes.

Deprecated

This class will be removed in a future version. Use PostgresDBManagerFactory or CockRoachDBManagerFactory instead.

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new DummyDBManagerFactory(connection): DummyDBManagerFactory;

Defined in: packages/core/src/core/databasemanager/DummyDBManagerFactory.ts:14

Parameters

connection

string

Returns

DummyDBManagerFactory

Methods

dbConnection()

dbConnection(): void;

Defined in: packages/core/src/core/databasemanager/DummyDBManagerFactory.ts:20

Initialize the database connection.

Returns

void

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<{
}>;

Defined in: packages/core/src/core/databasemanager/DummyDBManagerFactory.ts:22

Get or create a database connection.

Returns

Promise<{ }>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): Promise<boolean>;

Defined in: packages/core/src/core/databasemanager/DummyDBManagerFactory.ts:26

Get the current connection status.

Returns

Promise<boolean>

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

---

EmbeddedMongoDBManagerFactory

Defined in: packages/core/src/core/databasemanager/EmbeddedMongoDBManagerFactory.ts:13

Embedded MongoDB manager factory for testing purposes.

Deprecated

This class will be removed in a future version. Use PostgresDBManagerFactory or CockRoachDBManagerFactory instead.

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new EmbeddedMongoDBManagerFactory(): EmbeddedMongoDBManagerFactory;

Defined in: packages/core/src/core/databasemanager/EmbeddedMongoDBManagerFactory.ts:17

Returns

EmbeddedMongoDBManagerFactory

Methods

dbConnection()

dbConnection(): Promise<void>;

Defined in: packages/core/src/core/databasemanager/EmbeddedMongoDBManagerFactory.ts:24

Initialize the database connection.

Returns

Promise<void>

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<any>;

Defined in: packages/core/src/core/databasemanager/EmbeddedMongoDBManagerFactory.ts:32

Get or create a database connection.

Returns

Promise<any>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): void;

Defined in: packages/core/src/core/databasemanager/EmbeddedMongoDBManagerFactory.ts:20

Get the current connection status.

Returns

void

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

---

MongoDBEntityManagerFactory

Defined in: packages/core/src/core/databasemanager/MongoDBEntityManagerFactory.ts:13

MongoDB native driver manager factory.

Deprecated

This class will be removed in a future version. Use PostgresDBManagerFactory or CockRoachDBManagerFactory instead.

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new MongoDBEntityManagerFactory(): MongoDBEntityManagerFactory;

Defined in: packages/core/src/core/databasemanager/MongoDBEntityManagerFactory.ts:19

Returns

MongoDBEntityManagerFactory

Methods

dbConnection()

dbConnection(): Promise<MongoClient>;

Defined in: packages/core/src/core/databasemanager/MongoDBEntityManagerFactory.ts:30

Initialize the database connection.

Returns

Promise<MongoClient>

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<MongoClient>;

Defined in: packages/core/src/core/databasemanager/MongoDBEntityManagerFactory.ts:36

Get or create a database connection.

Returns

Promise<MongoClient>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): void;

Defined in: packages/core/src/core/databasemanager/MongoDBEntityManagerFactory.ts:26

Get the current connection status.

Returns

void

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

---

MongooseDBManagerFactory

Defined in: packages/core/src/core/databasemanager/MongooseDBManagerFactory.ts:16

Mongoose database manager factory for MongoDB connections.

Deprecated

This class will be removed in a future version. Use PostgresDBManagerFactory or CockRoachDBManagerFactory instead.

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new MongooseDBManagerFactory(
   mongoURI, 
   databaseName, 
   loggerFactory): MongooseDBManagerFactory;

Defined in: packages/core/src/core/databasemanager/MongooseDBManagerFactory.ts:26

Parameters

mongoURI

string

databaseName

string

loggerFactory

ILoggerFactory

Returns

MongooseDBManagerFactory

Methods

dbConnection()

dbConnection(): void;

Defined in: packages/core/src/core/databasemanager/MongooseDBManagerFactory.ts:38

Initialize the database connection.

Returns

void

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<Mongoose>;

Defined in: packages/core/src/core/databasemanager/MongooseDBManagerFactory.ts:40

Get or create a database connection.

Returns

Promise<Mongoose>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): Promise<any>;

Defined in: packages/core/src/core/databasemanager/MongooseDBManagerFactory.ts:60

Get the current connection status.

Returns

Promise<any>

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

---

PostgresDBManagerFactory

Defined in: packages/core/src/core/databasemanager/postgres/PostgresDBManagerFactory.ts:38

PostgreSQL database manager factory using TypeORM.

Supports both URL-based and connection object configuration.

Example

// URL-based connection
const factory = new PostgresDBManagerFactory(
  { url: 'postgresql://user:pass@host:5432/db' },
  [UserEntity, OrderEntity]
);

// Connection object
const factory = new PostgresDBManagerFactory(
  { host: 'localhost', port: 5432, username: 'postgres', database: 'mydb' },
  [UserEntity],
  true,  // synchronize
  true   // logging
);

Implements

• IDatabaseManagerFactory

Constructors

Constructor

new PostgresDBManagerFactory(
   connection, 
   entities?, 
   synchronize?, 
   logging?): PostgresDBManagerFactory;

Defined in: packages/core/src/core/databasemanager/postgres/PostgresDBManagerFactory.ts:50

Parameters

connection

PostgresUrl | PostgresConnection

entities?

any[] = []

synchronize?

boolean = true

logging?

boolean = false

Returns

PostgresDBManagerFactory

Methods

dbConnection()

dbConnection(): void;

Defined in: packages/core/src/core/databasemanager/postgres/PostgresDBManagerFactory.ts:63

Initialize the database connection.

Returns

void

Implementation of

IDatabaseManagerFactory.dbConnection

getConnection()

getConnection(): Promise<{
}>;

Defined in: packages/core/src/core/databasemanager/postgres/PostgresDBManagerFactory.ts:65

Get or create a database connection.

Returns

Promise<{ }>

The database connection/manager instance

Implementation of

IDatabaseManagerFactory.getConnection

getStatus()

getStatus(): Promise<boolean>;

Defined in: packages/core/src/core/databasemanager/postgres/PostgresDBManagerFactory.ts:109

Get the current connection status.

Returns

Promise<boolean>

Connection status

Implementation of

IDatabaseManagerFactory.getStatus

Interfaces

IDatabaseManagerFactory

Defined in: packages/core/src/core/databasemanager/types.ts:5

Interface for database manager factories. Implementations provide database connection management for different database types.

Methods

dbConnection()

dbConnection(): void | Promise<unknown> | Promise<void>;

Defined in: packages/core/src/core/databasemanager/types.ts:9

Initialize the database connection.

Returns

void | Promise<unknown> | Promise<void>

getConnection()

getConnection(): Promise<unknown>;

Defined in: packages/core/src/core/databasemanager/types.ts:15

Get or create a database connection.

Returns

Promise<unknown>

The database connection/manager instance

getStatus()

getStatus(): unknown;

Defined in: packages/core/src/core/databasemanager/types.ts:21

Get the current connection status.

Returns

unknown

Connection status