Configuration <D, EM>

Index

Constructors

• constructor

Properties

• DEFAULTS

Methods

• get
• getAll
• getCachedService
• getClientUrl
• getComparator
• getDriver
• getExtension
• getHydrator
• getLogger
• getMetadataCacheAdapter
• getMetadataProvider
• getNamingStrategy
• getRepositoryClass
• getResultCacheAdapter
• registerExtension
• reset
• resetServiceCache
• set

Constructors

constructor

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

• Type parameters

  • D: IDatabaseDriver<Connection> = IDatabaseDriver<Connection>
  • EM: EntityManager<IDatabaseDriver<Connection>> = D[typeof EntityManagerType] & EntityManager<IDatabaseDriver<Connection>>

  Parameters

  • options: Options<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  • validate: boolean = true

  Returns Configuration<D, EM>

Properties

staticreadonlyDEFAULTS

DEFAULTS: { allowGlobalContext: false; assign: { mergeEmbeddedProperties: true; mergeObjectProperties: false; updateByPrimaryKey: true; updateNestedEntities: true }; autoJoinOneToOneOwner: true; autoJoinRefsForFilters: true; baseDir: string; batchSize: number; colors: true; connect: true; context: (name: string) => undefined | EntityManager<IDatabaseDriver<Connection>>; contextName: string; dataloader: NONE; debug: false; discovery: { alwaysAnalyseProperties: true; checkDuplicateEntities: true; checkDuplicateFieldNames: true; checkDuplicateTableNames: true; disableDynamicFileAccess: false; inferDefaultValues: true; requireEntitiesArray: false; warnWhenNoEntities: true }; driverOptions: {}; dynamicImportProvider: (id: string) => Promise<any>; ensureDatabase: true; ensureIndexes: false; entities: never[]; entitiesTs: never[]; entityGenerator: { bidirectionalRelations: false; fileName: (className: string) => string; identifiedReferences: false; onlyPurePivotTables: false; readOnlyPivotTables: false; scalarPropertiesForRelations: never; scalarTypeInDecorator: false; useCoreBaseEntity: false }; extensions: never[]; filters: {}; findExactlyOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => NotFoundError<Partial<any>>; findOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => NotFoundError<Partial<any>>; flushMode: AUTO; forceEntityConstructor: false; forceUndefined: false; forceUtcTimezone: false; highlighter: NullHighlighter; hydrator: typeof ObjectHydrator; ignoreUndefinedInQuery: false; loadStrategy: JOINED; logger: (message?: any, ...optionalParams: any[]) => void; metadataCache: { adapter: typeof FileCacheAdapter; options: { cacheDir: string }; pretty: false }; metadataProvider: typeof ReflectMetadataProvider; migrations: { allOrNothing: true; disableForeignKeys: true; dropTables: true; emit: ts; fileName: (timestamp: string, name?: string) => string; glob: string; path: string; safe: false; silent: false; snapshot: true; tableName: string; transactional: true }; persistOnCreate: true; pool: {}; populateAfterFlush: true; populateWhere: ALL; preferReadReplicas: true; propagationOnPrototype: true; resultCache: { adapter: typeof MemoryCacheAdapter; expiration: number; options: {} }; schemaGenerator: { createForeignKeyConstraints: true; disableForeignKeys: true; ignoreSchema: never[] }; seeder: { defaultSeeder: string; emit: ts; fileName: (className: string) => string; glob: string; path: string }; serialization: { includePrimaryKeys: true }; strict: false; subscribers: never[]; validate: false; validateRequired: true; verbose: false } = ...

Type declaration

• allowGlobalContext: false

• assign: { mergeEmbeddedProperties: true; mergeObjectProperties: false; updateByPrimaryKey: true; updateNestedEntities: true }

  • mergeEmbeddedProperties: true

  • mergeObjectProperties: false

  • updateByPrimaryKey: true

  • updateNestedEntities: true

• autoJoinOneToOneOwner: true

• autoJoinRefsForFilters: true

