MikroORMOptions <D, EM>

Hierarchy

• ConnectionOptions
  • MikroORMOptions

Index

Properties

• allowGlobalContext
• assign
• autoJoinOneToOneOwner
• autoJoinRefsForFilters
• baseDir
• batchSize
• charset
• clientUrl
• collate
• colors
• connect
• context
• contextName
• dataloader
• dbName
• debug
• disableIdentityMap
• disableTransactions
• discovery
• driver
• driverOptions
• dynamicImportProvider
• embeddables
• ensureDatabase
• ensureIndexes
• entities
• entitiesTs
• entityGenerator
• entityManager
• entityRepository
• extensions
• filters
• findExactlyOneOrFailHandler
• findOneOrFailHandler
• flushMode
• forceEntityConstructor
• forceUndefined
• forceUtcTimezone
• highlighter
• host
• hydrator
• ignoreUndefinedInQuery
• implicitTransactions
• loadStrategy
• logger
• loggerFactory
• metadataCache
• metadataProvider
• migrations
• multipleStatements
• name
• namingStrategy
• password
• persistOnCreate
• pool
• populateAfterFlush
• populateWhere
• port
• preferReadReplicas
• propagationOnPrototype
• replicas
• resultCache
• schema
• schemaGenerator
• seeder
• serialization
• strict
• subscribers
• timezone
• tsNode
• useBatchInserts
• useBatchUpdates
• user
• validate
• validateRequired
• verbose

Properties

allowGlobalContext

allowGlobalContext: boolean

assign

assign: AssignOptions<boolean>

autoJoinOneToOneOwner

autoJoinOneToOneOwner: boolean

autoJoinRefsForFilters

autoJoinRefsForFilters: boolean

baseDir

baseDir: string

batchSize

batchSize: number

optionalcharset

charset?: string

Inherited from ConnectionOptions.charset

optionalclientUrl

clientUrl?: string

Inherited from ConnectionOptions.clientUrl

optionalcollate

collate?: string

Inherited from ConnectionOptions.collate

optionalcolors

colors?: boolean

connect

connect: boolean

context

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

Type declaration

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

  • Parameters

    • name: string

    Returns undefined | EntityManager<IDatabaseDriver<Connection>>

contextName

contextName: string

dataloader

dataloader: boolean | DataloaderType

optionaldbName

dbName?: string

Inherited from ConnectionOptions.dbName

debug

debug: boolean | LoggerNamespace[]

optionaldisableIdentityMap

disableIdentityMap?: boolean

optionaldisableTransactions

disableTransactions?: boolean

discovery

discovery: MetadataDiscoveryOptions

optionaldriver

driver?: new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => D

Type declaration

• • new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): D

  • Parameters

    • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

    Returns D

optionaldriverOptions

driverOptions?: Dictionary

Inherited from ConnectionOptions.driverOptions

dynamicImportProvider

dynamicImportProvider: (id: string) => Promise<unknown>

Type declaration

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

  • Parameters

    • id: string

    Returns Promise<unknown>

embeddables

embeddables: { prefixMode: EmbeddedPrefixMode }

Type declaration

• prefixMode: EmbeddedPrefixMode

ensureDatabase

ensureDatabase: boolean | EnsureDatabaseOptions

ensureIndexes

ensureIndexes: boolean

entities

