Version: 4.5

Interface: MikroORMOptions<D>#

core.MikroORMOptions

Type parameters#

Name	Type	Default
`D`	IDatabaseDriver	IDatabaseDriver

Hierarchy#

ConnectionOptions
↳ MikroORMOptions

Properties#

autoJoinOneToOneOwner#

• autoJoinOneToOneOwner: boolean

Defined in: packages/core/src/utils/Configuration.ts:356

baseDir#

• baseDir: string

Defined in: packages/core/src/utils/Configuration.ts:380

batchSize#

• batchSize: number

Defined in: packages/core/src/utils/Configuration.ts:366

cache#

• cache: object

Type declaration:#

Name	Type
`adapter`?	(...`params`: any[]) => CacheAdapter
`enabled`?	boolean
`options`?	Dictionary<any>
`pretty`?	boolean

Defined in: packages/core/src/utils/Configuration.ts:382

charset#

• Optional charset: string

Inherited from: ConnectionOptions.charset

Defined in: packages/core/src/utils/Configuration.ts:296

clientUrl#

• Optional clientUrl: string

Inherited from: ConnectionOptions.clientUrl

Defined in: packages/core/src/utils/Configuration.ts:291

collate#

• Optional collate: string

Inherited from: ConnectionOptions.collate

Defined in: packages/core/src/utils/Configuration.ts:297

context#

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

Type declaration:#

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

Parameters:#

Name	Type
`name`	string

Returns: undefined | EntityManager<IDatabaseDriver<Connection>>

Defined in: packages/core/src/utils/Configuration.ts:373

contextName#

• contextName: string

Defined in: packages/core/src/utils/Configuration.ts:374

dbName#

• Optional dbName: string

Inherited from: ConnectionOptions.dbName

Defined in: packages/core/src/utils/Configuration.ts:289

debug#

• debug: boolean | LoggerNamespace[]

Defined in: packages/core/src/utils/Configuration.ts:377

discovery#

• discovery: object

Type declaration:#

Name	Type
`alwaysAnalyseProperties`?	boolean
`disableDynamicFileAccess`?	boolean
`requireEntitiesArray`?	boolean
`warnWhenNoEntities`?	boolean

Defined in: packages/core/src/utils/Configuration.ts:345

driver#

• Optional driver: (config: Configuration<IDatabaseDriver<Connection>>) => D

Type declaration:#

+ new MikroORMOptions(config: Configuration<IDatabaseDriver<Connection>>): D

Parameters:#

Name	Type
`config`	Configuration<IDatabaseDriver<Connection>>

Returns: D

Inherited from: void

Defined in: packages/core/src/utils/Configuration.ts:352

driverOptions#

• driverOptions: Dictionary<any>

Defined in: packages/core/src/utils/Configuration.ts:353

ensureIndexes#

• ensureIndexes: boolean

Defined in: packages/core/src/utils/Configuration.ts:363

entities#

• entities: (string | EntityClass<AnyEntity<any>> | EntityClassGroup<AnyEntity<any>> | EntitySchema<any, undefined>)[]

Defined in: packages/core/src/utils/Configuration.ts:341

entitiesTs#

• entitiesTs: (string | EntityClass<AnyEntity<any>> | EntityClassGroup<AnyEntity<any>> | EntitySchema<any, undefined>)[]

Defined in: packages/core/src/utils/Configuration.ts:342

entityRepository#

• Optional entityRepository: Constructor<EntityRepository<any>>

Defined in: packages/core/src/utils/Configuration.ts:369

filters#

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

Defined in: packages/core/src/utils/Configuration.ts:344

findOneOrFailHandler#

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

Type declaration:#

▸ (entityName: string, where: IPrimaryKeyValue | Dictionary<any>): Error

Parameters:#

Name	Type
`entityName`	string
`where`	IPrimaryKeyValue \| Dictionary<any>

Returns: Error

Defined in: packages/core/src/utils/Configuration.ts:376

forceEntityConstructor#

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

Defined in: packages/core/src/utils/Configuration.ts:359

forceUndefined#

• forceUndefined: boolean

Defined in: packages/core/src/utils/Configuration.ts:360

forceUtcTimezone#

