Skip to main content
Version: 5.9

Configuration <D>

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Configuration<D>(options: Options<IDatabaseDriver<Connection>>, validate?: boolean): Configuration<D>

  • Type parameters

    • D: IDatabaseDriver<Connection, D> = IDatabaseDriver<Connection>

    Parameters

    • options: Options<IDatabaseDriver<Connection>>
    • validate: boolean = true

    Returns Configuration<D>

Properties

staticreadonlyDEFAULTS

DEFAULTS: MikroORMOptions<IDatabaseDriver<Connection>> = ...

staticreadonlyPLATFORMS

PLATFORMS: { better-sqlite: { className: string; module: () => any }; mariadb: { className: string; module: () => any }; mongo: { className: string; module: () => any }; mysql: { className: string; module: () => any }; postgresql: { className: string; module: () => any }; sqlite: { className: string; module: () => any } } = ...

Type declaration

  • better-sqlite: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

  • mariadb: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

  • mongo: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

  • mysql: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

  • postgresql: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

  • sqlite: { className: string; module: () => any }
    • className: string
    • module: () => any
        • (): any

        • Returns any

Methods

get

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

  • Gets specific configuration option. Falls back to specified defaultValue if provided.

    Type parameters

    • T: keyof MikroORMOptions<D>
    • U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; checkDuplicateEntities?: boolean; checkDuplicateTableNames?: 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; global?: number | boolean | [string, 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

  • getAll(): MikroORMOptions<D>

  • Returns MikroORMOptions<D>

getCacheAdapter

  • getCacheAdapter(): CacheAdapter

  • Gets instance of CacheAdapter. (cached)

    Returns CacheAdapter

getCachedService

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

  • 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

  • getClientUrl(hidePassword?: boolean): string

  • Gets current client URL (connection string).

    Parameters

    • hidePassword: boolean = false

    Returns string

getComparator

  • getComparator(metadata: MetadataStorage): EntityComparator

  • Gets instance of Comparator. (cached)

    Parameters

    • metadata: MetadataStorage

    Returns EntityComparator

getDriver

  • getDriver(): D

  • Gets current database driver instance.

    Returns D

getExtension

  • getExtension<T>(name: string): undefined | T

  • Type parameters

    • T

    Parameters

    • name: string

    Returns undefined | T

getHydrator

  • getHydrator(metadata: MetadataStorage): IHydrator

  • Gets instance of Hydrator. (cached)

    Parameters

    • metadata: MetadataStorage

    Returns IHydrator

getLogger

  • getLogger(): Logger

  • Gets Logger instance.

    Returns Logger

getMetadataProvider

  • getMetadataProvider(): MetadataProvider

  • Gets instance of MetadataProvider. (cached)

    Returns MetadataProvider

getNamingStrategy

  • getNamingStrategy(): NamingStrategy

  • Gets instance of NamingStrategy. (cached)

    Returns NamingStrategy

getRepositoryClass

  • getRepositoryClass(customRepository: () => Constructor<EntityRepository<Partial<any>>>): undefined | Constructor

  • Gets EntityRepository class to be instantiated.

    Parameters

    • customRepository: () => Constructor<EntityRepository<Partial<any>>>

      Returns undefined | Constructor

    getResultCacheAdapter

    • getResultCacheAdapter(): CacheAdapter

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

      Returns CacheAdapter

    registerExtension

    • registerExtension(name: string, instance: unknown): void

    • Parameters

      • name: string
      • instance: unknown

      Returns void

    reset

    • reset<T, U>(key: T): void

    • Resets the configuration to its default value

      Type parameters

      • T: keyof MikroORMOptions<D>
      • U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; checkDuplicateEntities?: boolean; checkDuplicateTableNames?: 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; global?: number | boolean | [string, 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

    • resetServiceCache(): void

    • Returns void

    set

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

    • Overrides specified configuration value.

      Type parameters

      • T: keyof MikroORMOptions<D>
      • U: undefined | string | number | boolean | Highlighter | Dictionary | (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>>) => void }[] | EventSubscriber<any>[] | Dictionary<{ name?: string } & Omit<FilterDef, name>> | { alwaysAnalyseProperties?: boolean; checkDuplicateEntities?: boolean; checkDuplicateTableNames?: 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; global?: number | boolean | [string, 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

    Page Options