eventstore_client library

A community developed gRPC client library for EventStoreDB

Classes

Api
ApiFeature
Class that defines EventStore gRPC client features by ApiVersion as semantic version constraint.
ApiVersions
BatchWriteErrorResult
BatchWriteResult
BatchWriteSuccessResult
ClusterInfo
ContentTypes
Defaults
DeleteResult
EndPoint
A class representing an EventStoreDB host
EndpointDiscoverer
A base class for discovering an EndPoint used to communicate with EventStoreDB.
EventData
Represents an event to be written to a stream
EventRecord
Represents a previously written event.
EventStoreClient
EventStoreClientBase
EventStoreClientConnectionString
EventStoreClientOperationOptions
A class representing the options to apply to an individual operation.
EventStoreClientSettings
EventStoreGossipClient
EventStoreMonitoringClient
EventStoreOperationsClient
EventStorePersistentSubscriptionsClient
Class implementing the Persistent Subscriptions API
EventStoreProjectionsClient
Class implementing the Projections Management API..
EventStoreStreamsClient
EventStoreUsersClient
EventStreamSubscription
A class representing a ResolvedEvent stream subscription.
EventTypeFilter
A structure representing a filter on event types for read operations.
Exceptions
GossipBasedEndpointDiscoverer
A class for discovering an EndPoint using the Gossip api based on
Headers
ImageTags
LinkToEvent
Event received by subscriptions if event is a link to another
LogPosition
A class referring to a potential logical record position in the Event Store transaction file.
MemberInfo
Metadata
PersistentSubscription
Represents a persistent subscription connection.
PersistentSubscriptionSettings
A class representing the settings of a persistent subscription.
Position
Represents the position in a stream or transaction file
PrefixFilterExpression
A structure representing a prefix (i.e., starts with) filter.
ProjectionDetails
Provides the details for a projection.
Projections
Utility class for projections
ReadEventsResult
An interface representing the result of a read operation.
ReadFilter
An interface that represents a search filter, used for read operations.
RegularFilterExpression
A structure representing a regular expression filter.
ResolvedEvent
A structure representing a single event or a resolved link event.
ScavengeResult
SettingsEvent
Event received by subscriptions to system settings streams
SingleNodeEndpointDiscoverer
Stats
Map of stats from server
StatsCollectionEvent
Event received by subscriptions to system statistics stream
StreamAcl
Represents an access control list for a stream
StreamDeletedEvent
Event received by subscriptions if the stream is tombstoned (hard delete)
StreamFilter
A structure representing a filter on stream names for read operations.
StreamMetadata
A structure representing a stream's custom metadata with strongly typed properties for system values and a dictionary-like interface for custom values.
StreamMetadataEvent
Event received by subscriptions to metadata streams
StreamMetadataResult
Represents stream metadata as a series of properties for system data (e.g., MaxAge) and a StreamMetadata object for user metadata.
StreamPosition
A class referring to an EventRecord's position within a stream.
StreamRevision
A class referring to the expected stream revision when writing to a stream.
StreamState
SubscriptionCheckPoint
A class representing a checkpoint LogPosition reached by a EventStreamSubscription
SubscriptionDroppedEvent
Event with information about reason for dropping subscription
SubscriptionFilterOptions
A class representing the options to use with server-side filtering. Server-side filtering is currently only supported on the SystemStreams.AllStream. Use checkpointInterval to control how often the server should send a checkpoint of current LogPosition of the SystemStreams.AllStream (default is every Defaults.CheckpointInterval events). This is useful in situations where the filter matches very few events of potential millions. If the client need to restart the subscription, the last checkpoint could be used to prevent replaying the filter on millions events again. You can pass a SubscriptionCheckpointCallback that is invoked and awaited when a checkpoint is reached. You can also listen the the EventStreamSubscription.checkpoints in EventStreamSubscription.
SystemEvents
Constants for System event types
SystemGroups
SystemMetadata
Constants for information in stream metadata
SystemProjections
SystemStreams
A collection of constants and methods to identify streams.
TlsSetup
UserCredentials
UserDetails
UuidV4
An RFC-4122 compliant v4 UUID.
Versions
WriteNotSupportedResult
WriteResult
An interface representing the result of a write operation.
WriteSuccessResult
WrongExpectedVersionResult

Enums

