Database.EventStore

Connection

data Connection

Represents a connection to a single EventStore node.

data ConnectionType

Gathers every connection type handled by the client.

Constructors

Static String Int

HostName and Port.

Cluster ClusterSettings

Dns ByteString (Maybe DnsServer) Int

Domain name, optional DNS server and port.

data Credentials

Holds login and password information.

Instances

Eq Credentials

Defined in Database.EventStore.Internal.Settings

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Show Credentials

Defined in Database.EventStore.Internal.Settings

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

data Settings

Global Connection settings

Constructors

Settings

Fields

• s_heartbeatInterval :: NominalDiffTime

  Maximum delay of inactivity before the client sends a heartbeat request.

• s_heartbeatTimeout :: NominalDiffTime

  Maximum delay the server has to issue a heartbeat response.

• s_requireMaster :: Bool

  On a cluster settings. Requires the master node when performing a write operation.

• s_retry :: Retry

  Retry strategy when failing to connect.

• s_reconnect_delay :: NominalDiffTime

  Delay before issuing a new connection request.

• s_ssl :: Maybe TLSSettings

  SSL settings.

• s_loggerType :: LogType

  Type of logging to use.

• s_loggerFilter :: LoggerFilter

  Restriction of what would be logged.

• s_loggerDetailed :: Bool

  Detailed logging output. Currently, it also indicates the location where the log occurred.

• s_operationTimeout :: NominalDiffTime

  Delay in which an operation will be retried if no response arrived.

• s_operationRetry :: Retry

  Retry strategy when an operation timeout.

• s_monitoring :: MonitoringBackend

  Monitoring backend abstraction. You could implement one targetting `ekg-core` for example. We will expose an `ekg-core` implementation as soon as `ekg-core` supports GHC 8.8.*.

• s_defaultConnectionName :: Maybe Text

  Default connection name.

• s_defaultUserCredentials :: Maybe Credentials

  Credentials to use for operations where other Credentials are not explicitly supplied.

data Retry

Represents reconnection strategy.

atMost :: Int -> Retry

Indicates how many times we should try to reconnect to the server. A value less than or equal to 0 means no retry.

keepRetrying :: Retry

Indicates we should try to reconnect to the server until the end of the Universe.

credentials

Arguments

:: ByteString

Login

-> ByteString

Password

-> Credentials

Creates a Credentials given a login and a password.

defaultSettings :: Settings

Default global settings.

• s_heartbeatInterval = 750 ms
• s_heartbeatTimeout = 1500 ms
• s_requireMaster = True
• s_retry = atMost 3
• s_reconnect_delay = 3 seconds
• s_ssl = Nothing
• s_loggerType = LogNone
• s_loggerFilter = LoggerLevel LevelInfo
• s_loggerDetailed = False
• s_operationTimeout = 10 seconds
• s_operationRetry = atMost 3
• s_monitoring = noopMonitoringBackend
• s_defaultConnectionName = Nothing
• s_defaultUserCredentials = Nothing

defaultSSLSettings :: TLSSettings -> Settings

Default SSL settings based on defaultSettings.

connect :: Settings -> ConnectionType -> IO Connection

Creates a new Connection to a single node. It maintains a full duplex connection to the EventStore. An EventStore Connection operates quite differently than say a SQL connection. Normally when you use an EventStore connection you want to keep the connection open for a much longer of time than when you use a SQL connection.

Another difference is that with the EventStore Connection all operations are handled in a full async manner (even if you call the synchronous behaviors). Many threads can use an EvenStore Connection at the same time or a single thread can make many asynchronous requests. To get the most performance out of the connection it is generally recommended to use it in this way.

shutdown :: Connection -> IO ()

Asynchronously closes the Connection.

waitTillClosed :: Connection -> IO ()

Waits the Connection to be closed.

connectionSettings :: Connection -> Settings

Returns a Connection 's Settings.

Cluster Connection

data ClusterSettings

Contains settings related to a connection to a cluster.

Constructors

ClusterSettings

Fields

• clusterDns :: !ByteString

  The DNS name to use for discovering endpoints.

• clusterMaxDiscoverAttempts :: !Int

  The maximum number of attempts for discovering endpoints.

• clusterExternalGossipPort :: !Int

  The well-known endpoint on which cluster managers are running.

• clusterGossipSeeds :: Maybe (NonEmpty GossipSeed)

  Endpoints for seeding gossip if not using DNS.

• clusterGossipTimeout :: !TimeSpan

  Timeout for cluster gossip.

• clusterDnsServer :: !(Maybe DnsServer)

  Indicates a specific DNS server should be contacted.

data DnsServer

Tells how the DNS server should be contacted.

Constructors

DnsFilePath String

DnsHostName String

DnsHostPort String Int

data GossipSeed

Represents a source of cluster gossip.

Instances

Show GossipSeed

Defined in Database.EventStore.Internal.Discovery

Methods

showsPrec :: Int -> GossipSeed -> ShowS

show :: GossipSeed -> String

showList :: [GossipSeed] -> ShowS

gossipSeed :: String -> Int -> GossipSeed

Creates a GossipSeed.

gossipSeedWithHeader :: String -> Int -> String -> GossipSeed

Creates a GossipSeed with a specific HTTP header.

gossipSeedHost :: GossipSeed -> String

Returns GossipSeed host IP address.

gossipSeedHeader :: GossipSeed -> String

The host header to be sent when requesting gossip.

gossipSeedPort :: GossipSeed -> Int

Returns GossipSeed port.

gossipSeedClusterSettings :: NonEmpty GossipSeed -> ClusterSettings

Configures a ClusterSettings for connecting to a cluster using gossip seeds. clusterDns = "" clusterMaxDiscoverAttempts = 10 clusterExternalGossipPort = 0 clusterGossipTimeout = 1s

dnsClusterSettings :: ByteString -> ClusterSettings

Configures a ClusterSettings for connecting to a cluster using DNS discovery. clusterMaxDiscoverAttempts = 10 clusterExternalGossipPort = 0 clusterGossipSeeds = Nothing clusterGossipTimeout = 1s

Event

data Event

Contains event information like its type and data. Only used for write queries.

Instances

Eq Event

Defined in Database.EventStore.Internal.Types

Methods

(==) :: Event -> Event -> Bool

(/=) :: Event -> Event -> Bool

Show Event

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data EventData

Holds event data.

Instances

Eq EventData

Defined in Database.EventStore.Internal.Types

Methods

(==) :: EventData -> EventData -> Bool

(/=) :: EventData -> EventData -> Bool

Show EventData

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> EventData -> ShowS

show :: EventData -> String

showList :: [EventData] -> ShowS

data EventType

Constants for System event types.

Constructors

StreamDeletedType

Event type for stream deleted.

StatsCollectionType

Event type for statistics.

LinkToType

Event type for linkTo.

StreamMetadataType

Event type for stream metadata.

SettingsType

Event type for the system settings.

UserDefined Text

Event defined by the user.

Instances

Eq EventType

Defined in Database.EventStore.Internal.Types

Methods

(==) :: EventType -> EventType -> Bool

(/=) :: EventType -> EventType -> Bool

Show EventType

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

IsString EventType

Defined in Database.EventStore.Internal.Types

Methods

fromString :: String -> EventType

createEvent

Arguments

:: EventType

Event type

-> Maybe UUID

Event ID, generated if Nothing

-> EventData

Event data

-> Event

Create an Event meant to be persisted.

withJson :: ToJSON a => a -> EventData

Creates an event using JSON format

withJsonAndMetadata :: (ToJSON a, ToJSON b) => a -> b -> EventData

Creates an event with metadata using JSON format.

withBinary :: ByteString -> EventData

Creates an event using a binary format.

withBinaryAndMetadata :: ByteString -> ByteString -> EventData

Creates an event with metadata using binary format.

Event number

data EventNumber

Represents an event position within a stream.

Instances

Eq EventNumber

Defined in Database.EventStore.Internal.Types

Methods

(==) :: EventNumber -> EventNumber -> Bool

(/=) :: EventNumber -> EventNumber -> Bool

Ord EventNumber

Defined in Database.EventStore.Internal.Types