entities: (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[]

entitiesTs

entitiesTs: (string | EntityClass<Partial<any>> | EntityClassGroup<Partial<any>> | EntitySchema<any, never>)[]

entityGenerator

entityGenerator: GenerateOptions

optionalentityManager

entityManager?: Constructor<EM>

optionalentityRepository

entityRepository?: EntityClass<EntityRepository<any>>

extensions

extensions: { register: (orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => void }[]

filters

filters: Dictionary<{ name?: string } & Omit<FilterDef, name>>

findExactlyOneOrFailHandler

findExactlyOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error

Type declaration

• • (entityName: string, where: IPrimaryKeyValue | Dictionary): Error

  • Parameters

    • entityName: string

    • where: IPrimaryKeyValue | Dictionary

    Returns Error

findOneOrFailHandler

findOneOrFailHandler: (entityName: string, where: IPrimaryKeyValue | Dictionary) => Error

Type declaration

• • (entityName: string, where: IPrimaryKeyValue | Dictionary): Error

  • Parameters

    • entityName: string

    • where: IPrimaryKeyValue | Dictionary

    Returns Error

flushMode

flushMode: always | FlushMode | commit | auto

forceEntityConstructor

forceEntityConstructor: boolean | (string | Constructor<Partial<any>>)[]

forceUndefined

forceUndefined: boolean

optionalforceUtcTimezone

forceUtcTimezone?: boolean

highlighter

highlighter: Highlighter

optionalhost

host?: string

Inherited from ConnectionOptions.host

hydrator

hydrator: HydratorConstructor

optionalignoreUndefinedInQuery

ignoreUndefinedInQuery?: boolean

optionalimplicitTransactions

implicitTransactions?: boolean

loadStrategy

loadStrategy: LoadStrategy | select-in | joined

logger

logger: (message: string) => void

Type declaration

• • (message: string): void

  • Parameters

    • message: string

    Returns void

optionalloggerFactory

loggerFactory?: (options: LoggerOptions) => Logger

Type declaration

• • (options: LoggerOptions): Logger

  • Parameters

    • options: LoggerOptions

    Returns Logger

metadataCache

metadataCache: { adapter?: new (...params: any[]) => SyncCacheAdapter; combined?: string | boolean; enabled?: boolean; options?: Dictionary; pretty?: boolean }

Type declaration

• optionaladapter?: new (...params: any[]) => SyncCacheAdapter

  • • new (...params: any[]): SyncCacheAdapter

    • Parameters

      • rest...params: any[]

      Returns SyncCacheAdapter

• optionalcombined?: string | boolean

• optionalenabled?: boolean

• optionaloptions?: Dictionary

• optionalpretty?: boolean

metadataProvider

metadataProvider: new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>) => MetadataProvider

Type declaration

• • new (config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): MetadataProvider

  • Parameters

    • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

    Returns MetadataProvider

migrations

migrations: MigrationsOptions

optionalmultipleStatements

multipleStatements?: boolean

Inherited from ConnectionOptions.multipleStatements

optionalname

name?: string

Inherited from ConnectionOptions.name

optionalnamingStrategy

namingStrategy?: new () => NamingStrategy

Type declaration

• • new (): NamingStrategy

  • Returns NamingStrategy

optionalpassword

password?: string | () => MaybePromise<string> | MaybePromise<DynamicPassword>

Inherited from ConnectionOptions.password

persistOnCreate

persistOnCreate: boolean

optionalpool

pool?: PoolConfig

Inherited from ConnectionOptions.pool

populateAfterFlush

populateAfterFlush: boolean

optionalpopulateWhere

populateWhere?: PopulateHint | infer | all

optionalport

port?: number

Inherited from ConnectionOptions.port

preferReadReplicas

preferReadReplicas: boolean

propagationOnPrototype

propagationOnPrototype: boolean

optionalreplicas

replicas?: ConnectionOptions[]

resultCache

resultCache: { adapter?: new (...params: any[]) => CacheAdapter; expiration?: number; global?: number | boolean | [string, number]; options?: Dictionary }

Type declaration

• optionaladapter?: new (...params: any[]) => CacheAdapter

  • • new (...params: any[]): CacheAdapter

    • Parameters

      • rest...params: any[]

      Returns CacheAdapter

• optionalexpiration?: number

• optionalglobal?: number | boolean | [string, number]

• optionaloptions?: Dictionary

optionalschema

schema?: string

Inherited from ConnectionOptions.schema

schemaGenerator

schemaGenerator: { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string }

Type declaration

• optionalcreateForeignKeyConstraints?: boolean

• optionaldisableForeignKeys?: boolean

• optionalignoreSchema?: string[]

• optionalmanagementDbName?: string

seeder

seeder: SeederOptions

serialization

serialization: { forceObject?: boolean; includePrimaryKeys?: boolean }

Type declaration

• optionalforceObject?: boolean

  Enforce unpopulated references to be returned as objects, e.g. { author: { id: 1 } } instead of { author: 1 }.

• optionalincludePrimaryKeys?: boolean

strict

strict: boolean

subscribers

subscribers: (EventSubscriber<any> | Constructor<EventSubscriber<any>>)[]

optionaltimezone

timezone?: string

optionaltsNode

tsNode?: boolean

optionaluseBatchInserts

useBatchInserts?: boolean

optionaluseBatchUpdates

useBatchUpdates?: boolean

optionaluser

user?: string

Inherited from ConnectionOptions.user

validate

validate: boolean

validateRequired

validateRequired: boolean

verbose

verbose: boolean