MikroORMOptions <D>

Hierarchy

• ConnectionOptions
  • MikroORMOptions

Index

Properties

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

Properties

allowGlobalContext

allowGlobalContext: boolean

autoJoinOneToOneOwner

autoJoinOneToOneOwner: boolean

baseDir

baseDir: string

batchSize

batchSize: number

cache

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

Type declaration

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

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

    • Parameters

      • rest...params: any[]

      Returns CacheAdapter

• optionalenabled?: boolean

• optionaloptions?: Dictionary

• optionalpretty?: boolean

optionalcharset

charset?: string

Inherited from ConnectionOptions.charset

optionalclientUrl

clientUrl?: string

Inherited from ConnectionOptions.clientUrl

optionalcollate

collate?: string

Inherited from ConnectionOptions.collate

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

optionaldbName

dbName?: string

Inherited from ConnectionOptions.dbName

debug

debug: boolean | LoggerNamespace[]

optionaldisableTransactions

disableTransactions?: boolean

discovery

discovery: { alwaysAnalyseProperties?: boolean; disableDynamicFileAccess?: boolean; getMappedType?: (type: string, platform: Platform) => undefined | Type<unknown, unknown>; requireEntitiesArray?: boolean; warnWhenNoEntities?: boolean }

Type declaration

• optionalalwaysAnalyseProperties?: boolean

• optionaldisableDynamicFileAccess?: boolean

• optionalgetMappedType?: (type: string, platform: Platform) => undefined | Type<unknown, unknown>

  • • (type: string, platform: Platform): undefined | Type<unknown, unknown>

    • Parameters

      • type: string

      • platform: Platform

      Returns undefined | Type<unknown, unknown>

• optionalrequireEntitiesArray?: boolean

• optionalwarnWhenNoEntities?: boolean

optionaldriver

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

Type declaration

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

  • Parameters

    • config: Configuration<IDatabaseDriver<Connection>>

    Returns D

driverOptions

driverOptions: Dictionary

dynamicImportProvider

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

Type declaration

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

  • Parameters

    • id: string

    Returns Promise<unknown>

ensureDatabase

ensureDatabase: boolean

ensureIndexes

ensureIndexes: boolean

entities

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

entitiesTs

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

entityGenerator

entityGenerator: { bidirectionalRelations?: boolean; entitySchema?: boolean; esmImport?: boolean; identifiedReferences?: boolean }

Type declaration

• optionalbidirectionalRelations?: boolean

• optionalentitySchema?: boolean

• optionalesmImport?: boolean

• optionalidentifiedReferences?: boolean

optionalentityRepository

entityRepository?: Constructor

extensions

extensions: { register: (orm: MikroORM<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: FlushMode

forceEntityConstructor

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

forceUndefined

forceUndefined: boolean

forceUtcTimezone

forceUtcTimezone: boolean

highlighter

highlighter: Highlighter

optionalhost

host?: string

Inherited from ConnectionOptions.host

hydrator

hydrator: HydratorConstructor

optionalimplicitTransactions

implicitTransactions?: boolean

loadStrategy

loadStrategy: LoadStrategy

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

metadataProvider

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

Type declaration

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

  • Parameters

    • config: Configuration<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

populateWhere

populateWhere: PopulateHint

optionalport

port?: number

Inherited from ConnectionOptions.port

preferReadReplicas

preferReadReplicas: boolean

propagateToOneOwner

propagateToOneOwner: boolean

optionalreplicas

replicas?: Partial<ConnectionOptions>[]

resultCache

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

Type declaration

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

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

    • Parameters

      • rest...params: any[]

      Returns CacheAdapter

• optionalexpiration?: 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

strict

strict: boolean

subscribers

subscribers: EventSubscriber<any>[]

optionaltimezone

timezone?: string

optionaltsNode

tsNode?: boolean

optionaltype

type?: mongo | mysql | mariadb | postgresql | sqlite | better-sqlite

@deprecated

type option will be removed in v6, use defineConfig exported from the driver package to define your ORM config

optionaluseBatchInserts

useBatchInserts?: boolean

optionaluseBatchUpdates

useBatchUpdates?: boolean

optionaluser

user?: string

Inherited from ConnectionOptions.user

validate

validate: boolean

validateRequired

validateRequired: boolean

verbose

verbose: boolean