Methods

compare :: EventNumber -> EventNumber -> Ordering

(<) :: EventNumber -> EventNumber -> Bool

(<=) :: EventNumber -> EventNumber -> Bool

(>) :: EventNumber -> EventNumber -> Bool

(>=) :: EventNumber -> EventNumber -> Bool

max :: EventNumber -> EventNumber -> EventNumber

min :: EventNumber -> EventNumber -> EventNumber

Show EventNumber

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> EventNumber -> ShowS

show :: EventNumber -> String

showList :: [EventNumber] -> ShowS

SubscriptionStream PersistentSubscription EventNumber

Defined in Database.EventStore.Internal.Subscription.Persistent

Methods

subscriptionStream :: PersistentSubscription -> StreamId EventNumber

streamStart :: EventNumber

The first event in a stream.

streamEnd :: EventNumber

The last event in the stream.

eventNumber :: Natural -> EventNumber

the Nth event of a stream.

rawEventNumber :: Int64 -> EventNumber

Returns a 'EventNumber from a raw Int64.

eventNumberToInt64 :: EventNumber -> Int64

Returns a raw Int64 from an EventNumber.

Read Operations

data StreamMetadataResult

Represents stream metadata as a series of properties for system data and a StreamMetadata object for user metadata.

Constructors

StreamMetadataResult

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

• streamMetaResultVersion :: !Int64

  The version of the metadata format.

• streamMetaResultData :: !StreamMetadata

  A StreamMetadata containing user-specified metadata.

NotFoundStreamMetadataResult

When the stream is either not found or 'no stream'.

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

DeletedStreamMetadataResult

When the stream is soft-deleted.

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

Instances

Show StreamMetadataResult

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> StreamMetadataResult -> ShowS

show :: StreamMetadataResult -> String

showList :: [StreamMetadataResult] -> ShowS

type family BatchResult t where ...

When batch-reading a stream, this type-level function maps the result you will have whether you read a regular stream or $all stream. When reading a regular stream, some read-error can occur like the stream got deleted. However read-error cannot occur when reading $all stream (because $all cannot get deleted).

Equations

BatchResult EventNumber = ReadResult EventNumber StreamSlice

BatchResult Position = AllSlice

data ResolveLink

Determines whether any link event encountered in the stream will be resolved. See the discussion for more information: https://eventstore.org/docs/dotnet-api/reading-events/index.html#resolvedevent

Constructors

ResolveLink

NoResolveLink

Instances

Eq ResolveLink

Defined in Database.EventStore.Internal.Types

Methods

(==) :: ResolveLink -> ResolveLink -> Bool

(/=) :: ResolveLink -> ResolveLink -> Bool

Show ResolveLink

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> ResolveLink -> ShowS

show :: ResolveLink -> String

showList :: [ResolveLink] -> ShowS

readEvent :: Connection -> StreamName -> EventNumber -> ResolveLink -> Maybe Credentials -> IO (Async (ReadResult EventNumber ReadEvent))

Reads a single event from given stream.

readEventsBackward

Arguments

:: Connection

-> StreamId t

-> t

-> Int32

Batch size

-> ResolveLink

-> Maybe Credentials

-> IO (Async (BatchResult t))

Reads events from a stream backward.

readEventsForward

Arguments

:: Connection

-> StreamId t

-> t

-> Int32

Batch size

-> ResolveLink

-> Maybe Credentials

-> IO (Async (BatchResult t))

Reads events from a stream forward.

getStreamMetadata :: Connection -> StreamName -> Maybe Credentials -> IO (Async StreamMetadataResult)

Asynchronously gets the metadata of a stream.

Write Operations

data StreamACL

Represents an access control list for a stream.

Constructors

StreamACL

Fields

• streamACLReadRoles :: !(Maybe [Text])

  Roles and users permitted to read the stream.

• streamACLWriteRoles :: !(Maybe [Text])

  Roles and users permitted to write to the stream.

• streamACLDeleteRoles :: !(Maybe [Text])

  Roles and users permitted to delete to the stream.

• streamACLMetaReadRoles :: !(Maybe [Text])

  Roles and users permitted to read stream metadata.

• streamACLMetaWriteRoles :: !(Maybe [Text])

  Roles and users permitted to write stream metadata.

Instances

Eq StreamACL

Defined in Database.EventStore.Internal.Types

Methods

(==) :: StreamACL -> StreamACL -> Bool

(/=) :: StreamACL -> StreamACL -> Bool

Show StreamACL

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> StreamACL -> ShowS

show :: StreamACL -> String

showList :: [StreamACL] -> ShowS

ToJSON StreamACL

Defined in Database.EventStore.Internal.Types

Methods

toJSON :: StreamACL -> Value

toEncoding :: StreamACL -> Encoding

toJSONList :: [StreamACL] -> Value

toEncodingList :: [StreamACL] -> Encoding

FromJSON StreamACL

Defined in Database.EventStore.Internal.Types

Methods

parseJSON :: Value -> Parser StreamACL

parseJSONList :: Value -> Parser [StreamACL]

data StreamMetadata

Represents stream metadata with strongly typed properties for system values and a dictionary-like interface for custom values.

Constructors

StreamMetadata

Fields

• streamMetadataMaxCount :: !(Maybe Int32)

  The maximum number of events allowed in the stream.

• streamMetadataMaxAge :: !(Maybe TimeSpan)

  The maximum age of events allowed in the stream.

• streamMetadataTruncateBefore :: !(Maybe Int32)

  The event number from which previous events can be scavenged. This is used to implement soft-deletion of streams.

• streamMetadataCacheControl :: !(Maybe TimeSpan)

  The amount of time for which the stream head is cachable.

• streamMetadataACL :: !(Maybe StreamACL)

  The access control list for the stream.

• streamMetadataCustom :: !Object

  An enumerable of key-value pairs of keys to JSON text for user-provider metadata.

Instances

Eq StreamMetadata

Defined in Database.EventStore.Internal.Types

Methods

(==) :: StreamMetadata -> StreamMetadata -> Bool

(/=) :: StreamMetadata -> StreamMetadata -> Bool

Show StreamMetadata

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> StreamMetadata -> ShowS

show :: StreamMetadata -> String

showList :: [StreamMetadata] -> ShowS

ToJSON StreamMetadata

Defined in Database.EventStore.Internal.Types

Methods

toJSON :: StreamMetadata -> Value

toEncoding :: StreamMetadata -> Encoding

toJSONList :: [StreamMetadata] -> Value

toEncodingList :: [StreamMetadata] -> Encoding

FromJSON StreamMetadata

Defined in Database.EventStore.Internal.Types

Methods

parseJSON :: Value -> Parser StreamMetadata

parseJSONList :: Value -> Parser [StreamMetadata]

getCustomPropertyValue :: StreamMetadata -> Text -> Maybe Value

Gets a custom property value from metadata.

getCustomProperty :: FromJSON a => StreamMetadata -> Text -> Maybe a

Get a custom property value from metadata.

emptyStreamACL :: StreamACL

StreamACL with no role or users whatsoever.

emptyStreamMetadata :: StreamMetadata

StreamMetadata with everything set to Nothing, using emptyStreamACL and an empty Object.

deleteStream

Arguments

:: Connection

-> StreamName

-> ExpectedVersion

-> Maybe Bool

Hard delete

-> Maybe Credentials

-> IO (Async DeleteResult)

Deletes given stream.

sendEvent :: Connection -> StreamName -> ExpectedVersion -> Event -> Maybe Credentials -> IO (Async WriteResult)

Sends a single Event to given stream.

sendEvents :: Connection -> StreamName -> ExpectedVersion -> [Event] -> Maybe Credentials -> IO (Async WriteResult)

Sends a list of Event to given stream.

setStreamMetadata :: Connection -> StreamName -> ExpectedVersion -> StreamMetadata -> Maybe Credentials -> IO (Async WriteResult)

Asynchronously sets the metadata for a stream.

Builder

type Builder a = Endo a

Allows to build a structure using Monoid functions.

Stream ACL Builder

type StreamACLBuilder = Builder StreamACL

A Builder applies to StreamACL.

