IWriteEventAdapter Interface

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 (in Akka.Persistence.dll) Version: 1.2.3.42 (1.2.3.42)

Syntax

public interface IWriteEventAdapter

type IWriteEventAdapter =  interface end

The IWriteEventAdapter type exposes the following members.

Methods

	Name	Description
	Manifest	Return the manifest (type hint) that will be provided in the FromJournal(Object, String) method. Use empty string if not needed.
	ToJournal	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.