MetadataDiscoveryOptions

Configuration options for metadata discovery.

@see

https://mikro-orm.io/docs/configuration#entity-discovery

Index

Properties

• afterDiscovered
• checkDuplicateFieldNames
• checkDuplicateTableNames
• checkNonPersistentCompositeProps
• getMappedType
• inferDefaultValues
• onMetadata
• tsConfigPath
• warnWhenNoEntities

Properties

optionalafterDiscovered

afterDiscovered?: (storage, platform) => MaybePromise<void>

Hook called after all entities are discovered. Can be used to access and modify all metadata at once.

---

Type declaration

• • (storage, platform): MaybePromise<void>

  • Parameters

    • storage: MetadataStorage

    • platform: Platform

    Returns MaybePromise<void>

optionalcheckDuplicateFieldNames

checkDuplicateFieldNames?: boolean = true

Check for duplicate field names and throw an error if found.

optionalcheckDuplicateTableNames

checkDuplicateTableNames?: boolean = true

Check for duplicate table names and throw an error if found.

optionalcheckNonPersistentCompositeProps

checkNonPersistentCompositeProps?: boolean = true

Check for composite primary keys marked as persist: false and throw an error if found.

optionalgetMappedType

getMappedType?: (type, platform) => undefined | Type<unknown, unknown>

Custom callback to override default type mapping. Allows customizing how property types are mapped to database column types.

@example

getMappedType(type, platform) {
  if (type === 'string') {
    return Type.getType(TextType);
  }
  return platform.getDefaultMappedType(type);
}

---

Type declaration

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

  • Parameters

    • type: string

    • platform: Platform

    Returns undefined | Type<unknown, unknown>

optionalinferDefaultValues

inferDefaultValues?: boolean = true

Infer default values from property initializers when possible (if the constructor can be invoked without parameters).

optionalonMetadata

onMetadata?: (meta, platform) => MaybePromise<void>

Hook called for each entity metadata during discovery. Can be used to modify metadata dynamically before defaults are filled in. The hook can be async when using MikroORM.init().

---

Type declaration

• • (meta, platform): MaybePromise<void>

  • Parameters

    • meta: EntityMetadata<any, EntityCtor<any>>

    • platform: Platform

    Returns MaybePromise<void>

optionaltsConfigPath

tsConfigPath?: string

Path to the TypeScript configuration file for ts-morph metadata provider.

optionalwarnWhenNoEntities

warnWhenNoEntities?: boolean = true

Throw an error when no entities are discovered.