buildStreamACL :: StreamACLBuilder -> StreamACL

Builds a StreamACL from a StreamACLBuilder.

modifyStreamACL :: StreamACLBuilder -> StreamACL -> StreamACL

Modifies a StreamACL using a StreamACLBuilder.

setReadRoles :: [Text] -> StreamACLBuilder

Sets role names with read permission for the stream.

setReadRole :: Text -> StreamACLBuilder

Sets a single role name with read permission for the stream.

setWriteRoles :: [Text] -> StreamACLBuilder

Sets role names with write permission for the stream.

setWriteRole :: Text -> StreamACLBuilder

Sets a single role name with write permission for the stream.

setDeleteRoles :: [Text] -> StreamACLBuilder

Sets role names with delete permission for the stream.

setDeleteRole :: Text -> StreamACLBuilder

Sets a single role name with delete permission for the stream.

setMetaReadRoles :: [Text] -> StreamACLBuilder

Sets role names with metadata read permission for the stream.

setMetaReadRole :: Text -> StreamACLBuilder

Sets a single role name with metadata read permission for the stream.

setMetaWriteRoles :: [Text] -> StreamACLBuilder

Sets role names with metadata write permission for the stream.

setMetaWriteRole :: Text -> StreamACLBuilder

Sets a single role name with metadata write permission for the stream.

Stream Metadata Builder

type StreamMetadataBuilder = Builder StreamMetadata

A Builder applies to StreamMetadata.

buildStreamMetadata :: StreamMetadataBuilder -> StreamMetadata

Builds a StreamMetadata from a StreamMetadataBuilder.

modifyStreamMetadata :: StreamMetadataBuilder -> StreamMetadata -> StreamMetadata

Modifies a StreamMetadata using a StreamMetadataBuilder

setMaxCount :: Int32 -> StreamMetadataBuilder

Sets the maximum number of events allowed in the stream.

setMaxAge :: TimeSpan -> StreamMetadataBuilder

Sets the maximum age of events allowed in the stream.

setTruncateBefore :: Int32 -> StreamMetadataBuilder

Sets the event number from which previous events can be scavenged.

setCacheControl :: TimeSpan -> StreamMetadataBuilder

Sets the amount of time for which the stream head is cachable.

setACL :: StreamACL -> StreamMetadataBuilder

Overwrites any previous StreamACL by the given one in a StreamMetadataBuilder.

modifyACL :: StreamACLBuilder -> StreamMetadataBuilder

Updates a StreamMetadata's StreamACL given a StreamACLBuilder.

setCustomProperty :: ToJSON a => Text -> a -> StreamMetadataBuilder

Sets a custom metadata property.

Transaction

data Transaction

Represents a multi-request transaction with the EventStore.

data TransactionId

The id of a Transaction.

Instances

Eq TransactionId

Defined in Database.EventStore.Internal

Methods

(==) :: TransactionId -> TransactionId -> Bool

(/=) :: TransactionId -> TransactionId -> Bool

Ord TransactionId

Defined in Database.EventStore.Internal

Methods

compare :: TransactionId -> TransactionId -> Ordering

(<) :: TransactionId -> TransactionId -> Bool

(<=) :: TransactionId -> TransactionId -> Bool

(>) :: TransactionId -> TransactionId -> Bool

(>=) :: TransactionId -> TransactionId -> Bool

max :: TransactionId -> TransactionId -> TransactionId

min :: TransactionId -> TransactionId -> TransactionId

Show TransactionId

Defined in Database.EventStore.Internal

Methods

showsPrec :: Int -> TransactionId -> ShowS

show :: TransactionId -> String

showList :: [TransactionId] -> ShowS

startTransaction

Arguments

:: Connection

-> StreamName

Stream name

-> ExpectedVersion

-> Maybe Credentials

-> IO (Async Transaction)

Starts a transaction on given stream.

transactionId :: Transaction -> TransactionId

Gets the id of a Transaction.

transactionCommit :: Transaction -> Maybe Credentials -> IO (Async WriteResult)

Asynchronously commits this transaction.

transactionRollback :: Transaction -> IO ()

There isn't such of thing in EventStore parlance. Basically, if you want to rollback, you just have to not transactionCommit a Transaction.

transactionWrite :: Transaction -> [Event] -> Maybe Credentials -> IO (Async ())

Asynchronously writes to a transaction in the EventStore.

Subscription

data SubscriptionClosed

Constructors

SubscriptionClosed (Maybe SubDropReason)

Instances

Show SubscriptionClosed

Defined in Database.EventStore.Internal.Subscription.Types

Methods

showsPrec :: Int -> SubscriptionClosed -> ShowS

show :: SubscriptionClosed -> String

showList :: [SubscriptionClosed] -> ShowS

Exception SubscriptionClosed

Defined in Database.EventStore.Internal.Subscription.Types

Methods

toException :: SubscriptionClosed -> SomeException

fromException :: SomeException -> Maybe SubscriptionClosed

displayException :: SubscriptionClosed -> String

class SubscriptionStream s t | t -> s where

Returns the stream of a subscription.

Methods

subscriptionStream :: s -> StreamId t

Instances

SubscriptionStream PersistentSubscription EventNumber

Defined in Database.EventStore.Internal.Subscription.Persistent

Methods

subscriptionStream :: PersistentSubscription -> StreamId EventNumber

SubscriptionStream (RegularSubscription t) t

Defined in Database.EventStore.Internal.Subscription.Regular

Methods

subscriptionStream :: RegularSubscription t -> StreamId t

SubscriptionStream (CatchupSubscription t) t

Defined in Database.EventStore.Internal.Subscription.Catchup

Methods

subscriptionStream :: CatchupSubscription t -> StreamId t

class Subscription s

Common operations supported by a subscription.

Minimal complete definition

nextSubEvent, unsubscribe

Instances

Subscription PersistentSubscription

Defined in Database.EventStore.Internal.Subscription.Persistent

Methods

nextSubEvent :: PersistentSubscription -> IO SubAction

unsubscribe :: PersistentSubscription -> IO ()

Subscription (RegularSubscription s)

Defined in Database.EventStore.Internal.Subscription.Regular

Methods

nextSubEvent :: RegularSubscription s -> IO SubAction

unsubscribe :: RegularSubscription s -> IO ()

Subscription (CatchupSubscription s)

Defined in Database.EventStore.Internal.Subscription.Catchup

Methods

nextSubEvent :: CatchupSubscription s -> IO SubAction

unsubscribe :: CatchupSubscription s -> IO ()

data SubDropReason

Indicates why a subscription has been dropped.

Constructors

SubUnsubscribed

Subscription connection has been closed by the user.

SubAccessDenied

The current user is not allowed to operate on the supplied stream.

SubNotFound

Given stream name doesn't exist.

SubPersistDeleted

Given stream is deleted.

SubAborted

Occurs when the user shutdown the connection from the server or if the connection to the server is no longer possible.

SubNotAuthenticated (Maybe Text)

SubServerError (Maybe Text)

Unexpected error from the server.

SubNotHandled !NotHandledReason !(Maybe MasterInfo)

SubClientError !Text

SubSubscriberMaxCountReached

Instances

Eq SubDropReason

Defined in Database.EventStore.Internal.Subscription.Types

Methods

(==) :: SubDropReason -> SubDropReason -> Bool

(/=) :: SubDropReason -> SubDropReason -> Bool

Show SubDropReason

Defined in Database.EventStore.Internal.Subscription.Types

Methods

showsPrec :: Int -> SubDropReason -> ShowS

show :: SubDropReason -> String

showList :: [SubDropReason] -> ShowS

data SubDetails

Subscription runtime details. Not useful for the user but at least it makes Haddock documentation generation less ugly.

data SubAction

Constructors

Submit ResolvedEvent

Dropped SubDropReason

Confirmed SubDetails

unsubscribe :: Subscription s => s -> IO ()

Asynchronously unsubscribe from a subscription.

nextSubEvent :: Subscription s => s -> IO SubAction

Asks for the next subcription event. If that function is called after a SubDropped event, expect it to hang indefinitely.

streamSubEvents :: Subscription s => s -> Stream (Of SubAction) IO ()

