EntityManager <Driver>
Hierarchy
- EntityManager
Index
Properties
Accessors
Methods
- addFilter
- assign
- begin
- canPopulate
- clear
- clearCache
- commit
- count
- create
- find
- findAll
- findAndCount
- findByCursor
- findOne
- findOneOrFail
- flush
- fork
- getComparator
- getConnection
- getDriver
- getEntityFactory
- getEventManager
- getFilterParams
- getHydrator
- getLoggerContext
- getMetadata
- getPlatform
- getReference
- getRepository
- getTransactionContext
- getUnitOfWork
- getValidator
- insert
- insertMany
- isInTransaction
- lock
- map
- merge
- nativeDelete
- nativeUpdate
- persist
- persistAndFlush
- populate
- refresh
- refreshOrFail
- remove
- removeAndFlush
- repo
- resetTransactionContext
- rollback
- setFilterParams
- setFlushMode
- setLoggerContext
- setTransactionContext
- transactional
- upsert
- upsertMany
Properties
readonly_id
readonlyconfig
readonlyglobal
readonlyname
Accessors
id
Returns the ID of this EntityManager. Respects the context, so global EM will give you the contextual ID if executed inside request context handler.
Returns number
schema
Returns the default schema of this EntityManager. Respects the context, so global EM will give you the contextual schema if executed inside request context handler.
Returns undefined | string
Sets the default schema of this EntityManager. Respects the context, so global EM will set the contextual schema if executed inside request context handler.
Parameters
schema: undefined | null | string
Returns void
Methods
addFilter
Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
Type parameters
- T1
Parameters
name: string
cond: FilterQuery<T1> | (args: Dictionary) => MaybePromise<FilterQuery<T1>>
optionalentityName: EntityName<T1> | [EntityName<T1>]
optionalenabled: boolean
Returns void
assign
Shortcut for
wrap(entity).assign(data, { em })Type parameters
- Entity: object
- Naked: object = FromEntityType<Entity>
- Convert: boolean = false
- Data: EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> = EntityData<Naked, Convert> | Partial<EntityDTO<Naked>>
Parameters
entity: Entity | Partial<Entity>
data: Data & IsSubset<EntityData<Naked, Convert>, Data>
options: AssignOptions<Convert> = {}
Returns MergeSelected<Entity, Naked, keyof Data & string>
begin
Starts new transaction bound to this EntityManager. Use
ctxparameter to provide the parent when nesting transactions.Parameters
options: Omit<TransactionOptions, ignoreNestedTransactions> = {}
Returns Promise<void>
canPopulate
Checks whether given property can be populated on the entity.
Type parameters
- Entity: object
Parameters
entityName: EntityName<Entity>
property: string
Returns boolean
clear
Clears the EntityManager. All entities that are currently managed by this EntityManager become detached.
Returns void
clearCache
Clears result cache for given cache key. If we want to be able to call this method, we need to set the cache key explicitly when storing the cache.
// set the cache key to 'book-cache-key', with expiration of 60s
const res = await em.find(Book, { ... }, { cache: ['book-cache-key', 60_000] });
// clear the cache key by name
await em.clearCache('book-cache-key');Parameters
cacheKey: string
Returns Promise<void>
commit
Commits the transaction bound to this EntityManager. Flushes before doing the actual commit query.
Returns Promise<void>
count
Returns total number of entities matching your
wherequery.Type parameters
- Entity: object
- Hint: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer> = ...
options: CountOptions<Entity, Hint> = {}
Returns Promise<number>
create
Creates new instance of given entity and populates it with given data. The entity constructor will be used unless you provide
{ managed: true }in the options parameter. The constructor will be given parameters based on the defined constructor of the entity. If the constructor parameter matches a property name, its value will be extracted fromdata. If no matching property exists, the wholedataparameter will be passed. This means we can also defineconstructor(data: Partial<T>)andem.create()will pass the data into it (unless we have a property nameddatatoo).The parameters are strictly checked, you need to provide all required properties. You can use
OptionalPropssymbol to omit some properties from this check without making them optional. Alternatively, usepartial: truein the options to disable the strict checks for required properties. This option has no effect on runtime.Type parameters
- Entity: object
- Convert: boolean = false
Parameters
entityName: EntityName<Entity>
data: RequiredEntityData<Entity, never, Convert>
optionaloptions: CreateOptions<Convert>
Returns Entity
find
Finds all entities matching your
wherequery. You can pass additional options via theoptionsparameter.Type parameters
- Entity: object
- Hint: string = never
- Fields: string = ALL
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: FindOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<Loaded<Entity, Hint, Fields, Excludes>[]>
findAll
Finds all entities of given type, optionally matching the
wherecondition provided in theoptionsparameter.Type parameters
- Entity: object
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
optionaloptions: FindAllOptions<NoInfer, Hint, Fields, Excludes>
Returns Promise<Loaded<Entity, Hint, Fields, Excludes>[]>
findAndCount
Calls
em.find()andem.count()with the same arguments (where applicable) and returns the results as tuple where the first element is the array of entities, and the second is the count.Type parameters
- Entity: object
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: FindOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<[Loaded<Entity, Hint, Fields, Excludes>[], number]>
findByCursor
Calls
em.find()andem.count()with the same arguments (where applicable) and returns the results as Cursor object. Supportsbefore,after,firstandlastoptions while disallowinglimitandoffset. ExplicitorderByoption is required.Use
firstandafterfor forward pagination, orlastandbeforefor backward pagination.firstandlastare numbers and serve as an alternative tooffset, those options are mutually exclusive, use only one at a timebeforeandafterspecify the previous cursor value, it can be one of the:Cursorinstance- opaque string provided by
startCursor/endCursorproperties - POJO/entity instance
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});The
Cursorobject provides the following interface:Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
],
totalCount: 50,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}Type parameters
- Entity: object
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: FindByCursorOptions<Entity, Hint, Fields, Excludes>
Returns Promise<Cursor<Entity, Hint, Fields, Excludes>>
findOne
Finds first entity matching your
wherequery.Type parameters
- Entity: object
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: FindOneOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<null | Loaded<Entity, Hint, Fields, Excludes>>
findOneOrFail
Finds first entity matching your
wherequery. If nothing found, it will throw an error. If thestrictoption is specified and nothing is found or more than one matching entity is found, it will throw an error. You can override the factory for creating this method viaoptions.failHandlerlocally or viaConfiguration.findOneOrFailHandler(findExactlyOneOrFailHandlerwhen specifyingstrict) globally.Type parameters
- Entity: object
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: FindOneOrFailOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<Loaded<Entity, Hint, Fields, Excludes>>
flush
Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database.
Returns Promise<void>
fork
Returns new EntityManager instance with its own identity map
Parameters
options: ForkOptions = {}
Returns this
getComparator
Gets the EntityComparator.
Returns EntityComparator
getConnection
Gets the Connection instance, by default returns write connection
Parameters
optionaltype: ConnectionType
Returns ReturnType<Driver[getConnection]>
getDriver
Gets the Driver instance used by this EntityManager. Driver is singleton, for one MikroORM instance, only one driver is created.
Returns Driver
getEntityFactory
Gets the EntityFactory used by the EntityManager.
Returns EntityFactory
getEventManager
Returns EventManager
getFilterParams
Returns filter parameters for given filter set in this context.
Type parameters
- T: Dictionary = Dictionary
Parameters
name: string
Returns T
getHydrator
Gets the Hydrator used by the EntityManager.
Returns IHydrator
getLoggerContext
Gets logger context for this entity manager.
Type parameters
- T: Dictionary = Dictionary
Returns T
getMetadata
Gets the
MetadataStorage.Returns MetadataStorage
getPlatform
Gets the platform instance. Just like the driver, platform is singleton, one for a MikroORM instance.
Returns ReturnType<Driver[getPlatform]>
getReference
Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
Type parameters
- Entity: object
Parameters
entityName: EntityName<Entity>
id: Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity ? ReadonlyPrimary<UnwrapPrimary<Entity[PK]>> : PK extends keyof Entity[] ? ReadonlyPrimary<PrimaryPropToType<Entity, PK>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity
options: Omit<GetReferenceOptions, wrapped> & { wrapped: true }
Returns Entity extends Scalar ? ScalarReference<Entity> : EntityRef<Entity>
getRepository
Gets repository for given entity. You can pass either string name or entity class reference.
Type parameters
- Entity: object
- Repository: EntityRepository<Entity> = EntityRepository<Entity>
Parameters
entityName: EntityName<Entity>
Returns GetRepository<Entity, Repository>
getTransactionContext
Gets the transaction context (driver dependent object used to make sure queries are executed on same connection).
Type parameters
- T: unknown = any
Returns undefined | T
getUnitOfWork
Gets the UnitOfWork used by the EntityManager to coordinate operations.
Parameters
useContext: boolean = true
Returns UnitOfWork
getValidator
Gets EntityValidator instance
Returns EntityValidator
insert
Fires native insert query. Calling this has no side effects on the context (identity map).
Type parameters
- Entity: object
Parameters
entityNameOrEntity: Entity | EntityName<Entity>
optionaldata: Entity | RequiredEntityData<Entity>
options: NativeInsertUpdateOptions<Entity> = {}
Returns Promise<Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity ? ReadonlyPrimary<UnwrapPrimary<Entity[PK]>> : PK extends keyof Entity[] ? ReadonlyPrimary<PrimaryPropToType<Entity, PK>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity>
insertMany
Fires native multi-insert query. Calling this has no side effects on the context (identity map).
Type parameters
- Entity: object
Parameters
entityNameOrEntities: EntityName<Entity> | Entity[]
optionaldata: Entity[] | RequiredEntityData<Entity>[]
options: NativeInsertUpdateOptions<Entity> = {}
Returns Promise<(Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity ? ReadonlyPrimary<UnwrapPrimary<Entity[PK]>> : PK extends keyof Entity[] ? ReadonlyPrimary<PrimaryPropToType<Entity, PK>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity)[]>
isInTransaction
Checks whether this EntityManager is currently operating inside a database transaction.
Returns boolean
lock
Runs your callback wrapped inside a database transaction.
Type parameters
- T: object
Parameters
entity: T
lockMode: LockMode
options: number | Date | LockOptions = {}
Returns Promise<void>
map
Maps raw database result to an entity and merges it to this EntityManager.
Type parameters
- Entity: object
Parameters
entityName: EntityName<Entity>
result: EntityDictionary<Entity>
options: { schema?: string } = {}
Returns Entity
merge
Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities via second parameter. By default, it will return already loaded entities without modifying them.
Type parameters
- Entity: object
Parameters
entity: Entity
optionaloptions: MergeOptions
Returns Entity
nativeDelete
Fires native delete query. Calling this has no side effects on the context (identity map).
Type parameters
- Entity: object
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
options: DeleteOptions<Entity> = {}
Returns Promise<number>
nativeUpdate
Fires native update query. Calling this has no side effects on the context (identity map).
Type parameters
- Entity: object
Parameters
entityName: EntityName<Entity>
where: FilterQuery<NoInfer>
data: EntityData<Entity>
options: UpdateOptions<Entity> = {}
Returns Promise<number>
persist
Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation.
Type parameters
- Entity: object
Parameters
Returns this
persistAndFlush
populate
Loads specified relations in batch. This will execute one query for each relation, that will populate it on all the specified entities.
Type parameters
- Entity: object
- Naked: any = FromEntityType<UnboxArray<Entity>>
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entities: Entity
populate: false | AutoPath<Naked, Hint, ALL>[]
options: EntityLoaderOptions<Naked, Fields, Excludes> = {}
Returns Promise<Entity extends object[] ? MergeLoaded<ArrayElement<Entity>, Naked, Hint, Fields, Excludes>[] : MergeLoaded<Entity, Naked, Hint, Fields, Excludes>>
refresh
Refreshes the persistent state of an entity from the database, overriding any local changes that have not yet been persisted. Returns the same entity instance (same object reference), but re-hydrated. If the entity is no longer in database, the method returns
null.Type parameters
- Entity: object
- Naked: object = FromEntityType<Entity>
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entity: Entity
options: FindOneOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<null | MergeLoaded<Entity, Naked, Hint, Fields, Excludes, true>>
refreshOrFail
Refreshes the persistent state of an entity from the database, overriding any local changes that have not yet been persisted. Returns the same entity instance (same object reference), but re-hydrated. If the entity is no longer in database, the method throws an error just like
em.findOneOrFail()(and respects the same config options).Type parameters
- Entity: object
- Naked: object = FromEntityType<Entity>
- Hint: string = never
- Fields: string = *
- Excludes: string = never
Parameters
entity: Entity
options: FindOneOrFailOptions<Entity, Hint, Fields, Excludes> = {}
Returns Promise<MergeLoaded<Entity, Naked, Hint, Fields, Excludes, true>>
remove
Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation.
To remove entities by condition, use
em.nativeDelete().Type parameters
- Entity: object
Parameters
Returns this
removeAndFlush
repo
Shortcut for
em.getRepository().Type parameters
- Entity: object
- Repository: EntityRepository<Entity> = EntityRepository<Entity>
Parameters
entityName: EntityName<Entity>
Returns GetRepository<Entity, Repository>
resetTransactionContext
Resets the transaction context.
Returns void
rollback
Rollbacks the transaction bound to this EntityManager.
Returns Promise<void>
setFilterParams
Sets filter parameter values globally inside context defined by this entity manager. If you want to set shared value for all contexts, be sure to use the root entity manager.
Parameters
name: string
args: Dictionary
Returns void
setFlushMode
Parameters
optionalflushMode: FlushMode
Returns void
setLoggerContext
Sets logger context for this entity manager.
Parameters
context: Dictionary
Returns void
setTransactionContext
Sets the transaction context.
Parameters
ctx: any
Returns void
transactional
Runs your callback wrapped inside a database transaction.
Type parameters
- T
Parameters
cb: (em: this) => Promise<T>
options: TransactionOptions = {}
Returns Promise<T>
upsert
Creates or updates the entity, based on whether it is already present in the database. This method performs an
insert on conflict mergequery ensuring the database is in sync, returning a managed entity instance. The method accepts eitherentityNametogether with the entitydata, or just entity instance.// insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
const author = await em.upsert(Author, { email: 'foo@bar.com', age: 33 });The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where
Author.emailis a unique property:// insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
// select "id" from "author" where "email" = 'foo@bar.com'
const author = await em.upsert(Author, { email: 'foo@bar.com', age: 33 });Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the
data.If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit
flushwill be required for those changes to be persisted.Type parameters
- Entity: object
Parameters
entityNameOrEntity: Entity | EntityName<Entity>
optionaldata: EntityData<Entity> | NoInfer
options: UpsertOptions<Entity> = {}
Returns Promise<Entity>
upsertMany
Creates or updates the entity, based on whether it is already present in the database. This method performs an
insert on conflict mergequery ensuring the database is in sync, returning a managed entity instance. The method accepts eitherentityNametogether with the entitydata, or just entity instance.// insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
const authors = await em.upsertMany(Author, [{ email: 'foo@bar.com', age: 33 }, ...]);The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where
Author.emailis a unique property:// insert into "author" ("age", "email") values (33, 'foo@bar.com'), (666, 'lol@lol.lol') on conflict ("email") do update set "age" = excluded."age"
// select "id" from "author" where "email" = 'foo@bar.com'
const author = await em.upsertMany(Author, [
{ email: 'foo@bar.com', age: 33 },
{ email: 'lol@lol.lol', age: 666 },
]);Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the
data.If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit
flushwill be required for those changes to be persisted.Type parameters
- Entity: object
Parameters
entityNameOrEntity: EntityName<Entity> | Entity[]
optionaldata: (EntityData<Entity> | NoInfer)[]
options: UpsertManyOptions<Entity> = {}
Returns Promise<Entity[]>
The EntityManager is the central access point to ORM functionality. It is a facade to all different ORM subsystems such as UnitOfWork, Query Language, and Repository API.