• forceUtcTimezone: boolean

Defined in: packages/core/src/utils/Configuration.ts:361

highlighter#

• highlighter: Highlighter

Defined in: packages/core/src/utils/Configuration.ts:378

host#

• Optional host: string

Inherited from: ConnectionOptions.host

Defined in: packages/core/src/utils/Configuration.ts:292

hydrator#

• hydrator: HydratorConstructor

Defined in: packages/core/src/utils/Configuration.ts:367

implicitTransactions#

• Optional implicitTransactions: boolean

Defined in: packages/core/src/utils/Configuration.ts:355

loadStrategy#

• loadStrategy: LoadStrategy

Defined in: packages/core/src/utils/Configuration.ts:368

logger#

• logger: (message: string) => void

Type declaration:#

▸ (message: string): void

Parameters:#

Name	Type
`message`	string

Returns: void

Defined in: packages/core/src/utils/Configuration.ts:375

metadataProvider#

• metadataProvider: (config: Configuration<IDatabaseDriver<Connection>>) => MetadataProvider

Type declaration:#

+ new MikroORMOptions(config: Configuration<IDatabaseDriver<Connection>>): MetadataProvider

Parameters:#

Name	Type
`config`	Configuration<IDatabaseDriver<Connection>>

Returns: MetadataProvider

Inherited from: void

Defined in: packages/core/src/utils/Configuration.ts:393

migrations#

• migrations: MigrationsOptions

Defined in: packages/core/src/utils/Configuration.ts:381

multipleStatements#

• Optional multipleStatements: boolean

Inherited from: ConnectionOptions.multipleStatements

Defined in: packages/core/src/utils/Configuration.ts:298

name#

• Optional name: string

Inherited from: ConnectionOptions.name

Defined in: packages/core/src/utils/Configuration.ts:290

namingStrategy#

• Optional namingStrategy: () => NamingStrategy

Type declaration:#

+ new MikroORMOptions(): NamingStrategy

Returns: NamingStrategy

Inherited from: void

Defined in: packages/core/src/utils/Configuration.ts:354

password#

• Optional password: string

Inherited from: ConnectionOptions.password

Defined in: packages/core/src/utils/Configuration.ts:295

pool#

• Optional pool: PoolConfig

Inherited from: ConnectionOptions.pool

Defined in: packages/core/src/utils/Configuration.ts:299

populateAfterFlush#

• populateAfterFlush: boolean

Defined in: packages/core/src/utils/Configuration.ts:358

port#

• Optional port: number

Inherited from: ConnectionOptions.port

Defined in: packages/core/src/utils/Configuration.ts:293

propagateToOneOwner#

• propagateToOneOwner: boolean

Defined in: packages/core/src/utils/Configuration.ts:357

replicas#

• Optional replicas: Partial<ConnectionOptions>[]

Defined in: packages/core/src/utils/Configuration.ts:370

resultCache#

• resultCache: object

Type declaration:#

Name	Type
`adapter`?	(...`params`: any[]) => CacheAdapter
`expiration`?	number
`options`?	Dictionary<any>

Defined in: packages/core/src/utils/Configuration.ts:388

strict#

• strict: boolean

Defined in: packages/core/src/utils/Configuration.ts:371

subscribers#

• subscribers: EventSubscriber<any>[]

Defined in: packages/core/src/utils/Configuration.ts:343

timezone#

• Optional timezone: string

Defined in: packages/core/src/utils/Configuration.ts:362

tsNode#

• Optional tsNode: boolean

Defined in: packages/core/src/utils/Configuration.ts:379

type#

• Optional type: mongo | mysql | mariadb | postgresql | sqlite

Defined in: packages/core/src/utils/Configuration.ts:351

useBatchInserts#

• Optional useBatchInserts: boolean

Defined in: packages/core/src/utils/Configuration.ts:364

useBatchUpdates#

• Optional useBatchUpdates: boolean

Defined in: packages/core/src/utils/Configuration.ts:365

user#

• Optional user: string

Inherited from: ConnectionOptions.user

Defined in: packages/core/src/utils/Configuration.ts:294

validate#

• validate: boolean

Defined in: packages/core/src/utils/Configuration.ts:372