Streams a subscription events. The stream will end when hitting Dropped event but will still emit it.

streamSubResolvedEvents :: Subscription s => s -> Stream (Of ResolvedEvent) IO ()

Like streamSubEvent but will only emit ResolvedEvent.

Volatile Subscription

data RegularSubscription t

Also referred as volatile subscription. For example, if a stream has 100 events in it when a subscriber connects, the subscriber can expect to see event number 101 onwards until the time the subscription is closed or dropped.

Instances

Subscription (RegularSubscription s)

Defined in Database.EventStore.Internal.Subscription.Regular

Methods

nextSubEvent :: RegularSubscription s -> IO SubAction

unsubscribe :: RegularSubscription s -> IO ()

SubscriptionStream (RegularSubscription t) t

Defined in Database.EventStore.Internal.Subscription.Regular

Methods

subscriptionStream :: RegularSubscription t -> StreamId t

subscribe :: Connection -> StreamId t -> ResolveLink -> Maybe Credentials -> IO (RegularSubscription t)

Subscribes to a stream.

Catch-up Subscription

data CatchupSubscription t

This kind of subscription specifies a starting point, in the form of an event number or transaction file position. The given function will be called for events from the starting point until the end of the stream, and then for 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 until such time as the subscription is dropped or closed.

Instances

Subscription (CatchupSubscription s)

Defined in Database.EventStore.Internal.Subscription.Catchup

Methods

nextSubEvent :: CatchupSubscription s -> IO SubAction

unsubscribe :: CatchupSubscription s -> IO ()

SubscriptionStream (CatchupSubscription t) t

Defined in Database.EventStore.Internal.Subscription.Catchup

Methods

subscriptionStream :: CatchupSubscription t -> StreamId t

subscribeFrom

Arguments

:: Connection

-> StreamId t

-> ResolveLink

-> Maybe t

-> Maybe Int32

Batch size

-> Maybe Credentials

-> IO (CatchupSubscription t)

Subscribes to a stream. If last checkpoint is defined, this will readStreamEventsForward from that event number, otherwise from the beginning. Once last stream event reached up, a subscription request will be sent using subscribe.

Persistent Subscription

data PersistentSubscription

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. (Need EventStore >= v3.1.0).

Instances

Subscription PersistentSubscription

Defined in Database.EventStore.Internal.Subscription.Persistent

Methods

nextSubEvent :: PersistentSubscription -> IO SubAction

unsubscribe :: PersistentSubscription -> IO ()

SubscriptionStream PersistentSubscription EventNumber

Defined in Database.EventStore.Internal.Subscription.Persistent

Methods

subscriptionStream :: PersistentSubscription -> StreamId EventNumber

data PersistentSubscriptionSettings

Gathers every persistent subscription property.

Constructors

PersistentSubscriptionSettings

Fields

• psSettingsResolveLinkTos :: !Bool

  Whether or not the persistent subscription should resolve linkTo events to their linked events.

• psSettingsStartFrom :: !Int64

  Where the subscription should start from (position).

• psSettingsExtraStats :: !Bool

  Whether or not in depth latency statistics should be tracked on this subscription.

• psSettingsMsgTimeout :: !TimeSpan

  The amount of time after which a message should be considered to be timeout and retried.

• psSettingsMaxRetryCount :: !Int32

  The maximum number of retries (due to timeout) before a message get considered to be parked.

• psSettingsLiveBufSize :: !Int32

  The size of the buffer listening to live messages as they happen.

• psSettingsReadBatchSize :: !Int32

  The number of events read at a time when paging in history.

• psSettingsHistoryBufSize :: !Int32

  The number of events to cache when paging through history.

• psSettingsCheckPointAfter :: !TimeSpan

  The amount of time to try checkpoint after.

• psSettingsMinCheckPointCount :: !Int32

  The minimum number of messages to checkpoint.

• psSettingsMaxCheckPointCount :: !Int32

  The maximum number of message to checkpoint. If this number is reached, a checkpoint will be forced.

• psSettingsMaxSubsCount :: !Int32

  The maximum number of subscribers allowed.

• psSettingsNamedConsumerStrategy :: !SystemConsumerStrategy

  The strategy to use for distributing events to client consumers.

Instances

Eq PersistentSubscriptionSettings

Defined in Database.EventStore.Internal.Types

Methods

(==) :: PersistentSubscriptionSettings -> PersistentSubscriptionSettings -> Bool

(/=) :: PersistentSubscriptionSettings -> PersistentSubscriptionSettings -> Bool

Show PersistentSubscriptionSettings

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> PersistentSubscriptionSettings -> ShowS

show :: PersistentSubscriptionSettings -> String

showList :: [PersistentSubscriptionSettings] -> ShowS

data SystemConsumerStrategy

System supported consumer strategies for use with persistent subscriptions.

Constructors

DispatchToSingle

Distributes events to a single client until the bufferSize is reached. After which the next client is selected in a round robin style, and the process is repeated.

RoundRobin

Distributes events to all clients evenly. If the client buffer-size is reached the client is ignored until events are acknowledged/not acknowledged.

Pinned

For use with an indexing projection such as the system $by_category projection. Event Store inspects event for its source stream id, hashing the id to one of 1024 buckets assigned to individual clients. When a client disconnects it's buckets are assigned to other clients. When a client connects, it is assigned some of the existing buckets. This naively attempts to maintain a balanced workload. The main aim of this strategy is to decrease the likelihood of concurrency and ordering issues while maintaining load balancing. This is not a guarantee, and you should handle the usual ordering and concurrency issues.

Instances

Eq SystemConsumerStrategy

Defined in Database.EventStore.Internal.Types

Methods

(==) :: SystemConsumerStrategy -> SystemConsumerStrategy -> Bool

(/=) :: SystemConsumerStrategy -> SystemConsumerStrategy -> Bool

Show SystemConsumerStrategy

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> SystemConsumerStrategy -> ShowS

show :: SystemConsumerStrategy -> String

showList :: [SystemConsumerStrategy] -> ShowS

data NakAction

Gathers every possible Nak actions.

Constructors

NA_Unknown

NA_Park

NA_Retry

NA_Skip

NA_Stop

Instances

Enum NakAction

Defined in Database.EventStore.Internal.Subscription.Message

Methods

succ :: NakAction -> NakAction

pred :: NakAction -> NakAction

toEnum :: Int -> NakAction

fromEnum :: NakAction -> Int

enumFrom :: NakAction -> [NakAction]

enumFromThen :: NakAction -> NakAction -> [NakAction]

enumFromTo :: NakAction -> NakAction -> [NakAction]

enumFromThenTo :: NakAction -> NakAction -> NakAction -> [NakAction]

Eq NakAction

Defined in Database.EventStore.Internal.Subscription.Message

Methods

(==) :: NakAction -> NakAction -> Bool

(/=) :: NakAction -> NakAction -> Bool

Show NakAction

Defined in Database.EventStore.Internal.Subscription.Message

Methods

showsPrec :: Int -> NakAction -> ShowS

show :: NakAction -> String

showList :: [NakAction] -> ShowS

data PersistActionException

Enumerates all persistent action exceptions.

Constructors

PersistActionFail

The action failed.

PersistActionAlreadyExist

Happens when creating a persistent subscription on a stream with a group name already taken.

PersistActionDoesNotExist

An operation tried to do something on a persistent subscription or a stream that don't exist.

PersistActionAccessDenied

The current user is not allowed to operate on the supplied stream or persistent subscription.

PersistActionAborted

That action has been aborted because the user shutdown the connection to the server or the connection to the server is no longer possible.

Instances

Show PersistActionException

Defined in Database.EventStore.Internal.Subscription.Types

Methods

showsPrec :: Int -> PersistActionException -> ShowS

show :: PersistActionException -> String

showList :: [PersistActionException] -> ShowS

Exception PersistActionException

Defined in Database.EventStore.Internal.Subscription.Types

Methods

toException :: PersistActionException -> SomeException

fromException :: SomeException -> Maybe PersistActionException

displayException :: PersistActionException -> String

acknowledge :: PersistentSubscription -> ResolvedEvent -> IO ()

