Version: 4.3

Interface: MikroORMOptions<D>

Type parameters

NameTypeDefault
DIDatabaseDriverIDatabaseDriver

Hierarchy

Properties

autoJoinOneToOneOwner

autoJoinOneToOneOwner: boolean

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


baseDir

baseDir: string

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


batchSize

batchSize: number

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


cache

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

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

Type declaration:

NameType
adapter?{ constructor: (...params: any[]) => CacheAdapter }
enabled?boolean
options?Dictionary
pretty?boolean

charset

Optional charset: string

Inherited from ConnectionOptions.charset

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


clientUrl

Optional clientUrl: string

Inherited from ConnectionOptions.clientUrl

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


context

context: (name: string) => EntityManager | undefined

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


contextName

contextName: string

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


dbName

Optional dbName: string

Inherited from ConnectionOptions.dbName

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


debug

debug: boolean | LoggerNamespace[]

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


discovery

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

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

Type declaration:

NameType
alwaysAnalyseProperties?boolean
disableDynamicFileAccess?boolean
requireEntitiesArray?boolean
warnWhenNoEntities?boolean

driver

Optional driver: { constructor: (config: Configuration) => D }

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

Type declaration:

NameType
constructor(config: Configuration) => D

driverOptions

driverOptions: Dictionary

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


ensureIndexes

ensureIndexes: boolean

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


entities

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

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


entitiesTs

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

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


entityRepository

Optional entityRepository: Constructor<EntityRepository<any>>

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


filters

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

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


findOneOrFailHandler

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

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


forceUndefined

forceUndefined: boolean

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


forceUtcTimezone

forceUtcTimezone: boolean

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


highlighter

highlighter: Highlighter

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


host

Optional host: string

Inherited from ConnectionOptions.host

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


hydrator

hydrator: HydratorConstructor

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


implicitTransactions

Optional implicitTransactions: boolean

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


loadStrategy

loadStrategy: LoadStrategy

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


logger

logger: (message: string) => void

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


metadataProvider

metadataProvider: { constructor: (config: Configuration) => MetadataProvider }

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

Type declaration:

NameType
constructor(config: Configuration) => MetadataProvider

migrations

migrations: MigrationsOptions

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


multipleStatements

Optional multipleStatements: boolean

Inherited from ConnectionOptions.multipleStatements

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


name

Optional name: string

Inherited from ConnectionOptions.name

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


namingStrategy

Optional namingStrategy: { constructor: () => NamingStrategy }

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

Type declaration:

NameType
constructor() => NamingStrategy

password

Optional password: string

Inherited from ConnectionOptions.password

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


pool

Optional pool: PoolConfig

Inherited from ConnectionOptions.pool

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


populateAfterFlush

populateAfterFlush: boolean

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


port

Optional port: number

Inherited from ConnectionOptions.port

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


propagateToOneOwner

propagateToOneOwner: boolean

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


replicas

Optional replicas: Partial<ConnectionOptions>[]

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


resultCache

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

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

Type declaration:

NameType
adapter?{ constructor: (...params: any[]) => CacheAdapter }
expiration?number
options?Dictionary

strict

strict: boolean

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


subscribers

subscribers: EventSubscriber[]

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


timezone

Optional timezone: string

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


tsNode

Optional tsNode: boolean

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


type

Optional type: keyof typeof PLATFORMS

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


useBatchInserts

Optional useBatchInserts: boolean

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


useBatchUpdates

Optional useBatchUpdates: boolean

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


user

Optional user: string

Inherited from ConnectionOptions.user

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


validate

validate: boolean

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

Last updated on by Martin Adámek