Safe Haskell	None
Language	Haskell2010

MessageDb.Functions

Description

Provides access to the functions described at http://docs.eventide-project.org/user-guide/message-db/server-functions.html

Synopsis

type WithConnection = forall records. (Connection -> IO records) -> IO records
data BatchSize
- = FixedSize NumberOfMessages
- | Unlimited
newtype Condition = Condition {
- conditionToText :: Text
}
data ConsumerGroup = ConsumerGroup {
- consumerGroupMember :: Natural
- consumerGroupSize :: Natural
}
newtype Correlation = Correlation {
- correlationToText :: Text
}
data StreamVersion
- = DoesNotExist
- | DoesExist StreamPosition
newtype ExpectedVersion = ExpectedVersion {
- expectedToStreamVersion :: StreamVersion
}
newtype ExpectedVersionViolation = ExpectedVersionViolation {
- expectedVersionViolationToSqlError :: SqlError
}
parseExpectedVersionViolation :: SqlError -> Maybe ExpectedVersionViolation
lookupById :: Connection -> MessageId -> IO (Maybe Message)
lookupByPosition :: Connection -> GlobalPosition -> IO (Maybe Message)
writeMessage :: (ToJSON payload, ToJSON metadata) => Connection -> StreamName -> MessageType -> payload -> Maybe metadata -> Maybe ExpectedVersion -> IO (MessageId, StreamPosition)
getStreamMessages :: Connection -> StreamName -> Maybe StreamPosition -> Maybe BatchSize -> Maybe Condition -> IO [Message]
getCategoryMessages :: Connection -> CategoryName -> Maybe GlobalPosition -> Maybe BatchSize -> Maybe Correlation -> Maybe ConsumerGroup -> Maybe Condition -> IO [Message]
getLastStreamMessage :: Connection -> StreamName -> IO (Maybe Message)
streamVersion :: Connection -> StreamName -> IO (Maybe StreamPosition)

Documentation

type WithConnection = forall records. (Connection -> IO records) -> IO records Source #

data BatchSize Source #

Constructors

FixedSize NumberOfMessages
Unlimited

Instances

Instances details

Eq BatchSize Source #
Instance details Defined in MessageDb.Functions Methods (==) :: BatchSize -> BatchSize -> Bool # (/=) :: BatchSize -> BatchSize -> Bool #
Show BatchSize Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> BatchSize -> ShowS # show :: BatchSize -> String # showList :: [BatchSize] -> ShowS #

newtype Condition Source #

Constructors

Condition
Fields conditionToText :: Text

Instances

Instances details

Eq Condition Source #
Instance details Defined in MessageDb.Functions Methods (==) :: Condition -> Condition -> Bool # (/=) :: Condition -> Condition -> Bool #
Ord Condition Source #
Instance details Defined in MessageDb.Functions Methods compare :: Condition -> Condition -> Ordering # (<) :: Condition -> Condition -> Bool # (<=) :: Condition -> Condition -> Bool # (>) :: Condition -> Condition -> Bool # (>=) :: Condition -> Condition -> Bool # max :: Condition -> Condition -> Condition # min :: Condition -> Condition -> Condition #
Show Condition Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> Condition -> ShowS # show :: Condition -> String # showList :: [Condition] -> ShowS #
IsString Condition Source #
Instance details Defined in MessageDb.Functions Methods fromString :: String -> Condition #
ToJSON Condition Source #
Instance details Defined in MessageDb.Functions Methods toJSON :: Condition -> Value # toEncoding :: Condition -> Encoding # toJSONList :: [Condition] -> Value # toEncodingList :: [Condition] -> Encoding #
FromJSON Condition Source #
Instance details Defined in MessageDb.Functions Methods parseJSON :: Value -> Parser Condition # parseJSONList :: Value -> Parser [Condition] #

data ConsumerGroup Source #

Constructors

ConsumerGroup
Fields consumerGroupMember :: Natural consumerGroupSize :: Natural

Instances

Instances details

Eq ConsumerGroup Source #
Instance details Defined in MessageDb.Functions Methods (==) :: ConsumerGroup -> ConsumerGroup -> Bool # (/=) :: ConsumerGroup -> ConsumerGroup -> Bool #
Show ConsumerGroup Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> ConsumerGroup -> ShowS # show :: ConsumerGroup -> String # showList :: [ConsumerGroup] -> ShowS #

newtype Correlation Source #

Constructors

Correlation
Fields correlationToText :: Text

Instances

Instances details

Eq Correlation Source #
Instance details Defined in MessageDb.Functions Methods (==) :: Correlation -> Correlation -> Bool # (/=) :: Correlation -> Correlation -> Bool #
Ord Correlation Source #
Instance details Defined in MessageDb.Functions Methods compare :: Correlation -> Correlation -> Ordering # (<) :: Correlation -> Correlation -> Bool # (<=) :: Correlation -> Correlation -> Bool # (>) :: Correlation -> Correlation -> Bool # (>=) :: Correlation -> Correlation -> Bool # max :: Correlation -> Correlation -> Correlation # min :: Correlation -> Correlation -> Correlation #
Show Correlation Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> Correlation -> ShowS # show :: Correlation -> String # showList :: [Correlation] -> ShowS #
IsString Correlation Source #
Instance details Defined in MessageDb.Functions Methods fromString :: String -> Correlation #
ToJSON Correlation Source #
Instance details Defined in MessageDb.Functions Methods toJSON :: Correlation -> Value # toEncoding :: Correlation -> Encoding # toJSONList :: [Correlation] -> Value # toEncodingList :: [Correlation] -> Encoding #
FromJSON Correlation Source #
Instance details Defined in MessageDb.Functions Methods parseJSON :: Value -> Parser Correlation # parseJSONList :: Value -> Parser [Correlation] #