Acknowledges that ResolvedEvent has been successfully processed.

acknowledgeEvents :: PersistentSubscription -> [ResolvedEvent] -> IO ()

Acknowledges those ResolvedEvents have been successfully processed.

failed :: PersistentSubscription -> ResolvedEvent -> NakAction -> Maybe Text -> IO ()

Mark a message that has failed processing. The server will take action based upon the action parameter.

eventsFailed :: PersistentSubscription -> [ResolvedEvent] -> NakAction -> Maybe Text -> IO ()

Mark messages that have failed processing. The server will take action based upon the action parameter.

notifyEventsProcessed :: PersistentSubscription -> [UUID] -> IO ()

Acknowledges those event ids have been successfully processed.

notifyEventsFailed :: PersistentSubscription -> NakAction -> Maybe Text -> [UUID] -> IO ()

Acknowledges those event ids have failed to be processed successfully.

defaultPersistentSubscriptionSettings :: PersistentSubscriptionSettings

System default persistent subscription settings.

createPersistentSubscription :: Connection -> Text -> StreamName -> PersistentSubscriptionSettings -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously create a persistent subscription group on a stream.

updatePersistentSubscription :: Connection -> Text -> StreamName -> PersistentSubscriptionSettings -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously update a persistent subscription group on a stream.

deletePersistentSubscription :: Connection -> Text -> StreamName -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously delete a persistent subscription group on a stream.

connectToPersistentSubscription :: Connection -> Text -> StreamName -> Int32 -> Maybe Credentials -> IO PersistentSubscription

Asynchronously connect to a persistent subscription given a group on a stream.

Results

data Slice t

Gathers common slice operations.

Constructors

SliceEndOfStream

Slice ![ResolvedEvent] !(Maybe t)

Instances

Functor Slice

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

fmap :: (a -> b) -> Slice a -> Slice b

(<$) :: a -> Slice b -> Slice a

Show t => Show (Slice t)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

showsPrec :: Int -> Slice t -> ShowS

show :: Slice t -> String

showList :: [Slice t] -> ShowS

sliceEvents :: Slice t -> [ResolvedEvent]

Gets slice's ResolvedEventss.

sliceEOS :: Slice t -> Bool

If the slice has reached the end of the stream.

sliceNext :: Slice t -> Maybe t

Gets the next location of this slice.

emptySlice :: Slice t

Empty slice.

type AllSlice = Slice Position

Represents a slice of the $all stream.

newtype DeleteResult

Returned after deleting a stream. Position of the write.

Constructors

DeleteResult Position

Instances

Eq DeleteResult

Defined in Database.EventStore.Internal.Operation.DeleteStream

Methods

(==) :: DeleteResult -> DeleteResult -> Bool

(/=) :: DeleteResult -> DeleteResult -> Bool

Show DeleteResult

Defined in Database.EventStore.Internal.Operation.DeleteStream

Methods

showsPrec :: Int -> DeleteResult -> ShowS

show :: DeleteResult -> String

showList :: [DeleteResult] -> ShowS

data WriteResult

Returned after writing to a stream.

Constructors

WriteResult

Fields

• writeNextExpectedVersion :: !Int64

  Next expected version of the stream.

• writePosition :: !Position

  Position of the write.

Instances

Eq WriteResult

Defined in Database.EventStore.Internal.Operation.Write.Common

Methods

(==) :: WriteResult -> WriteResult -> Bool

(/=) :: WriteResult -> WriteResult -> Bool

Show WriteResult

Defined in Database.EventStore.Internal.Operation.Write.Common

Methods

showsPrec :: Int -> WriteResult -> ShowS

show :: WriteResult -> String

showList :: [WriteResult] -> ShowS

data ReadResult t a where

Enumeration detailing the possible outcomes of reading a stream.

Constructors

ReadSuccess :: a -> ReadResult t a

ReadNoStream :: ReadResult EventNumber a

ReadStreamDeleted :: StreamName -> ReadResult EventNumber a

ReadNotModified :: ReadResult t a

ReadError :: Maybe Text -> ReadResult t a

ReadAccessDenied :: StreamId t -> ReadResult t a

Instances

Functor (ReadResult t)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

fmap :: (a -> b) -> ReadResult t a -> ReadResult t b

(<$) :: a -> ReadResult t b -> ReadResult t a

Foldable (ReadResult t)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

fold :: Monoid m => ReadResult t m -> m

foldMap :: Monoid m => (a -> m) -> ReadResult t a -> m

foldr :: (a -> b -> b) -> b -> ReadResult t a -> b

foldr' :: (a -> b -> b) -> b -> ReadResult t a -> b

foldl :: (b -> a -> b) -> b -> ReadResult t a -> b

foldl' :: (b -> a -> b) -> b -> ReadResult t a -> b

foldr1 :: (a -> a -> a) -> ReadResult t a -> a

foldl1 :: (a -> a -> a) -> ReadResult t a -> a

toList :: ReadResult t a -> [a]

null :: ReadResult t a -> Bool

length :: ReadResult t a -> Int

elem :: Eq a => a -> ReadResult t a -> Bool

maximum :: Ord a => ReadResult t a -> a

minimum :: Ord a => ReadResult t a -> a

sum :: Num a => ReadResult t a -> a

product :: Num a => ReadResult t a -> a

Traversable (ReadResult t)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

traverse :: Applicative f => (a -> f b) -> ReadResult t a -> f (ReadResult t b)

sequenceA :: Applicative f => ReadResult t (f a) -> f (ReadResult t a)

mapM :: Monad m => (a -> m b) -> ReadResult t a -> m (ReadResult t b)

sequence :: Monad m => ReadResult t (m a) -> m (ReadResult t a)

Eq a => Eq (ReadResult t a)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

(==) :: ReadResult t a -> ReadResult t a -> Bool

(/=) :: ReadResult t a -> ReadResult t a -> Bool

Show a => Show (ReadResult t a)

Defined in Database.EventStore.Internal.Operation.Read.Common

Methods

showsPrec :: Int -> ReadResult t a -> ShowS

show :: ReadResult t a -> String

showList :: [ReadResult t a] -> ShowS

data RecordedEvent

Represents a previously written event.

Constructors

RecordedEvent

Fields

• recordedEventStreamId :: !Text

  The event stream that this event belongs to.

• recordedEventId :: !UUID

  Unique identifier representing this event.

• recordedEventNumber :: !Int64

  Number of this event in the stream.

• recordedEventType :: !Text

  Type of this event.

• recordedEventData :: !ByteString

  Representing the data of this event.

• recordedEventMetadata :: !(Maybe ByteString)

  Representing the metadada associated with this event.

• recordedEventIsJson :: !Bool

  Indicates whether the content is internally marked as json.

• recordedEventCreated :: !(Maybe UTCTime)

  Representing when this event was created in the system.

Instances

Show RecordedEvent

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> RecordedEvent -> ShowS

show :: RecordedEvent -> String

showList :: [RecordedEvent] -> ShowS

data ReadEvent

Represents the result of looking up a specific event number from a stream.

Constructors

ReadEventNotFound

Fields

• readEventStream :: !Text
• readEventNumber :: !Int64

ReadEvent

Fields

• readEventStream :: !Text
• readEventNumber :: !Int64
• readEventResolved :: !ResolvedEvent

Instances

Show ReadEvent

Defined in Database.EventStore.Internal.Operation.ReadEvent

Methods

showsPrec :: Int -> ReadEvent -> ShowS

show :: ReadEvent -> String

showList :: [ReadEvent] -> ShowS

type StreamSlice = Slice EventNumber

Regular stream slice.

data Position

A structure referring to a potential logical record position in the EventStore transaction file.

Constructors

Position

Fields

• positionCommit :: !Int64

  Commit position of the record

• positionPrepare :: !Int64

  Prepare position of the record

Instances

Eq Position

Defined in Database.EventStore.Internal.Types

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

Ord Position

Defined in Database.EventStore.Internal.Types

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Show Position

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

data ReadDirection

Represents the direction of read operation (both from $all an usual streams).

Constructors

Forward

From beginning to end

Backward

From end to beginning

Instances

Eq ReadDirection

