API Reference Spear v1.4.0

modules

Modules

A sharp EventStoreDB 20+ client backed by mint

A struct representing an access control list (ACL)

A data structure representing the response to a batch-append request

A macro for defining a module which represents a connection to an EventStoreDB

A struct representing a member of a cluster of EventStoreDBs

A GenServer which brokers a connection to an EventStoreDB

A simplified event struct

A structure representing how an append request's expectations were violated

A server-side filter to apply when reading events from an EventStoreDB

A struct representing a checkpoint in server-side filtering

A struct representing a persistent subscription and its settings

A struct representing information pertaining to a persistent subscription.

A struct representing information pertaining to a connection established to a PersistentSubscription.

A struct representing possible settings for a persistent subscription

A data structure representing a position in the $all stream

A record-like wrapper around google protobufs

A record macro interface for interacting with the EventStoreDB Gossip API

A record macro interface for interacting with the EventStoreDB Streams API

A record macro interface for interacting with the EventStoreDB Operations API

A record macro interface for interacting with the EventStoreDB Persistent Subscriptions API

A record macro interface for interacting with the EventStoreDB Projections API

A record macro interface for interacting with the EventStoreDB ServerFeatures API introduced in server version v21.10.0

Shared record definitions for EventStoreDB messages

A record macro interface for interacting with the google.rpc.Status type used in the protos

A record macro interface for interacting with the EventStoreDB Streams API

A record macro interface for interacting with the EventStoreDB Users API

A struct representing a scavenge and its progress

A struct for describing the metadata about a stream

A struct representing supported RPC in the currently connected EventStoreDB

A struct representing an EventStoreDB user