• baseDir: string

• batchSize: number

• colors: true

• connect: true

• context: (name: string) => undefined | EntityManager<IDatabaseDriver<Connection>>

  • • (name: string): undefined | EntityManager<IDatabaseDriver<Connection>>

    • Parameters

      • name: string

      Returns undefined | EntityManager<IDatabaseDriver<Connection>>

• contextName: string

• dataloader: NONE

• debug: false

• discovery: { alwaysAnalyseProperties: true; checkDuplicateEntities: true; checkDuplicateFieldNames: true; checkDuplicateTableNames: true; disableDynamicFileAccess: false; inferDefaultValues: true; requireEntitiesArray: false; warnWhenNoEntities: true }

  • alwaysAnalyseProperties: true

  • checkDuplicateEntities: true

  • checkDuplicateFieldNames: true

  • checkDuplicateTableNames: true

  • disableDynamicFileAccess: false

  • inferDefaultValues: true

  • requireEntitiesArray: false

  • warnWhenNoEntities: true

• driverOptions: {}

• dynamicImportProvider: (id: string) => Promise<any>

  • • (id: string): Promise<any>

    • Parameters

      • id: string

      Returns Promise<any>

• ensureDatabase: true

• ensureIndexes: false

• entities: never[]

• entitiesTs: never[]

• entityGenerator: { bidirectionalRelations: false; fileName: (className: string) => string; identifiedReferences: false; onlyPurePivotTables: false; readOnlyPivotTables: false; scalarPropertiesForRelations: never; scalarTypeInDecorator: false; useCoreBaseEntity: false }

  • bidirectionalRelations: false

  • fileName: (className: string) => string

    • • (className: string): string

      • Parameters

        • className: string

        Returns string

  • identifiedReferences: false

  • onlyPurePivotTables: false

  • readOnlyPivotTables: false

  • scalarPropertiesForRelations: never

  • scalarTypeInDecorator: false

  • useCoreBaseEntity: false

• extensions: never[]

• filters: {}

• findExactlyOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => NotFoundError<Partial<any>>

  • • (entityName: string, where: IPrimaryKeyValue | Dictionary): NotFoundError<Partial<any>>

    • Parameters

      • entityName: string

      • where: IPrimaryKeyValue | Dictionary

      Returns NotFoundError<Partial<any>>

• findOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => NotFoundError<Partial<any>>

  • • (entityName: string, where: IPrimaryKeyValue | Dictionary): NotFoundError<Partial<any>>

    • Parameters

      • entityName: string

      • where: IPrimaryKeyValue | Dictionary

      Returns NotFoundError<Partial<any>>

• flushMode: AUTO

• forceEntityConstructor: false

• forceUndefined: false

• forceUtcTimezone: false

• highlighter: NullHighlighter

• hydrator: typeof ObjectHydrator

• ignoreUndefinedInQuery: false

• loadStrategy: JOINED

• logger: (message?: any, ...optionalParams: any[]) => void

  • • (message?: any, ...optionalParams: any[]): void

    • Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

      const count = 5;
      console.log('count: %d', count);
      // Prints: count: 5, to stdout
      console.log('count:', count);
      // Prints: count: 5, to stdout

      See util.format() for more information.

      @since

      v0.1.100

      ---

      Parameters

      • optionalmessage: any

      • rest...optionalParams: any[]

      Returns void

• metadataCache: { adapter: typeof FileCacheAdapter; options: { cacheDir: string }; pretty: false }

  • adapter: typeof FileCacheAdapter

  • options: { cacheDir: string }

    • cacheDir: string

  • pretty: false

• metadataProvider: typeof ReflectMetadataProvider

• migrations: { allOrNothing: true; disableForeignKeys: true; dropTables: true; emit: ts; fileName: (timestamp: string, name?: string) => string; glob: string; path: string; safe: false; silent: false; snapshot: true; tableName: string; transactional: true }

  • allOrNothing: true

  • disableForeignKeys: true

  • dropTables: true

  • emit: ts

  • fileName: (timestamp: string, name?: string) => string

    • • (timestamp: string, name?: string): string

      • Parameters

        • timestamp: string

        • optionalname: string

        Returns string

  • glob: string

  • path: string

  • safe: false

  • silent: false

  • snapshot: true

  • tableName: string

  • transactional: true