Defined in Database.EventStore.Internal.Types

Methods

(==) :: ReadDirection -> ReadDirection -> Bool

(/=) :: ReadDirection -> ReadDirection -> Bool

Show ReadDirection

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> ReadDirection -> ShowS

show :: ReadDirection -> String

showList :: [ReadDirection] -> ShowS

data ResolvedEvent

A structure representing a single event or an resolved link event.

Constructors

ResolvedEvent

Fields

• resolvedEventRecord :: !(Maybe RecordedEvent)

  The event, or the resolved link event if this ResolvedEvent is a link event.

• resolvedEventLink :: !(Maybe RecordedEvent)

  The link event if this ResolvedEvent is a link event.

• resolvedEventPosition :: !(Maybe Position)

  Possible Position of that event.

Instances

Show ResolvedEvent

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> ResolvedEvent -> ShowS

show :: ResolvedEvent -> String

showList :: [ResolvedEvent] -> ShowS

data OperationError

Operation exception that can occurs on an operation response.

Constructors

WrongExpectedVersion !Text !ExpectedVersion

Stream and Expected Version

StreamDeleted !StreamName

Stream

InvalidTransaction

AccessDenied !(StreamId t)

Stream

InvalidServerResponse !Command !Command

Expected, Found

ProtobufDecodingError !String

ServerError !(Maybe Text)

Reason

InvalidOperation !Text

StreamNotFound !StreamName

NotAuthenticatedOp

Invalid operation state. If happens, it's a driver bug.

Aborted

Occurs when the user asked to close the connection or if the connection can't reconnect anymore.

ConnectionHasDropped

Instances

Show OperationError

Defined in Database.EventStore.Internal.Operation

Methods

showsPrec :: Int -> OperationError -> ShowS

show :: OperationError -> String

showList :: [OperationError] -> ShowS

Exception OperationError

Defined in Database.EventStore.Internal.Operation

Methods

toException :: OperationError -> SomeException

fromException :: SomeException -> Maybe OperationError

displayException :: OperationError -> String

data StreamId loc where

Represents a regular stream name or $all stream.

Constructors

StreamName :: Text -> StreamId EventNumber

All :: StreamId Position

Instances

Eq (StreamId t)

Defined in Database.EventStore.Internal.Stream

Methods

(==) :: StreamId t -> StreamId t -> Bool

(/=) :: StreamId t -> StreamId t -> Bool

Show (StreamId t)

Defined in Database.EventStore.Internal.Stream

Methods

showsPrec :: Int -> StreamId t -> ShowS

show :: StreamId t -> String

showList :: [StreamId t] -> ShowS

type StreamName = StreamId EventNumber

isAllStream :: StreamId t -> Bool

If the stream is the $all stream.

isEventResolvedLink :: ResolvedEvent -> Bool

Indicates whether this ResolvedEvent is a resolved link event.

resolvedEventOriginal :: ResolvedEvent -> RecordedEvent

Returns the event that was read or which triggered the subscription.

If this ResolvedEvent represents a link event, the link will be the original event, otherwise it will be the event.

resolvedEventDataAsJson :: FromJSON a => ResolvedEvent -> Maybe a

Tries to desarialize resolvedEventOriginal data as JSON.

resolvedEventOriginalStreamId :: ResolvedEvent -> Text

The stream name of the original event.

resolvedEventOriginalId :: ResolvedEvent -> UUID

The ID of the original event.

resolvedEventOriginalEventNumber :: ResolvedEvent -> Int64

The event number of the original event.

recordedEventDataAsJson :: FromJSON a => RecordedEvent -> Maybe a

Tries to parse JSON object from the given RecordedEvent.

positionStart :: Position

Representing the start of the transaction file.

positionEnd :: Position

Representing the end of the transaction file.

Logging

data LogLevel

Constructors

LevelDebug

LevelInfo

LevelWarn

LevelError

LevelOther Text

Instances

Eq LogLevel

Defined in Control.Monad.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

Defined in Control.Monad.Logger

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Defined in Control.Monad.Logger

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in Control.Monad.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Lift LogLevel

Defined in Control.Monad.Logger

Methods

lift :: LogLevel -> Q Exp

type LogType = LogType' LogStr

data LoggerFilter

Constructors

LoggerFilter (LogSource -> LogLevel -> Bool)

LoggerLevel LogLevel

Monitoring

data MonitoringBackend

Monitoring backend abstraction. Gathers all the metrics currently tracked by the client. Used only by the TCP interface. Be careful as MonitoringBackend is used in a very tight loop. Each function must not throw any exception or the client will end in a broken state.

Constructors

MonitoringBackend

Fields

• monitoringBackendIncrPkgCount :: IO ()

  Called every time a TCP package is sent. We mean high-level TCP package, used in EventStore TCP protocol.

• monitoringBackendIncrConnectionDrop :: IO ()

  Called every time the client has lost the connection.

• monitoringBackendAddDataTransmitted :: Int -> IO ()

  When the client sends a TCP package, it calls that function by passing the size of the payload. The goal is to have a distrubtion of the amount of data exchanged with the server.

• monitoringBackendIncrForceReconnect :: IO ()

  Called every time the client is asked by a node to connect to another node. It happens only in cluster connection setting.

• monitoringBackendIncrHeartbeatTimeouts :: IO ()

  Called every time the client detects a heartbeat timeout from the server.

noopMonitoringBackend :: MonitoringBackend

A MonitoringBackend that does nothing.

Misc

data Command

Internal command representation.

Instances

Eq Command

Defined in Database.EventStore.Internal.Command

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Ord Command

Defined in Database.EventStore.Internal.Command

Methods

compare :: Command -> Command -> Ordering

(<) :: Command -> Command -> Bool

(<=) :: Command -> Command -> Bool

(>) :: Command -> Command -> Bool

(>=) :: Command -> Command -> Bool

max :: Command -> Command -> Command

min :: Command -> Command -> Command

Show Command

Defined in Database.EventStore.Internal.Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

data DropReason

Represents the reason subscription drop happened.

Constructors

D_Unsubscribed

D_AccessDenied

D_NotFound

D_PersistentSubscriptionDeleted

D_SubscriberMaxCountReached

Instances

Enum DropReason

Defined in Database.EventStore.Internal.Subscription.Message

Methods

succ :: DropReason -> DropReason

pred :: DropReason -> DropReason

toEnum :: Int -> DropReason

fromEnum :: DropReason -> Int

enumFrom :: DropReason -> [DropReason]

enumFromThen :: DropReason -> DropReason -> [DropReason]

enumFromTo :: DropReason -> DropReason -> [DropReason]

enumFromThenTo :: DropReason -> DropReason -> DropReason -> [DropReason]

Eq DropReason

Defined in Database.EventStore.Internal.Subscription.Message

Methods

(==) :: DropReason -> DropReason -> Bool

(/=) :: DropReason -> DropReason -> Bool

Show DropReason

Defined in Database.EventStore.Internal.Subscription.Message

Methods

showsPrec :: Int -> DropReason -> ShowS

show :: DropReason -> String

showList :: [DropReason] -> ShowS

data ExpectedVersion

Constants used for expected version control.

The use of expected version can be a bit tricky especially when discussing idempotency assurances given by the EventStore.

The EventStore will assure idempotency for all operations using any value in ExpectedVersion except for anyStream. When using anyStream the EventStore will do its best to assure idempotency but will not guarantee idempotency.

Instances

Eq ExpectedVersion

Defined in Database.EventStore.Internal.Types

Methods

(==) :: ExpectedVersion -> ExpectedVersion -> Bool

(/=) :: ExpectedVersion -> ExpectedVersion -> Bool

Show ExpectedVersion

Defined in Database.EventStore.Internal.Types

Methods

showsPrec :: Int -> ExpectedVersion -> ShowS

show :: ExpectedVersion -> String

showList :: [ExpectedVersion] -> ShowS

anyVersion :: ExpectedVersion

This write should not conflict with anything and should always succeed.

noStreamVersion :: ExpectedVersion

The stream being written to should not yet exist. If it does exist treat that as a concurrency problem.

emptyStreamVersion :: ExpectedVersion

