Struct Client

pub struct Client { /* private fields */ }

Represents a client to a single node. Client maintains a full duplex communication to KurrentDB.

Many threads can use a KurrentDB client at the same time or a single thread can make many asynchronous requests.

Implementations

impl Client

pub fn new(settings: ClientSettings) -> Result<Self>

Creates a gRPC client to a KurrentDB database.

pub fn with_runtime_handle( handle: Handle, settings: ClientSettings, ) -> Result<Self>

Creates a gRPC client to a KurrentDB database using an existing tokio runtime.

pub fn settings(&self) -> &ClientSettings

pub async fn server_info(&self) -> Result<ServerInfo>

Returns the server information the client is connected to. If None, means you are dealing with a server older than 21.6 version.

pub async fn append_to_stream<Events>( &self, stream_name: impl StreamName, options: &AppendToStreamOptions, events: Events, ) -> Result<WriteResult>

where Events: ToEvents,

Sends events to a given stream.

pub async fn set_stream_metadata( &self, name: impl MetadataStreamName, options: &AppendToStreamOptions, metadata: &StreamMetadata, ) -> Result<WriteResult>

pub async fn batch_append( &self, options: &BatchAppendOptions, ) -> Result<BatchAppendClient>

pub async fn read_stream( &self, stream_name: impl StreamName, options: &ReadStreamOptions, ) -> Result<ReadStream>

Reads events from a given stream. The reading can be done forward and backward.

pub async fn read_all(&self, options: &ReadAllOptions) -> Result<ReadStream>

Reads events for the system stream $all. The reading can be done forward and backward.

pub async fn get_stream_metadata( &self, name: impl MetadataStreamName, options: &ReadStreamOptions, ) -> Result<StreamMetadataResult>

Reads a stream metadata.

pub async fn delete_stream( &self, stream_name: impl StreamName, options: &DeleteStreamOptions, ) -> Result<Option<Position>>

Soft deletes a given stream. Makes use of Truncate before. When a stream is deleted, its Truncate before is set to the streams current last event number. When a soft deleted stream is read, the read will return a StreamNotFound. After deleting the stream, you are able to write to it again, continuing from where it left off.

pub async fn tombstone_stream( &self, stream_name: impl StreamName, options: &TombstoneStreamOptions, ) -> Result<Option<Position>>

Hard deletes a given stream. A hard delete writes a tombstone event to the stream, permanently deleting it. The stream cannot be recreated or written to again. Tombstone events are written with the event type ‘$streamDeleted’. When a hard deleted stream is read, the read will return a StreamDeleted.

pub async fn subscribe_to_stream( &self, stream_name: impl StreamName, options: &SubscribeToStreamOptions, ) -> Subscription

Subscribes to a given stream. This kind of subscription specifies a starting point (by default, the beginning of a stream). For a regular stream, that starting point will be an event number. For the system stream $all, it will be a position in the transaction file (see subscribe_to_all). This subscription will fetch every event until the end of the stream, then will dispatch subsequently written events.

For example, if a starting point of 50 is specified when a stream has 100 events in it, the subscriber can expect to see events 51 through 100, and then any events subsequently written events until such time as the subscription is dropped or closed.

pub async fn subscribe_to_all( &self, options: &SubscribeToAllOptions, ) -> Subscription

Like subscribe_to_stream but specific to system $all stream.

pub async fn create_persistent_subscription( &self, stream_name: impl StreamName, group_name: impl AsRef<str>, options: &PersistentSubscriptionOptions, ) -> Result<()>

Creates a persistent subscription group on a stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state.

pub async fn create_persistent_subscription_to_all( &self, group_name: impl AsRef<str>, options: &PersistentSubscriptionToAllOptions, ) -> Result<()>

Creates a persistent subscription group on a the $all stream.

pub async fn update_persistent_subscription( &self, stream_name: impl StreamName, group_name: impl AsRef<str>, options: &PersistentSubscriptionOptions, ) -> Result<()>

Updates a persistent subscription group on a stream.

pub async fn update_persistent_subscription_to_all( &self, group_name: impl AsRef<str>, options: &PersistentSubscriptionToAllOptions, ) -> Result<()>

Updates a persistent subscription group to $all.

pub async fn delete_persistent_subscription( &self, stream_name: impl StreamName, group_name: impl AsRef<str>, options: &DeletePersistentSubscriptionOptions, ) -> Result<()>

Deletes a persistent subscription group on a stream.

pub async fn delete_persistent_subscription_to_all( &self, group_name: impl AsRef<str>, options: &DeletePersistentSubscriptionOptions, ) -> Result<()>

Deletes a persistent subscription group on the $all stream.

pub async fn subscribe_to_persistent_subscription( &self, stream_name: impl StreamName, group_name: impl AsRef<str>, options: &SubscribeToPersistentSubscriptionOptions, ) -> Result<PersistentSubscription>

Connects to a persistent subscription group on a stream.

pub async fn subscribe_to_persistent_subscription_to_all( &self, group_name: impl AsRef<str>, options: &SubscribeToPersistentSubscriptionOptions, ) -> Result<PersistentSubscription>

Connects to a persistent subscription group to $all stream.

pub async fn replay_parked_messages( &self, stream_name: impl AsRef<str>, group_name: impl AsRef<str>, options: &ReplayParkedMessagesOptions, ) -> Result<()>

Replays a persistent subscriptions parked events.

pub async fn replay_parked_messages_to_all( &self, group_name: impl AsRef<str>, options: &ReplayParkedMessagesOptions, ) -> Result<()>

Replays a persistent subscriptions to $all parked events.

pub async fn list_all_persistent_subscriptions( &self, options: &ListPersistentSubscriptionsOptions, ) -> Result<Vec<PersistentSubscriptionInfo<RevisionOrPosition>>>

Lists all persistent subscriptions to date.

pub async fn list_persistent_subscriptions_for_stream( &self, stream_name: impl AsRef<str>, options: &ListPersistentSubscriptionsOptions, ) -> Result<Vec<PersistentSubscriptionInfo<u64>>>

List all persistent subscriptions of a specific stream.

pub async fn list_persistent_subscriptions_to_all( &self, options: &ListPersistentSubscriptionsOptions, ) -> Result<Vec<PersistentSubscriptionInfo<Position>>>

List all persistent subscriptions of the $all stream.

pub async fn get_persistent_subscription_info( &self, stream_name: impl AsRef<str>, group_name: impl AsRef<str>, options: &GetPersistentSubscriptionInfoOptions, ) -> Result<PersistentSubscriptionInfo<u64>>

pub async fn get_persistent_subscription_info_to_all( &self, group_name: impl AsRef<str>, options: &GetPersistentSubscriptionInfoOptions, ) -> Result<PersistentSubscriptionInfo<Position>>

pub async fn restart_persistent_subscription_subsystem( &self, options: &RestartPersistentSubscriptionSubsystem, ) -> Result<()>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Client> for Client

fn from(src: Client) -> Self

Converts to this type from the input type.

impl From<Client> for ProjectionClient

fn from(src: Client) -> Self

Converts to this type from the input type.