NodePreference
Indicates the preferred EventStoreDB node type to connect to.
PersistentSubscriptionNackEventAction
Actions to be taken by server in the case of a client NAK of ResolvedEvent
ProjectionStatus
ReadState
ScavengeState
StreamStateType
Indicates the state of a stream
SubscriptionDroppedReason
SystemConsumerStrategies
System supported consumer strategies for use with persistent subscriptions.
VNodeState
Member node states

Constants

End → const int
Constant value for LogPosition.end
Max → const int
Use the (signed) 64-bit (2^64-1) integer maximum value that EventStoreDB uses for last log position.

Properties

packageVersion ↔ String
GENERATED BY pub_release do not modify. eventstore_client version
getter/setter pair

Functions

$mergedCallOptionsWith(EventStoreClientSettings settings, {CallOptions? options, Duration? timeoutAfter, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → CallOptions

Typedefs

BadCertificateHandler = bool Function(X509Certificate certificate, String host, int port)
Handler for checking certificates that fail validation. If this handler returns true, the bad certificate is allowed, and the TLS handshake can continue. If the handler returns false, the TLS handshake fails, and the connection is aborted.
GrpcErrorCallback = Exception Function(GrpcError error)
JsonDocument = dynamic
PersistentSubscriptionResolvedEventCallback = Future<void> Function(PersistentSubscription subscription, ResolvedEvent event, int replayCount)
SubscriptionCheckpointCallback = Future<void> Function(SubscriptionCheckPoint)
SubscriptionDroppedCallback = Future<void> Function(EventStreamSubscription subscription, SubscriptionDroppedEvent event)
SubscriptionResolvedEventCallback = Future<void> Function(EventStreamSubscription subscription, ResolvedEvent event)
ValueGetter<T> = T Function()
ValueSetter<T> = void Function(T)

Exceptions / Errors

AccessDeniedException
Exception thrown when a user is not authorised to carry out an operation.
ArgumentOutOfRangeException
CertificateVerifyFailed
Exception thrown when TLS certificate verification failed
ConnectionStringParseException
DiscoveryException
The exception that is thrown when EndPoint discovery fails.
DuplicateKeyException
The exception that is thrown when a key in the EventStoreClientConnectionString is duplicated.
FeatureNotSupportedException
Exception thrown when a feature is invoked on a ApiVersion it does not support.
GrpcOperationUnsupportedException
HostCertificateNotFound
InvalidHostException
The exception that is thrown when an invalid key value pair is found when parsing an EventStoreClientConnectionString.
InvalidKeyValuePairException
The exception that is thrown when an invalid key value pair is found when parsing an EventStoreClientConnectionString.
InvalidSchemeException
The exception that is thrown when no scheme was specified in an EventStoreClientConnectionString.
InvalidTransactionException
Exception thrown if there is an attempt to operate inside a transaction which does not exist.
InvalidUserCredentialsParseException
The exception that is thrown when a key in the EventStoreClientConnectionString is duplicated.
MaximumAppendSizeExceededException
Exception thrown when an append exceeds the maximum size set by the server.
MaximumSubscribersReachedException
The exception that is thrown when the maximum number of subscribers on a persistent subscription is exceeded.
NoSchemeException
The exception that is thrown when no scheme was specified in an EventStoreClientConnectionString.
NotAuthenticatedException
The exception that is thrown when a user is not authenticated.
NotLeaderException
This exception is thrown when an operation requiring a leader node is made on a follower node.
PersistentSubscriptionDroppedException
The exception that is thrown when the EventStoreDB drops a persistent subscription.
PersistentSubscriptionExistsException
The exception that is thrown when a persistent subscription already exists
PersistentSubscriptionFailedException
The exception that is thrown when a persistent subscription fails.
PersistentSubscriptionNotFoundException
The exception that is thrown when a persistent subscription is not found.
RequiredMetadataPropertyMissingException
Exception thrown when a required metadata property is missing.
ScavengeNotFoundException
Exception thrown if scavenge with given scavengeId was not found.
StreamDeletedException
Exception thrown if an operation is attempted on a stream which has been deleted.
StreamNotFoundException
The exception that is thrown when an attempt is made to read or write to a stream that does not exist.
UnsupportedApiVersionException
The exception that is thrown when MemberInfo.apiVersion does not support requested EventStoreClientSettings.apiVersion.
UserConflictException
Exception thrown if user with given loginName already exists.
UserNotFoundException
Exception thrown if user with given loginName was not found.
WrongExpectedVersionException
Exception thrown if the expected version specified on an operation does not match the version of the stream when the operation was attempted.