The stream should exist and should be empty. If it does not exist or is not empty, treat that as a concurrency problem.

exactEventVersion :: Int64 -> ExpectedVersion

States that the last event written to the stream should have a sequence number matching your expected value.

streamExists :: ExpectedVersion

The stream should exist. If it or a metadata stream does not exist treat that as a concurrency problem.

msDiffTime :: Float -> NominalDiffTime

Millisecond timespan

Re-export

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.

data NonEmpty a

Non-empty (and non-strict) list type.

Since: base-4.9.0.0

Constructors

a :| [a] infixr 5

Instances

Monad NonEmpty

Since: base-4.9.0.0

Defined in GHC.Base

Methods

(>>=) :: NonEmpty a -> (a -> NonEmpty b) -> NonEmpty b

(>>) :: NonEmpty a -> NonEmpty b -> NonEmpty b

return :: a -> NonEmpty a

fail :: String -> NonEmpty a

Functor NonEmpty

Since: base-4.9.0.0

Defined in GHC.Base

Methods

fmap :: (a -> b) -> NonEmpty a -> NonEmpty b

(<$) :: a -> NonEmpty b -> NonEmpty a

MonadFix NonEmpty

Since: base-4.9.0.0

Defined in Control.Monad.Fix

Methods

mfix :: (a -> NonEmpty a) -> NonEmpty a

Applicative NonEmpty

Since: base-4.9.0.0

Defined in GHC.Base

Methods

pure :: a -> NonEmpty a

(<*>) :: NonEmpty (a -> b) -> NonEmpty a -> NonEmpty b

liftA2 :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c

(*>) :: NonEmpty a -> NonEmpty b -> NonEmpty b

(<*) :: NonEmpty a -> NonEmpty b -> NonEmpty a

Foldable NonEmpty

Since: base-4.9.0.0

Defined in Data.Foldable

Methods

fold :: Monoid m => NonEmpty m -> m

foldMap :: Monoid m => (a -> m) -> NonEmpty a -> m

foldr :: (a -> b -> b) -> b -> NonEmpty a -> b

foldr' :: (a -> b -> b) -> b -> NonEmpty a -> b

foldl :: (b -> a -> b) -> b -> NonEmpty a -> b

foldl' :: (b -> a -> b) -> b -> NonEmpty a -> b

foldr1 :: (a -> a -> a) -> NonEmpty a -> a

foldl1 :: (a -> a -> a) -> NonEmpty a -> a

toList :: NonEmpty a -> [a]

null :: NonEmpty a -> Bool

length :: NonEmpty a -> Int

elem :: Eq a => a -> NonEmpty a -> Bool

maximum :: Ord a => NonEmpty a -> a

minimum :: Ord a => NonEmpty a -> a

sum :: Num a => NonEmpty a -> a

product :: Num a => NonEmpty a -> a

Traversable NonEmpty

Since: base-4.9.0.0

Defined in Data.Traversable

Methods

traverse :: Applicative f => (a -> f b) -> NonEmpty a -> f (NonEmpty b)

sequenceA :: Applicative f => NonEmpty (f a) -> f (NonEmpty a)

mapM :: Monad m => (a -> m b) -> NonEmpty a -> m (NonEmpty b)

sequence :: Monad m => NonEmpty (m a) -> m (NonEmpty a)

ToJSON1 NonEmpty

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Value) -> ([a] -> Value) -> NonEmpty a -> Value

liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [NonEmpty a] -> Value

liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> NonEmpty a -> Encoding

liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [NonEmpty a] -> Encoding

FromJSON1 NonEmpty

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (NonEmpty a)

