eventstore v0.7.2 EventStore
EventStore client API to read & write events to a logical event stream and subscribe to event notifications
Example usage
# ensure the event store application has been started
Application.ensure_all_started(:eventstore)
# append events to a stream
:ok = EventStore.append_to_stream(stream_uuid, expected_version, events)
# read all events from a stream, starting at the beginning
{:ok, recorded_events} = EventStore.read_stream_forward(stream_uuid)
Summary
Functions
Append one or more events to a stream atomically. Returns :ok on success
Delete a previously recorded snapshop for a given source
Reads the requested number of events from all streams, in the order in which they were originally written
Read a snapshot, if available, for a given source
Reads the requested number of events from the given stream, in the order in which they were originally written
Record a snapshot of the data and metadata for a given source
Record a snapshot of the data and metadata for a given source
Streams events from all streams, in the order in which they were originally written
Subscriber will be notified of every event persisted to any stream
Subscriber will be notified of each batch of events persisted to a single stream
Unsubscribe an existing subscriber from all event notifications
Unsubscribe an existing subscriber from event notifications
Types
Functions
append_to_stream(String.t, non_neg_integer, [EventStore.EventData.t]) :: :ok | {:error, reason :: term}
Append one or more events to a stream atomically. Returns :ok on success.
stream_uuidis used to uniquely identify a stream.expected_versionis used for optimistic concurrency. Specify 0 for the creation of a new stream. An{:error, wrong_expected_version}response will be returned if the stream already exists. Any positive number will be used to ensure you can only append to the stream if it is at exactly that version.eventsis a list of%EventStore.EventData{}structs.
Delete a previously recorded snapshop for a given source
Returns :ok on success, or when the snapshot does not exist
read_all_streams_forward(non_neg_integer, non_neg_integer) ::
{:ok, [EventStore.RecordedEvent.t]} |
{:error, reason :: term}
Reads the requested number of events from all streams, in the order in which they were originally written.
start_event_idoptionally, the id of the first event to read. Defaults to the beginning of the stream if not set.countoptionally, the maximum number of events to read. If not set it will be limited to returning 1,000 events from all streams.
read_snapshot(String.t) :: {:ok, EventStore.Snapshots.SnapshotData.t} | {:error, :snapshot_not_found}
Read a snapshot, if available, for a given source.
Returns {:ok, %EventStore.Snapshots.SnapshotData{}} on success, or {:error, :snapshot_not_found} when unavailable.
read_stream_forward(String.t, non_neg_integer, non_neg_integer) :: {:ok, [EventStore.RecordedEvent.t]} | {:error, reason :: term}
Reads the requested number of events from the given stream, in the order in which they were originally written.
stream_uuidis used to uniquely identify a stream.start_versionoptionally, the version number of the first event to read. Defaults to the beginning of the stream if not set.countoptionally, the maximum number of events to read. If not set it will be limited to returning 1,000 events from the stream.
record_snapshot(EventStore.Snapshots.SnapshotData.t) :: :ok | {:error, reason :: term}
Record a snapshot of the data and metadata for a given source
Returns :ok on success
record_snapshot(EventStore.Snapshots.SnapshotData.t, timeout :: integer) :: :ok | {:error, reason :: term}
Record a snapshot of the data and metadata for a given source
timeoutis an integer greater than zero which specifies how many milliseconds to wait for a reply, or the atom :infinity to wait indefinitely. The default value is 5000. If no reply is received within the specified time, the function call fails and the caller exits.
Returns :ok on success
stream_all_forward(non_neg_integer, non_neg_integer) :: Enumerable.t
Streams events from all streams, in the order in which they were originally written.
start_event_idoptionally, the id of the first event to read. Defaults to the beginning of the stream if not set.read_batch_sizeoptionally, the number of events to read at a time from storage. Defaults to reading 1,000 events per batch.
subscribe_to_all_streams(String.t, pid, start_from) :: {:ok, subscription :: pid} | {:error, :subscription_already_exists} | {:error, reason :: term}
Subscriber will be notified of every event persisted to any stream.
subscription_nameis used to uniquely identify the subscription.subscriberis a process that will be sent{:events, events, subscription}notification messages.
Returns {:ok, subscription} when subscription succeeds.
subscribe_to_stream(String.t, String.t, pid, start_from) :: {:ok, subscription :: pid} | {:error, :subscription_already_exists} | {:error, reason :: term}
Subscriber will be notified of each batch of events persisted to a single stream.
stream_uuidis the stream to subscribe to. Use the$allidentifier to subscribe to events from all streams.subscription_nameis used to uniquely identify the subscription.subscriberis a process that will be sent{:events, events, subscription}notification messages.
Returns {:ok, subscription} when subscription succeeds.
Unsubscribe an existing subscriber from all event notifications.
subscription_nameis used to identify the existing subscription to remove.
Returns :ok on success.