Event Store logo

Menu

Documentation

Show Table of Contents

Writing to a Stream

TThe client API can be used to write one or more events to a stream atomically. This can be done either by appending the events to the stream in one operation, or by starting a transaction on the stream, writing events in one or more operations in that transaction, and then committing the transaction.

An optimistic concurrency check can be made during the write by specifying the version at which the stream is expected to be currently. Identical write operations are idempotent if the optimistic concurrency check is not disabled. More information on optimistic concurrency and idempotence can be found here.

Methods

Appending to a stream in a single write

Task<WriteResult> AppendToStreamAsync(string stream, long expectedVersion, IEnumerable<EventData> events)
Task<WriteResult> AppendToStreamAsync(string stream, long expectedVersion, params EventData[] events)

Using a transaction to append to a stream across multiple writes

On EventStoreConnection:

Task<EventStoreTransaction> StartTransactionAsync(string stream, long expectedVersion)
EventStoreTransaction ContinueTransaction(long transactionId)

On EventStoreTransaction:

Task WriteAsync(IEnumerable<EventData> events)
Task WriteAsync(params EventData[] events)
Task CommitAsync()
void Rollback()

EventData

The writing methods all use a type named EventData to represent an event to be stored. Instances of EventData are immutable.

The Event Store does not have any built-in serialization, so the body and metadata for each event are represented in EventData as a byte[].

The members on EventData are:

Member Description
Guid EventId A unique identifier representing this event. This is used internally for idempotency if you write the same event twice you should use the same identifier both times.
string Type The name of the event type. This can be used later for pattern matching in projections, so should be a “friendly” name rather than a CLR type name, for example.</code>
bool IsJson If the data and metadata fields are serialized as JSON, this should be set to true. Setting this to `true` will cause the projections framework to attempt to deserialize the data and metadata later.
byte[] Data The serialized data representing the event to be stored.
byte[] Metadata The serialized data representing metadata about the event to be stored.

Appending to a stream in a single write

The AppendToStreamAsync method writes events atomically to the end of a stream, working in an async manner.

The parameters are:

Parameter Description
string stream The name of the stream to which to append.
long expectedVersion The version at which we currently expect the stream to be in order that an optimistic concurrency check can be performed. This should either be a positive integer, or one of the constants `ExpectedVersion.NoStream`, `ExpectedVersion.EmptyStream`, or to disable the check, `ExpectedVersion.Any`. See here for a broader discussion of this.
IEnumerable<EventData> events The events to append. There is also an overload of each method which takes the events as a `params` array.

Event Store docs are hosted on GitHub. The repository is public and it’s open to issues and pull requests. Contributions, corrections and feedback are all welcome.