liftParseJSONList :: (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [NonEmpty a]

Eq1 NonEmpty

Since: base-4.10.0.0

Defined in Data.Functor.Classes

Methods

liftEq :: (a -> b -> Bool) -> NonEmpty a -> NonEmpty b -> Bool

Ord1 NonEmpty

Since: base-4.10.0.0

Defined in Data.Functor.Classes

Methods

liftCompare :: (a -> b -> Ordering) -> NonEmpty a -> NonEmpty b -> Ordering

Read1 NonEmpty

Since: base-4.10.0.0

Defined in Data.Functor.Classes

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (NonEmpty a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [NonEmpty a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (NonEmpty a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [NonEmpty a]

Show1 NonEmpty

Since: base-4.10.0.0

Defined in Data.Functor.Classes

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> NonEmpty a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [NonEmpty a] -> ShowS

NFData1 NonEmpty

Since: deepseq-1.4.3.0

Defined in Control.DeepSeq

Methods

liftRnf :: (a -> ()) -> NonEmpty a -> ()

IsList (NonEmpty a)

Since: base-4.9.0.0

Defined in GHC.Exts

Associated Types

type Item (NonEmpty a) :: Type

Methods

fromList :: [Item (NonEmpty a)] -> NonEmpty a

fromListN :: Int -> [Item (NonEmpty a)] -> NonEmpty a

toList :: NonEmpty a -> [Item (NonEmpty a)]

Eq a => Eq (NonEmpty a)

Since: base-4.9.0.0

Defined in GHC.Base

Methods

(==) :: NonEmpty a -> NonEmpty a -> Bool

(/=) :: NonEmpty a -> NonEmpty a -> Bool

Ord a => Ord (NonEmpty a)

Since: base-4.9.0.0

Defined in GHC.Base

Methods

compare :: NonEmpty a -> NonEmpty a -> Ordering

(<) :: NonEmpty a -> NonEmpty a -> Bool

(<=) :: NonEmpty a -> NonEmpty a -> Bool

(>) :: NonEmpty a -> NonEmpty a -> Bool

(>=) :: NonEmpty a -> NonEmpty a -> Bool

max :: NonEmpty a -> NonEmpty a -> NonEmpty a

min :: NonEmpty a -> NonEmpty a -> NonEmpty a

Read a => Read (NonEmpty a)

Since: base-4.11.0.0

Defined in GHC.Read

Methods

readsPrec :: Int -> ReadS (NonEmpty a)

readList :: ReadS [NonEmpty a]

readPrec :: ReadPrec (NonEmpty a)

readListPrec :: ReadPrec [NonEmpty a]

Show a => Show (NonEmpty a)

Since: base-4.11.0.0

Defined in GHC.Show

Methods

showsPrec :: Int -> NonEmpty a -> ShowS

show :: NonEmpty a -> String

showList :: [NonEmpty a] -> ShowS

Generic (NonEmpty a)

Defined in GHC.Generics

Associated Types

type Rep (NonEmpty a) :: Type -> Type

Methods

from :: NonEmpty a -> Rep (NonEmpty a) x

to :: Rep (NonEmpty a) x -> NonEmpty a

Semigroup (NonEmpty a)

Since: base-4.9.0.0

Defined in GHC.Base

Methods

(<>) :: NonEmpty a -> NonEmpty a -> NonEmpty a

sconcat :: NonEmpty (NonEmpty a) -> NonEmpty a

stimes :: Integral b => b -> NonEmpty a -> NonEmpty a

Hashable a => Hashable (NonEmpty a)

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> NonEmpty a -> Int

hash :: NonEmpty a -> Int

ToJSON a => ToJSON (NonEmpty a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: NonEmpty a -> Value

toEncoding :: NonEmpty a -> Encoding

toJSONList :: [NonEmpty a] -> Value

toEncodingList :: [NonEmpty a] -> Encoding

FromJSON a => FromJSON (NonEmpty a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (NonEmpty a)

parseJSONList :: Value -> Parser [NonEmpty a]

NFData a => NFData (NonEmpty a)

Since: deepseq-1.4.2.0

Defined in Control.DeepSeq

Methods

rnf :: NonEmpty a -> ()

SemiSequence (NonEmpty a)

Defined in Data.Sequences

Associated Types

type Index (NonEmpty a) :: Type

Methods

intersperse :: Element (NonEmpty a) -> NonEmpty a -> NonEmpty a

reverse :: NonEmpty a -> NonEmpty a

find :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Maybe (Element (NonEmpty a))

sortBy :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> NonEmpty a

cons :: Element (NonEmpty a) -> NonEmpty a -> NonEmpty a

snoc :: NonEmpty a -> Element (NonEmpty a) -> NonEmpty a

MonoFunctor (NonEmpty a)

Defined in Data.MonoTraversable

Methods

omap :: (Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> NonEmpty a

MonoFoldable (NonEmpty a)

Defined in Data.MonoTraversable

Methods

ofoldMap :: Monoid m => (Element (NonEmpty a) -> m) -> NonEmpty a -> m

ofoldr :: (Element (NonEmpty a) -> b -> b) -> b -> NonEmpty a -> b

ofoldl' :: (a0 -> Element (NonEmpty a) -> a0) -> a0 -> NonEmpty a -> a0

otoList :: NonEmpty a -> [Element (NonEmpty a)]

oall :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Bool

oany :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Bool

onull :: NonEmpty a -> Bool

olength :: NonEmpty a -> Int

olength64 :: NonEmpty a -> Int64

ocompareLength :: Integral i => NonEmpty a -> i -> Ordering

otraverse_ :: Applicative f => (Element (NonEmpty a) -> f b) -> NonEmpty a -> f ()

ofor_ :: Applicative f => NonEmpty a -> (Element (NonEmpty a) -> f b) -> f ()

omapM_ :: Applicative m => (Element (NonEmpty a) -> m ()) -> NonEmpty a -> m ()

oforM_ :: Applicative m => NonEmpty a -> (Element (NonEmpty a) -> m ()) -> m ()

ofoldlM :: Monad m => (a0 -> Element (NonEmpty a) -> m a0) -> a0 -> NonEmpty a -> m a0

ofoldMap1Ex :: Semigroup m => (Element (NonEmpty a) -> m) -> NonEmpty a -> m

ofoldr1Ex :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> Element (NonEmpty a)

ofoldl1Ex' :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> Element (NonEmpty a)

headEx :: NonEmpty a -> Element (NonEmpty a)

lastEx :: NonEmpty a -> Element (NonEmpty a)

unsafeHead :: NonEmpty a -> Element (NonEmpty a)

unsafeLast :: NonEmpty a -> Element (NonEmpty a)

maximumByEx :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> Element (NonEmpty a)

minimumByEx :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> Element (NonEmpty a)

oelem :: Element (NonEmpty a) -> NonEmpty a -> Bool

onotElem :: Element (NonEmpty a) -> NonEmpty a -> Bool

MonoTraversable (NonEmpty a)

Defined in Data.MonoTraversable

Methods

otraverse :: Applicative f => (Element (NonEmpty a) -> f (Element (NonEmpty a))) -> NonEmpty a -> f (NonEmpty a)

omapM :: Applicative m => (Element (NonEmpty a) -> m (Element (NonEmpty a))) -> NonEmpty a -> m (NonEmpty a)

MonoPointed (NonEmpty a)

Defined in Data.MonoTraversable

Methods

opoint :: Element (NonEmpty a) -> NonEmpty a

GrowingAppend (NonEmpty a)

Defined in Data.MonoTraversable

Generic1 NonEmpty

Defined in GHC.Generics

Associated Types

type Rep1 NonEmpty :: k -> Type

Methods

from1 :: NonEmpty a -> Rep1 NonEmpty a

to1 :: Rep1 NonEmpty a -> NonEmpty a

type Rep (NonEmpty a)

Since: base-4.6.0.0

Defined in GHC.Generics

type Rep (NonEmpty a) = D1 (MetaData "NonEmpty" "GHC.Base" "base" False) (C1 (MetaCons ":|" (InfixI LeftAssociative 9) False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a])))

type Item (NonEmpty a)

Defined in GHC.Exts

type Item (NonEmpty a) = a

type Index (NonEmpty a)

Defined in Data.Sequences

type Index (NonEmpty a) = Int

type Element (NonEmpty a)

Defined in Data.MonoTraversable

type Element (NonEmpty a) = a

type Rep1 NonEmpty

Since: base-4.6.0.0

Defined in GHC.Generics

type Rep1 NonEmpty = D1 (MetaData "NonEmpty" "GHC.Base" "base" False) (C1 (MetaCons ":|" (InfixI LeftAssociative 9) False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1 :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 [])))

nonEmpty :: [a] -> Maybe (NonEmpty a)

nonEmpty efficiently turns a normal list into a NonEmpty stream, producing Nothing if the input is empty.

data TLSSettings

TLS Settings that can be either expressed as simple settings, or as full blown TLS.Params settings.

Unless you need access to parameters that are not accessible through the simple settings, you should use TLSSettingsSimple.

Instances

Show TLSSettings

Defined in Network.Connection.Types

Methods

showsPrec :: Int -> TLSSettings -> ShowS

show :: TLSSettings -> String

showList :: [TLSSettings] -> ShowS

Default TLSSettings

Defined in Network.Connection.Types

Methods

def :: TLSSettings

data NominalDiffTime

This is a length of time, as measured by UTC. Conversion functions will treat it as seconds. It has a precision of 10^-12 s. It ignores leap-seconds, so it's not necessarily a fixed amount of clock time. For instance, 23:00 UTC + 2 hours of NominalDiffTime = 01:00 UTC (+ 1 day), regardless of whether a leap-second intervened.

Instances

Enum NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

succ :: NominalDiffTime -> NominalDiffTime

pred :: NominalDiffTime -> NominalDiffTime

toEnum :: Int -> NominalDiffTime

fromEnum :: NominalDiffTime -> Int

enumFrom :: NominalDiffTime -> [NominalDiffTime]

enumFromThen :: NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

enumFromTo :: NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

enumFromThenTo :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

Eq NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

(==) :: NominalDiffTime -> NominalDiffTime -> Bool

(/=) :: NominalDiffTime -> NominalDiffTime -> Bool

Fractional NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

(/) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

recip :: NominalDiffTime -> NominalDiffTime

fromRational :: Rational -> NominalDiffTime

Data NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NominalDiffTime -> c NominalDiffTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NominalDiffTime

toConstr :: NominalDiffTime -> Constr

dataTypeOf :: NominalDiffTime -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NominalDiffTime)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NominalDiffTime)

gmapT :: (forall b. Data b => b -> b) -> NominalDiffTime -> NominalDiffTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NominalDiffTime -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NominalDiffTime -> r

gmapQ :: (forall d. Data d => d -> u) -> NominalDiffTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NominalDiffTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

Num NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

(+) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

(-) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

(*) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

negate :: NominalDiffTime -> NominalDiffTime

abs :: NominalDiffTime -> NominalDiffTime

signum :: NominalDiffTime -> NominalDiffTime

fromInteger :: Integer -> NominalDiffTime

Ord NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

compare :: NominalDiffTime -> NominalDiffTime -> Ordering

(<) :: NominalDiffTime -> NominalDiffTime -> Bool

(<=) :: NominalDiffTime -> NominalDiffTime -> Bool

(>) :: NominalDiffTime -> NominalDiffTime -> Bool

(>=) :: NominalDiffTime -> NominalDiffTime -> Bool

max :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

min :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

Real NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

toRational :: NominalDiffTime -> Rational

RealFrac NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

properFraction :: Integral b => NominalDiffTime -> (b, NominalDiffTime)

truncate :: Integral b => NominalDiffTime -> b

round :: Integral b => NominalDiffTime -> b

ceiling :: Integral b => NominalDiffTime -> b

floor :: Integral b => NominalDiffTime -> b

Show NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

showsPrec :: Int -> NominalDiffTime -> ShowS

show :: NominalDiffTime -> String

showList :: [NominalDiffTime] -> ShowS

ToJSON NominalDiffTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: NominalDiffTime -> Value

toEncoding :: NominalDiffTime -> Encoding

toJSONList :: [NominalDiffTime] -> Value

toEncodingList :: [NominalDiffTime] -> Encoding

FromJSON NominalDiffTime

This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype Scientific and provide your own instance using withScientific if you want to allow larger inputs.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser NominalDiffTime

parseJSONList :: Value -> Parser [NominalDiffTime]

NFData NominalDiffTime

Defined in Data.Time.Clock.Internal.NominalDiffTime

Methods

rnf :: NominalDiffTime -> ()