Skip to main content

Version: Next

Configuration <D, EM>

Holds and validates all ORM configuration options, providing access to drivers, loggers, cache adapters, and other services.

Constructors

constructor

new Configuration<D, EM>(options, validate): Configuration<D, EM>

Parameters
- options: Partial<Options<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>, (string | EntitySchema<any, never, EntityCtor<any>> | EntityClass<Partial<any>>)[]>>
- validate: boolean = true
Returns Configuration<D, EM>

Methods

get

get<T, U>(key, defaultValue): U

Gets specific configuration option. Falls back to specified defaultValue if provided.
Parameters
- key: T
- optionaldefaultValue: U
Returns U

getAll

getAll(): Options<D, EM, (string | EntitySchema<any, never, EntityCtor<any>> | EntityClass<Partial<any>>)[]>

Returns all configuration options.
Returns Options<D, EM, (string | EntitySchema<any, never, EntityCtor<any>> | EntityClass<Partial<any>>)[]>

getCachedService

getCachedService<T>(cls, ...args): InstanceType<T>

Creates instance of given service and caches it.
Parameters
- cls: T
- rest...args: ConstructorParameters<T>
Returns InstanceType<T>

getComparator

getComparator(metadata): EntityComparator

Gets instance of Comparator. (cached)
Parameters
- metadata: MetadataStorage
Returns EntityComparator

getDataloaderType

getDataloaderType(): DataloaderType

Returns the configured dataloader type, normalizing boolean values.
Returns DataloaderType

getDriver

getDriver(): D

Gets current database driver instance.
Returns D

getExtension

getExtension<T>(name): undefined | T

Returns a previously registered extension by name, initializing it on first access.
Parameters
- name: string
Returns undefined | T

getHydrator

getHydrator(metadata): IHydrator

Gets instance of Hydrator. (cached)
Parameters
- metadata: MetadataStorage
Returns IHydrator

getLogger

getLogger(): Logger

Gets Logger instance.
Returns Logger

getMetadataCacheAdapter

getMetadataCacheAdapter(): SyncCacheAdapter

Gets instance of metadata CacheAdapter. (cached)
Returns SyncCacheAdapter

getMetadataProvider

getMetadataProvider(): MetadataProvider

Gets instance of MetadataProvider. (cached)
Returns MetadataProvider

getNamingStrategy

getNamingStrategy(): NamingStrategy

Gets instance of NamingStrategy. (cached)
Returns NamingStrategy

getPlatform

getPlatform(): ReturnType<D[getPlatform]>

Returns the database platform instance.
Returns ReturnType<D[getPlatform]>

getRepositoryClass

getRepositoryClass(repository): undefined | EntityClass<EntityRepository<any>>

Gets EntityRepository class to be instantiated.
Parameters
- repository: () => EntityClass<EntityRepository<Partial<any>>>
Returns undefined | EntityClass<EntityRepository<any>>

getResultCacheAdapter

getResultCacheAdapter(): CacheAdapter

Gets instance of CacheAdapter for result cache. (cached)
Returns CacheAdapter

getSchema

getSchema(skipDefaultSchema): undefined | string

Returns the configured schema name, optionally skipping the platform's default schema.
Parameters
- skipDefaultSchema: boolean = false
Returns undefined | string

getSlowQueryLogger

getSlowQueryLogger(): Logger

Gets the logger instance for slow queries. Falls back to the main logger if no custom slow query logger factory is configured.
Returns Logger

registerExtension

registerExtension(name, cb): void

Registers a lazily-initialized extension by name.
Parameters
- name: string
- cb: () => unknown
Returns void

reset

reset<T>(key): void

Resets the configuration to its default value
Parameters
- key: T
Returns void

resetServiceCache

resetServiceCache(): void

Clears the cached service instances, forcing re-creation on next access.
Returns void

set

set<T, U>(key, value): void

Overrides specified configuration value.
Parameters
- key: T
- value: U
Returns void