Events

Constants

The preRemove event occurs for a given document before the respective
DocumentManager remove operation for that document is executed.

This is a document lifecycle event.

postRemove

The postRemove event occurs for a document after the document has
been deleted. It will be invoked after the database delete operations.

This is a document lifecycle event.

prePersist

The prePersist event occurs for a given document before the respective
DocumentManager persist operation for that document is executed.

This is a document lifecycle event.

postPersist

The postPersist event occurs for a document after the document has
been made persistent. It will be invoked after the database insert operations.

Generated primary key values are available in the postPersist event.

This is a document lifecycle event.

preUpdate

The preUpdate event occurs before the database update operations to
document data.

This is a document lifecycle event.

postUpdate

The postUpdate event occurs after the database update operations to
document data.

This is a document lifecycle event.

preLoad

The preLoad event occurs for a document before the document has been loaded
into the current DocumentManager from the database or before the refresh operation
has been applied to it.

This is a document lifecycle event.

postLoad

The postLoad event occurs for a document after the document has been loaded
into the current DocumentManager from the database or after the refresh operation
has been applied to it.

Note that the postLoad event occurs for a document before any associations have been
initialized. Therefore it is not safe to access associations in a postLoad callback
or event handler.

This is a document lifecycle event.

loadClassMetadata

The loadClassMetadata event occurs after the mapping metadata for a class
has been loaded from a mapping source (annotations/xml/yaml).

preFlush

The preFlush event occurs when the DocumentManager#flush() operation is invoked,
but before any changes to managed documents have been calculated. This event is
always raised right after DocumentManager#flush() call.

onFlush

The onFlush event occurs when the DocumentManager#flush() operation is invoked,
after any changes to managed documents have been determined but before any
actual database operations are executed. The event is only raised if there is
actually something to do for the underlying UnitOfWork. If nothing needs to be done,
the onFlush event is not raised.

postFlush

The postFlush event occurs when the DocumentManager#flush() operation is invoked and
after all actual database operations are executed successfully. The event is only raised if there is
actually something to do for the underlying UnitOfWork. If nothing needs to be done,
the postFlush event is not raised. The event won't be raised if an error occurs during the
flush operation.

onClear

The onClear event occurs when the DocumentManager#clear() operation is invoked,
after all references to documents have been removed from the unit of work.

documentNotFound

The documentNotFound event occurs if a proxy object could not be found in
the database.

postCollectionLoad

The postCollectionLoad event occurs after collection is initialized (loaded).