sec.api

AllMessage represents different kind of messages that you get when reading from the global stream.

There are two variants:

• AllMessage.Event A regular AllEvent.
• AllMessage.LastAllStreamPosition The last position in the global, sec.StreamId.All, stream.

Checkpoint result used with server-side filtering in EventStoreDB. Contains the LogPosition.Exact when the checkpoint was made.

Used for information about the nodes in an EventStoreDB cluster.

The LogPosition.Exact of the delete in the transaction log.

Direction used when reading from a stream with variants:

• Direction.Forwards when you wish to read forwards.
• Direction.Backwards when you wish to read backwards. This is useful when reading the latest StreamPosition.Exact value of a particular stream.

Endpoint can be an IP Socket Address consisting of an IP address and port number. It can also be a hostname and a port number, in which case an attempt will be made to resolve the hostname.

Used for server-side event stream filtering. There are two kinds of filters:

• EventFilter.ByStreamId when you wish to filter by stream identifier.
• EventFilter.ByEventType when you wish to filter by event type.

In combination with EventFilter.Kind you can choose between two types of filter expressions:

• EventFilter.PrefixFilter when you wish to filter for prefixes. An example of this is PrefixFilter("user_stream") for streams starting with the string value "user_stream" like "user_stream-a" and "user_stream-b".

• EventFilter.RegexFilter when you wish to filter with a regular expression. An example of this is RegexFilter("^[^$].*") when you for do not wish to retrieve events starting with $.

Used in conjunction with cluster connections where you provide a preference about what state a node should be in.

There are three variants:

• NodePreference.Leader When you prefer the node you connect to is in a VNodeState.Leader state. This is, for instance, used when you wish to avoid unecessary network hops when appending data.

• NodePreference.Follower When you prefer the node you connect to is in a VNodeState.Follower state. This is useful in situations where you wish to get fast subscription updates for a read model.

• NodePreference.ReadOnlyReplica When you prefer the node you connect to is in a VNodeState.ReadOnlyReplica or VNodeState.ReadOnlyLeaderless state. This is useful when you wish to replicate data, but do not have requirements for fast updates or need to append data.

StreamMessage represents different kind of messages that you get when reading from a stream.

There are four variants:

• StreamMessage.Event A regular StreamEvent.
• StreamMessage.FirstStreamPosition The first position of a stream.
• StreamMessage.LastStreamPosition The last position of a stream.
• StreamMessage.NotFound Representing a stream that was not found.

The LogPosition.Exact of the tombstone in the transaction log.

Credentials used for EventStoreDB connections.

The current last StreamPosition.Exact of the stream appended to and its corresponding LogPosition.Exact in the transaction log.