MessageDb.StreamName

Streams are the fundamental unit of organization of evented, service-oriented systems. They are both the storage and the transport of messages in message-based systems. And they are the principle storage medium of applicative entity data.

Streams are created by writing a message to the stream. Messages are appended to the end of streams. If the stream doesn't exist when an event is appended to it, the event will be appended at position 0. If the stream already exists, the event will be appended at the next position number.

Read more at: http://docs.eventide-project.org/core-concepts/streams

Documentation

newtype StreamName

Name of a stream.

Constructors

StreamName

Fields

• streamNameToText :: Text

Instances

Eq StreamName

Defined in MessageDb.StreamName

Methods

(==) :: StreamName -> StreamName -> Bool

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

Ord StreamName

Defined in MessageDb.StreamName

Methods

compare :: StreamName -> StreamName -> Ordering

(<) :: StreamName -> StreamName -> Bool

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

(>) :: StreamName -> StreamName -> Bool

(>=) :: StreamName -> StreamName -> Bool

max :: StreamName -> StreamName -> StreamName

min :: StreamName -> StreamName -> StreamName

Show StreamName

Defined in MessageDb.StreamName

Methods

showsPrec :: Int -> StreamName -> ShowS

show :: StreamName -> String

showList :: [StreamName] -> ShowS

IsString StreamName

Defined in MessageDb.StreamName

Methods

fromString :: String -> StreamName

Semigroup StreamName

Defined in MessageDb.StreamName

Methods

(<>) :: StreamName -> StreamName -> StreamName

sconcat :: NonEmpty StreamName -> StreamName

stimes :: Integral b => b -> StreamName -> StreamName

ToJSON StreamName

Defined in MessageDb.StreamName

Methods

toJSON :: StreamName -> Value

toEncoding :: StreamName -> Encoding

toJSONList :: [StreamName] -> Value

toEncodingList :: [StreamName] -> Encoding

FromJSON StreamName

Defined in MessageDb.StreamName

Methods

parseJSON :: Value -> Parser StreamName

parseJSONList :: Value -> Parser [StreamName]

data CategoryName

A category stream name does not have an ID. For example, the stream name for the category of all accounts is "account".

Instances

Eq CategoryName

Defined in MessageDb.StreamName

Methods

(==) :: CategoryName -> CategoryName -> Bool

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

Ord CategoryName

Defined in MessageDb.StreamName

Methods

compare :: CategoryName -> CategoryName -> Ordering

(<) :: CategoryName -> CategoryName -> Bool

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

(>) :: CategoryName -> CategoryName -> Bool

(>=) :: CategoryName -> CategoryName -> Bool

max :: CategoryName -> CategoryName -> CategoryName

min :: CategoryName -> CategoryName -> CategoryName

Show CategoryName

Defined in MessageDb.StreamName

Methods

showsPrec :: Int -> CategoryName -> ShowS

show :: CategoryName -> String

showList :: [CategoryName] -> ShowS

ToJSON CategoryName

Defined in MessageDb.StreamName

Methods

toJSON :: CategoryName -> Value

toEncoding :: CategoryName -> Encoding

toJSONList :: [CategoryName] -> Value

toEncodingList :: [CategoryName] -> Encoding

FromJSON CategoryName

Defined in MessageDb.StreamName

Methods

parseJSON :: Value -> Parser CategoryName

parseJSONList :: Value -> Parser [CategoryName]

categoryOfStream :: StreamName -> CategoryName

Gets the category of a stream. For example for "account-123" it would return "account".

categoryNameToText :: CategoryName -> Text

Converts from a CategoryName to a nromal Text.

categoryName :: Text -> CategoryName

newtype IdentityName

The identifier part of a stream name. Anything after the first hypen (-).

Constructors

IdentityName

Fields

• identityNameToText :: Text

Instances

Eq IdentityName

Defined in MessageDb.StreamName

Methods

(==) :: IdentityName -> IdentityName -> Bool

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

Ord IdentityName

Defined in MessageDb.StreamName

Methods

compare :: IdentityName -> IdentityName -> Ordering

(<) :: IdentityName -> IdentityName -> Bool

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

(>) :: IdentityName -> IdentityName -> Bool

(>=) :: IdentityName -> IdentityName -> Bool

max :: IdentityName -> IdentityName -> IdentityName

min :: IdentityName -> IdentityName -> IdentityName

Show IdentityName

Defined in MessageDb.StreamName

Methods

showsPrec :: Int -> IdentityName -> ShowS

show :: IdentityName -> String

showList :: [IdentityName] -> ShowS

ToJSON IdentityName

Defined in MessageDb.StreamName

Methods

toJSON :: IdentityName -> Value

toEncoding :: IdentityName -> Encoding

toJSONList :: [IdentityName] -> Value

toEncodingList :: [IdentityName] -> Encoding

FromJSON IdentityName

Defined in MessageDb.StreamName

Methods

parseJSON :: Value -> Parser IdentityName

parseJSONList :: Value -> Parser [IdentityName]

identityOfStream :: StreamName -> Maybe IdentityName

Gets the identifier of a stream from a StreamName. For example "account-ed3b4af7-b4a0-499e-8a16-a09763811274" would return Just "ed3b4af7-b4a0-499e-8a16-a09763811274", and "account" would return Nothing.

addIdentityToCategory :: CategoryName -> IdentityName -> StreamName

Add an identifier to a CategoryName. For example category "account" and identity "123" would return "account-123".

addMaybeIdentityToCategory :: CategoryName -> Maybe IdentityName -> StreamName

Add a maybe identifier, allowing you to add an identifier to the stream name if it is Just.