Class DatabaseRegistry

Class to register a new database and resolve a schema/type to a database.

Hierarchy

DatabaseRegistry

Constructors

constructor

new DatabaseRegistry(injectorContext: InjectorContext, databaseTypes?: {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[], migrateOnStartup?: boolean): DatabaseRegistry
Parameters
- injectorContext: InjectorContext
- databaseTypes: {
  classType: ClassType<Database<any>>;
  module: InjectorModule<any, InjectorModule<any, any>>;
  }[] = []
- migrateOnStartup: boolean = false
Returns DatabaseRegistry
- Defined in packages/orm/src/database-registry.ts:27

Properties

`Protected` databaseMap

databaseMap: Map<ClassType<any>, Database<any>> = ...

`Protected` databaseNameMap

databaseNameMap: Map<string, Database<any>> = ...

`Protected` databaseOptions

databaseOptions: Map<ClassType<any>, {
migrateOnStartup?: boolean;
}> = ...

`Protected` `Readonly` databaseTypes

databaseTypes: {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[] = []

`Protected` databases

databases: Database<any>[] = []

`Protected` initialized

initialized: boolean = false

`Protected` injectorContext

injectorContext: InjectorContext

`Protected` migrateOnStartup

migrateOnStartup: boolean = false

Methods

addDatabase

addDatabase(database: ClassType<any>, options?: {
migrateOnStartup?: boolean;
}, module: InjectorModule<any, InjectorModule<any, any>>): void
Parameters
- database: ClassType<any>
- options: {
  migrateOnStartup?: boolean;
  } = {}
  - Optional migrateOnStartup?: boolean
- module: InjectorModule<any, InjectorModule<any, any>>
Returns void
- Defined in packages/orm/src/database-registry.ts:83

getDatabase

getDatabase(classType: ClassType<any>): undefined | Database<any>
Parameters
- classType: ClassType<any>
Returns undefined | Database<any>
- Defined in packages/orm/src/database-registry.ts:152

getDatabaseByName

getDatabaseByName(name: string): undefined | Database<any>
Parameters
- name: string
Returns undefined | Database<any>
- Defined in packages/orm/src/database-registry.ts:157

getDatabaseForEntity

getDatabaseForEntity(entity: ClassType<any> | ReflectionClass<any>): Database<any>
Parameters
- entity: ClassType<any> | ReflectionClass<any>
Returns Database<any>
- Defined in packages/orm/src/database-registry.ts:140

getDatabaseTypes

getDatabaseTypes(): {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[]
Returns {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[]
- Defined in packages/orm/src/database-registry.ts:102

getDatabases

getDatabases(): Database<any>[]
Returns Database<any>[]
- Defined in packages/orm/src/database-registry.ts:147

init

init(): void
Returns void
- Defined in packages/orm/src/database-registry.ts:113

isMigrateOnStartup

isMigrateOnStartup(database: ClassType<any>): boolean
Parameters
- database: ClassType<any>
Returns boolean
- Defined in packages/orm/src/database-registry.ts:106

onShutDown

onShutDown(): void
Returns void
- Defined in packages/orm/src/database-registry.ts:77

readDatabase

readDatabase(paths: string[]): void
Reads database from a path. Imports the given paths and looks for instantiated Database classes. All instantiated Database classes will be returned.

This is an alternative way to find Database and entities compared to a config file driven way.
Parameters
- paths: string[]
Returns void
- Defined in packages/orm/src/database-registry.ts:46

removeDatabase

removeDatabase(database: ClassType<any>): void
Parameters
- database: ClassType<any>
Returns void
- Defined in packages/orm/src/database-registry.ts:96

setMigrateOnStartup

setMigrateOnStartup(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/orm/src/database-registry.ts:35

Class DatabaseRegistry

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

injectorContext: InjectorContext

databaseTypes: { classType: ClassType<Database<any>>; module: InjectorModule<any, InjectorModule<any, any>>; }[] = []

migrateOnStartup: boolean = false

Returns DatabaseRegistry

Properties

Protected databaseMap

Protected databaseNameMap

Protected databaseOptions

Protected Readonly databaseTypes

Protected databases

Protected initialized

Protected injectorContext

Protected migrateOnStartup

Methods

addDatabase

Parameters

database: ClassType<any>

options: { migrateOnStartup?: boolean; } = {}

Optional migrateOnStartup?: boolean

module: InjectorModule<any, InjectorModule<any, any>>

Returns void

getDatabase

Parameters

classType: ClassType<any>

Returns undefined | Database<any>

getDatabaseByName

Parameters

name: string

Returns undefined | Database<any>

getDatabaseForEntity

Parameters

entity: ClassType<any> | ReflectionClass<any>

Returns Database<any>

getDatabaseTypes

Returns { classType: ClassType<Database<any>>; module: InjectorModule<any, InjectorModule<any, any>>; }[]

getDatabases

Returns Database<any>[]

init

Returns void

isMigrateOnStartup

Parameters

database: ClassType<any>

Returns boolean

onShutDown

Returns void

readDatabase

Parameters

paths: string[]

Returns void

removeDatabase

Parameters

database: ClassType<any>

Returns void

setMigrateOnStartup

Parameters

v: boolean

Returns void

Settings

Member Visibility

Theme

databaseTypes: {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[] = []

`Protected` databaseMap

`Protected` databaseNameMap

`Protected` databaseOptions

`Protected` `Readonly` databaseTypes

`Protected` databases

`Protected` initialized

`Protected` injectorContext

`Protected` migrateOnStartup

options: {
migrateOnStartup?: boolean;
} = {}

`Optional` migrateOnStartup?: boolean

Returns {
classType: ClassType<Database<any>>;
module: InjectorModule<any, InjectorModule<any, any>>;
}[]