Interface IWriteEventAdapter

Facility to convert to specialised data models, as may be required by specialized persistence Journals.

Typical use cases include (but are not limited to):

- adding metadata, a.k.a. "tagging" - by wrapping objects into tagged counterparts

- manually converting to the Journals storage format, such as JSON, BSON or any specialised binary format

- splitting up large events into sequences of smaller ones

Namespace: Akka.Persistence.Journal
Assembly: Akka.Persistence.dll
Syntax
public interface IWriteEventAdapter

Methods

| Improve this Doc View Source

Manifest(Object)

Return the manifest (type hint) that will be provided in the FromJournal(Object, String) method. Use empty string if not needed.

Declaration
string Manifest(object evt)
Parameters
Type Name Description
Object evt

TBD
Returns
Type Description
String

TBD
| Improve this Doc View Source

ToJournal(Object)

Convert domain event to journal event type.

Some journal may require a specific type to be returned to them, for example if a primary key has to be associated with each event then a journal may require adapters to return "EventWithPrimaryKey(event, key)".

The ToJournal(Object) adaptation must be an 1-to-1 transformation. It is not allowed to drop incoming events during the toJournal adaptation.

Declaration
object ToJournal(object evt)
Parameters
Type Name Description
Object evt

the application-side domain event to be adapted to the journal model
Returns
Type Description
Object

the adapted event object, possibly the same object if no adaptation was performed

Extension Methods