MikroORM

Helper class for bootstrapping the MikroORM.

Hierarchy

• MikroORM<MongoDriver>
  • MikroORM

Index

Constructors

• constructor

Properties

• config
• em

Accessors

• entityGenerator
• migrator
• schema
• seeder

Methods

• close
• connect
• discoverEntities
• discoverEntity
• getEntityGenerator
• getMetadata
• getMigrator
• getSchemaGenerator
• getSeeder
• isConnected
• reconnect
• init

Constructors

constructor

• new MikroORM(options): MongoMikroORM

• Inherited from MikroORM.constructor

  Parameters

  • options: Options<MongoDriver> | Configuration<MongoDriver>

  Returns MongoMikroORM

Properties

readonlyconfig

config: Configuration<MongoDriver>

Inherited from MikroORM.config

em

em: MongoEntityManager<MongoDriver> & EntityManager<IDatabaseDriver<Connection>>

Inherited from MikroORM.em

The global EntityManager instance. If you are using RequestContext helper, it will automatically pick the request specific context under the hood

Accessors

entityGenerator

• get entityGenerator(): IEntityGenerator

• Inherited from MikroORM.entityGenerator

  Shortcut for orm.getEntityGenerator()

  ---

  Returns IEntityGenerator

migrator

• get migrator(): IMigrator

• Inherited from MikroORM.migrator

  Shortcut for orm.getMigrator()

  ---

  Returns IMigrator

schema

• get schema(): ReturnType<ReturnType<D[getPlatform]>[getSchemaGenerator]>

• Inherited from MikroORM.schema

  Shortcut for orm.getSchemaGenerator()

  ---

  Returns ReturnType<ReturnType<D[getPlatform]>[getSchemaGenerator]>

seeder

• get seeder(): ISeedManager

• Inherited from MikroORM.seeder

  Shortcut for orm.getSeeder()

  ---

  Returns ISeedManager

Methods

close

• close(force): Promise<void>

• Inherited from MikroORM.close

  Closes the database connection.

  ---

  Parameters

  • force: boolean = false

  Returns Promise<void>

connect

• connect(): Promise<MongoDriver>

• Inherited from MikroORM.connect

  Connects to the database.

  ---

  Returns Promise<MongoDriver>

discoverEntities

• discoverEntities(): Promise<void>

• Inherited from MikroORM.discoverEntities

  Returns Promise<void>

discoverEntity

• discoverEntity(entities): Promise<void>

• Inherited from MikroORM.discoverEntity

  Allows dynamically discovering new entity by reference, handy for testing schema diffing.

  ---

  Parameters

  • entities: Constructor | Constructor[]

  Returns Promise<void>

getEntityGenerator

• getEntityGenerator<T>(): T

• Inherited from MikroORM.getEntityGenerator

  Gets the EntityGenerator.

  ---

  Type parameters

  • T: IEntityGenerator = IEntityGenerator

  Returns T

getMetadata

• getMetadata(): MetadataStorage
• getMetadata<Entity>(entityName): EntityMetadata<Entity>

• Inherited from MikroORM.getMetadata

  Gets the MetadataStorage.

  ---

  Returns MetadataStorage

getMigrator

• getMigrator<T>(): T

• Inherited from MikroORM.getMigrator

  Gets the Migrator.

  ---

  Type parameters

  • T: IMigrator = IMigrator

  Returns T

getSchemaGenerator

• getSchemaGenerator(): MongoSchemaGenerator

• Inherited from MikroORM.getSchemaGenerator

  Gets the SchemaGenerator.

  ---

  Returns MongoSchemaGenerator

getSeeder

• getSeeder<T>(): T

• Inherited from MikroORM.getSeeder

  Gets the SeedManager

  ---

  Type parameters

  • T: ISeedManager = ISeedManager

  Returns T

isConnected

• isConnected(): Promise<boolean>

• Inherited from MikroORM.isConnected

  Checks whether the database connection is active.

  ---

  Returns Promise<boolean>

reconnect

• reconnect(options): Promise<void>

• Inherited from MikroORM.reconnect

  Reconnects, possibly to a different database.

  ---

  Parameters

  • options: Options = {}

  Returns Promise<void>

staticinit

• init<D>(options, connect): Promise<MikroORM<D>>

• Overrides MikroORM.init

  Initialize the ORM, load entity metadata, create EntityManager and connect to the database. If you omit the options parameter, your CLI config will be used.

  ---

  Type parameters

  • D: IDatabaseDriver<Connection, D> = MongoDriver

  Parameters

  • optionaloptions: Options<D> | Configuration<D>

  • connect: boolean = true

  Returns Promise<MikroORM<D>>