data StreamVersion Source #

Constructors

DoesNotExist
DoesExist StreamPosition

Instances

Instances details

Eq StreamVersion Source #
Instance details Defined in MessageDb.Functions Methods (==) :: StreamVersion -> StreamVersion -> Bool # (/=) :: StreamVersion -> StreamVersion -> Bool #
Ord StreamVersion Source #
Instance details Defined in MessageDb.Functions Methods compare :: StreamVersion -> StreamVersion -> Ordering # (<) :: StreamVersion -> StreamVersion -> Bool # (<=) :: StreamVersion -> StreamVersion -> Bool # (>) :: StreamVersion -> StreamVersion -> Bool # (>=) :: StreamVersion -> StreamVersion -> Bool # max :: StreamVersion -> StreamVersion -> StreamVersion # min :: StreamVersion -> StreamVersion -> StreamVersion #
Show StreamVersion Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> StreamVersion -> ShowS # show :: StreamVersion -> String # showList :: [StreamVersion] -> ShowS #

newtype ExpectedVersion Source #

Constructors

ExpectedVersion
Fields expectedToStreamVersion :: StreamVersion

Instances

Instances details

Eq ExpectedVersion Source #
Instance details Defined in MessageDb.Functions Methods (==) :: ExpectedVersion -> ExpectedVersion -> Bool # (/=) :: ExpectedVersion -> ExpectedVersion -> Bool #
Ord ExpectedVersion Source #
Instance details Defined in MessageDb.Functions Methods compare :: ExpectedVersion -> ExpectedVersion -> Ordering # (<) :: ExpectedVersion -> ExpectedVersion -> Bool # (<=) :: ExpectedVersion -> ExpectedVersion -> Bool # (>) :: ExpectedVersion -> ExpectedVersion -> Bool # (>=) :: ExpectedVersion -> ExpectedVersion -> Bool # max :: ExpectedVersion -> ExpectedVersion -> ExpectedVersion # min :: ExpectedVersion -> ExpectedVersion -> ExpectedVersion #
Show ExpectedVersion Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> ExpectedVersion -> ShowS # show :: ExpectedVersion -> String # showList :: [ExpectedVersion] -> ShowS #

newtype ExpectedVersionViolation Source #

Constructors

ExpectedVersionViolation
Fields expectedVersionViolationToSqlError :: SqlError

Instances

Instances details

Eq ExpectedVersionViolation Source #
Instance details Defined in MessageDb.Functions Methods (==) :: ExpectedVersionViolation -> ExpectedVersionViolation -> Bool # (/=) :: ExpectedVersionViolation -> ExpectedVersionViolation -> Bool #
Show ExpectedVersionViolation Source #
Instance details Defined in MessageDb.Functions Methods showsPrec :: Int -> ExpectedVersionViolation -> ShowS # show :: ExpectedVersionViolation -> String # showList :: [ExpectedVersionViolation] -> ShowS #
Exception ExpectedVersionViolation Source #
Instance details Defined in MessageDb.Functions Methods toException :: ExpectedVersionViolation -> SomeException # fromException :: SomeException -> Maybe ExpectedVersionViolation # displayException :: ExpectedVersionViolation -> String #

parseExpectedVersionViolation :: SqlError -> Maybe ExpectedVersionViolation Source #

lookupById :: Connection -> MessageId -> IO (Maybe Message) Source #

lookupByPosition :: Connection -> GlobalPosition -> IO (Maybe Message) Source #

writeMessage :: (ToJSON payload, ToJSON metadata) => Connection -> StreamName -> MessageType -> payload -> Maybe metadata -> Maybe ExpectedVersion -> IO (MessageId, StreamPosition) Source #

Write a JSON-formatted message to a named stream, optionally specifying JSON-formatted metadata and an expected version number.

getStreamMessages :: Connection -> StreamName -> Maybe StreamPosition -> Maybe BatchSize -> Maybe Condition -> IO [Message] Source #

Retrieve messages from a single stream, optionally specifying the starting position, the number of messages to retrieve, and an additional condition that will be appended to the SQL command's WHERE clause.

getCategoryMessages :: Connection -> CategoryName -> Maybe GlobalPosition -> Maybe BatchSize -> Maybe Correlation -> Maybe ConsumerGroup -> Maybe Condition -> IO [Message] Source #

Retrieve messages from a category of streams, optionally specifying the starting position, the number of messages to retrieve, the correlation category for Pub/Sub, consumer group parameters, and an additional condition that will be appended to the SQL command's WHERE clause.

getLastStreamMessage :: Connection -> StreamName -> IO (Maybe Message) Source #

Row from the messages table that corresponds to the highest position number in the stream.

streamVersion :: Connection -> StreamName -> IO (Maybe StreamPosition) Source #

Highest position number in the stream.