Skip to main content
Version: 4.4

Interface: MikroORMOptions<D>#

core.MikroORMOptions

Type parameters#

NameTypeDefault
DIDatabaseDriverIDatabaseDriver

Hierarchy#

Properties#

autoJoinOneToOneOwner#

autoJoinOneToOneOwner: boolean

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


baseDir#

baseDir: string

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


batchSize#

batchSize: number

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


cache#

cache: { adapter?: undefined | (...params: any[]) => CacheAdapter ; enabled?: undefined | boolean ; options?: undefined | Dictionary<any> ; pretty?: undefined | boolean }

Type declaration:#

NameType
adapter?undefined | (...params: any[]) => CacheAdapter
enabled?undefined | boolean
options?undefined | Dictionary<any>
pretty?undefined | boolean

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


charset#

Optional charset: undefined | string

Inherited from: ConnectionOptions.charset

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


clientUrl#

Optional clientUrl: undefined | string

Inherited from: ConnectionOptions.clientUrl

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


collate#

Optional collate: undefined | string

Inherited from: ConnectionOptions.collate

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


context#

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

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


contextName#

contextName: string

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


dbName#

Optional dbName: undefined | string

Inherited from: ConnectionOptions.dbName

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


debug#

debug: boolean | LoggerNamespace[]

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


discovery#

discovery: { alwaysAnalyseProperties?: undefined | boolean ; disableDynamicFileAccess?: undefined | boolean ; requireEntitiesArray?: undefined | boolean ; warnWhenNoEntities?: undefined | boolean }

Type declaration:#

NameType
alwaysAnalyseProperties?undefined | boolean
disableDynamicFileAccess?undefined | boolean
requireEntitiesArray?undefined | boolean
warnWhenNoEntities?undefined | boolean

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


driver#

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

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


driverOptions#

driverOptions: Dictionary<any>

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


ensureIndexes#

ensureIndexes: boolean

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


entities#

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

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


entitiesTs#

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

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


entityRepository#

Optional entityRepository: undefined | Constructor<EntityRepository<any>>

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


filters#

filters: Dictionary<{ name?: undefined | string } & Pick<FilterDef<AnyEntity<any>>, default | entity | cond | args>>

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


findOneOrFailHandler#

findOneOrFailHandler: (entityName: string, where: string | number | bigint | Date | { toHexString: () => string } | Dictionary<any>) => Error

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


forceEntityConstructor#

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

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


forceUndefined#

forceUndefined: boolean

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


forceUtcTimezone#

forceUtcTimezone: boolean

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


highlighter#

highlighter: Highlighter

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


host#

Optional host: undefined | string

Inherited from: ConnectionOptions.host

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


hydrator#

hydrator: HydratorConstructor

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


implicitTransactions#

Optional implicitTransactions: undefined | boolean

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


loadStrategy#

loadStrategy: LoadStrategy

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


logger#

logger: (message: string) => void

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


metadataProvider#

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

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


migrations#

migrations: MigrationsOptions

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


multipleStatements#

Optional multipleStatements: undefined | boolean

Inherited from: ConnectionOptions.multipleStatements

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


name#

Optional name: undefined | string

Inherited from: ConnectionOptions.name

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


namingStrategy#

Optional namingStrategy: undefined | () => NamingStrategy

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


password#

Optional password: undefined | string

Inherited from: ConnectionOptions.password

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


pool#

Optional pool: undefined | PoolConfig

Inherited from: ConnectionOptions.pool

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


populateAfterFlush#

populateAfterFlush: boolean

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


port#

Optional port: undefined | number

Inherited from: ConnectionOptions.port

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


propagateToOneOwner#

propagateToOneOwner: boolean

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


replicas#

Optional replicas: undefined | Partial<ConnectionOptions>[]

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


resultCache#

resultCache: { adapter?: undefined | (...params: any[]) => CacheAdapter ; expiration?: undefined | number ; options?: undefined | Dictionary<any> }

Type declaration:#

NameType
adapter?undefined | (...params: any[]) => CacheAdapter
expiration?undefined | number
options?undefined | Dictionary<any>

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


strict#

strict: boolean

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


subscribers#

subscribers: EventSubscriber<any>[]

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


timezone#

Optional timezone: undefined | string

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


tsNode#

Optional tsNode: undefined | boolean

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


type#

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

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


useBatchInserts#

Optional useBatchInserts: undefined | boolean

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


useBatchUpdates#

Optional useBatchUpdates: undefined | boolean

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


user#

Optional user: undefined | string

Inherited from: ConnectionOptions.user

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


validate#

validate: boolean

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

Last updated on by Martin Adámek