• persistOnCreate: true

• pool: {}

• populateAfterFlush: true

• populateWhere: ALL

• preferReadReplicas: true

• propagationOnPrototype: true

• resultCache: { adapter: typeof MemoryCacheAdapter; expiration: number; options: {} }

  • adapter: typeof MemoryCacheAdapter

  • expiration: number

  • options: {}

• schemaGenerator: { createForeignKeyConstraints: true; disableForeignKeys: true; ignoreSchema: never[] }

  • createForeignKeyConstraints: true

  • disableForeignKeys: true

  • ignoreSchema: never[]

• seeder: { defaultSeeder: string; emit: ts; fileName: (className: string) => string; glob: string; path: string }

  • defaultSeeder: string

  • emit: ts

  • fileName: (className: string) => string

    • • (className: string): string

      • Parameters

        • className: string

        Returns string

  • glob: string

  • path: string

• serialization: { includePrimaryKeys: true }

  • includePrimaryKeys: true

• strict: false

• subscribers: never[]

• validate: false

• validateRequired: true

• verbose: false

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, EM>
  • U: undefined | string | number | boolean | Highlighter | EntityClass<EntityRepository<any>> | Dictionary | GenerateOptions | EnsureDatabaseOptions | Dictionary<{ name?: string } & Omit<FilterDef, name>> | (EventSubscriber<any> | Constructor<EventSubscriber<any>>)[] | (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => void }[] | MetadataDiscoveryOptions | new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => D | new () => NamingStrategy | { forceObject?: boolean; includePrimaryKeys?: boolean } | AssignOptions<boolean> | (string | Constructor<Partial<any>>)[] | HydratorConstructor | Constructor<EM> | 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 } | { adapter?: new (...params: any[]) => SyncCacheAdapter; combined?: string | boolean; 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>, EntityManager<IDatabaseDriver<Connection>>>) => MetadataProvider | SeederOptions | (id: string) => Promise<unknown> | () => MaybePromise<string> | MaybePromise<DynamicPassword> | PoolConfig

  Parameters

  • key: T

  • optionaldefaultValue: U

  Returns U

getAll

• getAll(): MikroORMOptions<D, EM>

• Returns MikroORMOptions<D, EM>

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

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

getRepositoryClass

• getRepositoryClass(repository: () => EntityClass<EntityRepository<Partial<any>>>): 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

registerExtension

• registerExtension(name: string, cb: () => unknown): void

• Parameters

  • name: string

  • cb: () => unknown

  Returns void

reset

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

• Resets the configuration to its default value

  ---

  Type parameters

  • T: keyof MikroORMOptions<D, EM>

  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, EM>
  • U: undefined | string | number | boolean | Highlighter | EntityClass<EntityRepository<any>> | Dictionary | GenerateOptions | EnsureDatabaseOptions | Dictionary<{ name?: string } & Omit<FilterDef, name>> | (EventSubscriber<any> | Constructor<EventSubscriber<any>>)[] | (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[] | { register: (orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => void }[] | MetadataDiscoveryOptions | new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => D | new () => NamingStrategy | { forceObject?: boolean; includePrimaryKeys?: boolean } | AssignOptions<boolean> | (string | Constructor<Partial<any>>)[] | HydratorConstructor | Constructor<EM> | 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 } | { adapter?: new (...params: any[]) => SyncCacheAdapter; combined?: string | boolean; 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>, EntityManager<IDatabaseDriver<Connection>>>) => MetadataProvider | SeederOptions | (id: string) => Promise<unknown> | () => MaybePromise<string> | MaybePromise<DynamicPassword> | PoolConfig

  Parameters

  • key: T

  • value: U

  Returns void