Configuration <D>
Index
Constructors
constructor
Type parameters
- D: IDatabaseDriver<Connection, D> = IDatabaseDriver<Connection>
Parameters
options: Options<IDatabaseDriver<Connection>>
validate: boolean = true
Returns Configuration<D>
Properties
staticreadonlyDEFAULTS
staticreadonlyPLATFORMS
Type declaration
better-sqlite: { className: string; module: () => any }
className: string
module: () => any
Returns any
mariadb: { className: string; module: () => any }
className: string
module: () => any
Returns any
mongo: { className: string; module: () => any }
className: string
module: () => any
Returns any
mysql: { className: string; module: () => any }
className: string
module: () => any
Returns any
postgresql: { className: string; module: () => any }
className: string
module: () => any
Returns any
sqlite: { className: string; module: () => any }
className: string
module: () => any
Returns any
Methods
get
Type parameters
- T: keyof MikroORMOptions<D>
- U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntitySchema<any, never> | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; disableDynamicFileAccess?: boolean; getMappedType?: (type: string, platform: Platform) => undefined | Type<unknown, unknown>; requireEntitiesArray?: boolean; warnWhenNoEntities?: boolean } | new (config: Configuration<IDatabaseDriver<Connection>>) => D | new () => NamingStrategy | (string | Constructor<Partial<any>>)[] | HydratorConstructor | Constructor | Partial<ConnectionOptions>[] | (name: string) => undefined | EntityManager<IDatabaseDriver<Connection>> | (message: string) => void | (options: LoggerOptions) => Logger | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | LoggerNamespace[] | MigrationsOptions | { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string } | { bidirectionalRelations?: boolean; entitySchema?: boolean; esmImport?: boolean; identifiedReferences?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; enabled?: boolean; options?: Dictionary; pretty?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; expiration?: number; options?: Dictionary } | new (config: Configuration<IDatabaseDriver<Connection>>) => MetadataProvider | SeederOptions | (id: string) => Promise<unknown> | () => MaybePromise<string> | MaybePromise<DynamicPassword> | PoolConfig
Parameters
key: T
optionaldefaultValue: U
Returns U
getAll
Returns MikroORMOptions<D>
getCacheAdapter
Gets instance of CacheAdapter. (cached)
Returns CacheAdapter
getCachedService
Creates instance of given service and caches it.
Type parameters
- T: new (...args: any[]) => InstanceType<T>
Parameters
cls: T
rest...args: ConstructorParameters<T>
Returns InstanceType<T>
getClientUrl
Gets current client URL (connection string).
Parameters
hidePassword: boolean = false
Returns string
getComparator
Gets instance of Comparator. (cached)
Parameters
metadata: MetadataStorage
Returns EntityComparator
getDriver
Gets current database driver instance.
Returns D
getExtension
Type parameters
- T
Parameters
name: string
Returns undefined | T
getHydrator
Gets instance of Hydrator. (cached)
Parameters
metadata: MetadataStorage
Returns IHydrator
getLogger
Gets Logger instance.
Returns Logger
getMetadataProvider
Gets instance of MetadataProvider. (cached)
Returns MetadataProvider
getNamingStrategy
Gets instance of NamingStrategy. (cached)
Returns NamingStrategy
getRepositoryClass
Gets EntityRepository class to be instantiated.
Parameters
customRepository: () => Constructor<EntityRepository<Partial<any>>>
Returns undefined | Constructor
getResultCacheAdapter
Gets instance of CacheAdapter for result cache. (cached)
Returns CacheAdapter
registerExtension
Parameters
name: string
instance: unknown
Returns void
reset
Resets the configuration to its default value
Type parameters
- T: keyof MikroORMOptions<D>
- U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntitySchema<any, never> | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; disableDynamicFileAccess?: boolean; getMappedType?: (type: string, platform: Platform) => undefined | Type<unknown, unknown>; requireEntitiesArray?: boolean; warnWhenNoEntities?: boolean } | new (config: Configuration<IDatabaseDriver<Connection>>) => D | new () => NamingStrategy | (string | Constructor<Partial<any>>)[] | HydratorConstructor | Constructor | Partial<ConnectionOptions>[] | (name: string) => undefined | EntityManager<IDatabaseDriver<Connection>> | (message: string) => void | (options: LoggerOptions) => Logger | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | LoggerNamespace[] | MigrationsOptions | { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string } | { bidirectionalRelations?: boolean; entitySchema?: boolean; esmImport?: boolean; identifiedReferences?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; enabled?: boolean; options?: Dictionary; pretty?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; expiration?: number; options?: Dictionary } | new (config: Configuration<IDatabaseDriver<Connection>>) => MetadataProvider | SeederOptions | (id: string) => Promise<unknown> | () => MaybePromise<string> | MaybePromise<DynamicPassword> | PoolConfig
Parameters
key: T
Returns void
resetServiceCache
Returns void
set
Overrides specified configuration value.
Type parameters
- T: keyof MikroORMOptions<D>
- U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntitySchema<any, never> | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; disableDynamicFileAccess?: boolean; getMappedType?: (type: string, platform: Platform) => undefined | Type<unknown, unknown>; requireEntitiesArray?: boolean; warnWhenNoEntities?: boolean } | new (config: Configuration<IDatabaseDriver<Connection>>) => D | new () => NamingStrategy | (string | Constructor<Partial<any>>)[] | HydratorConstructor | Constructor | Partial<ConnectionOptions>[] | (name: string) => undefined | EntityManager<IDatabaseDriver<Connection>> | (message: string) => void | (options: LoggerOptions) => Logger | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error | LoggerNamespace[] | MigrationsOptions | { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string } | { bidirectionalRelations?: boolean; entitySchema?: boolean; esmImport?: boolean; identifiedReferences?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; enabled?: boolean; options?: Dictionary; pretty?: boolean } | { adapter?: new (...params: any[]) => CacheAdapter; expiration?: number; options?: Dictionary } | new (config: Configuration<IDatabaseDriver<Connection>>) => MetadataProvider | SeederOptions | (id: string) => Promise<unknown> | () => MaybePromise<string> | MaybePromise<DynamicPassword> | PoolConfig
Parameters
key: T
value: U
Returns void
Gets specific configuration option. Falls back to specified
defaultValue
if provided.