Safe Haskell	None
Language	Haskell2010

JetStream.API.KeyValue

Description

JetStream key-value contract.

Documentation

data KeyValueAPI #

data KeyValueBucket #

Instances

Instances details

Show KeyValueBucket
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueBucket -> ShowS # show :: KeyValueBucket -> String # showList :: [KeyValueBucket] -> ShowS #
Eq KeyValueBucket
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueBucket -> KeyValueBucket -> Bool # (/=) :: KeyValueBucket -> KeyValueBucket -> Bool #
Ord KeyValueBucket
Instance details Defined in JetStream.KeyValue.Types Methods compare :: KeyValueBucket -> KeyValueBucket -> Ordering # (<) :: KeyValueBucket -> KeyValueBucket -> Bool # (<=) :: KeyValueBucket -> KeyValueBucket -> Bool # (>) :: KeyValueBucket -> KeyValueBucket -> Bool # (>=) :: KeyValueBucket -> KeyValueBucket -> Bool # max :: KeyValueBucket -> KeyValueBucket -> KeyValueBucket # min :: KeyValueBucket -> KeyValueBucket -> KeyValueBucket #

data KeyValueError #

Instances

Instances details

Show KeyValueError
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueError -> ShowS # show :: KeyValueError -> String # showList :: [KeyValueError] -> ShowS #
Eq KeyValueError
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueError -> KeyValueError -> Bool # (/=) :: KeyValueError -> KeyValueError -> Bool #

type KeyValueBucketName = ByteString #

data KeyValueConfig #

Instances

Instances details

Show KeyValueConfig
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueConfig -> ShowS # show :: KeyValueConfig -> String # showList :: [KeyValueConfig] -> ShowS #
Eq KeyValueConfig
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueConfig -> KeyValueConfig -> Bool # (/=) :: KeyValueConfig -> KeyValueConfig -> Bool #

type KeyValueConfigOption = CallOption KeyValueConfig #

data KeyValueOperation #

Constructors

KeyValuePut
KeyValueDelete
KeyValuePurge

Instances

Instances details

Show KeyValueOperation
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueOperation -> ShowS # show :: KeyValueOperation -> String # showList :: [KeyValueOperation] -> ShowS #
Eq KeyValueOperation
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueOperation -> KeyValueOperation -> Bool # (/=) :: KeyValueOperation -> KeyValueOperation -> Bool #

type KeyValueDeleteOption = CallOption KeyValueDeleteConfig #

data KeyValueEntry #

Instances

Instances details

Show KeyValueEntry
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueEntry -> ShowS # show :: KeyValueEntry -> String # showList :: [KeyValueEntry] -> ShowS #
Eq KeyValueEntry
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueEntry -> KeyValueEntry -> Bool # (/=) :: KeyValueEntry -> KeyValueEntry -> Bool #

type KeyValueKey = ByteString #

type KeyValuePattern = ByteString #

type KeyValuePurgeDeletesOption = CallOption KeyValuePurgeDeletesConfig #

type KeyValueRevision = Word64 #

data KeyValueStatus #

Instances

Instances details

Show KeyValueStatus
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueStatus -> ShowS # show :: KeyValueStatus -> String # showList :: [KeyValueStatus] -> ShowS #
Eq KeyValueStatus
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueStatus -> KeyValueStatus -> Bool # (/=) :: KeyValueStatus -> KeyValueStatus -> Bool #

type KeyValueValue = ByteString #

data KeyValueWatchBatch #

Instances

Instances details

Show KeyValueWatchBatch
Instance details Defined in JetStream.KeyValue.Types Methods showsPrec :: Int -> KeyValueWatchBatch -> ShowS # show :: KeyValueWatchBatch -> String # showList :: [KeyValueWatchBatch] -> ShowS #
Eq KeyValueWatchBatch
Instance details Defined in JetStream.KeyValue.Types Methods (==) :: KeyValueWatchBatch -> KeyValueWatchBatch -> Bool # (/=) :: KeyValueWatchBatch -> KeyValueWatchBatch -> Bool #

type KeyValueWatchOption = CallOption KeyValueWatchConfig #

data KeyValueWatcher #

withKeyValueCompression :: Bool -> KeyValueConfigOption #

withKeyValueDeleteMarkersOlderThan :: NominalDiffTime -> KeyValuePurgeDeletesOption #

withKeyValueDescription :: ByteString -> KeyValueConfigOption #

withKeyValueHistory :: Int -> KeyValueConfigOption #

withKeyValueIgnoreDeletes :: KeyValueWatchOption #

withKeyValueIncludeHistory :: KeyValueWatchOption #

withKeyValueLastRevision :: KeyValueRevision -> KeyValueDeleteOption #

withKeyValueMaxBytes :: Integer -> KeyValueConfigOption #

withKeyValueMaxValueSize :: Int32 -> KeyValueConfigOption #

withKeyValueMetadataOnly :: KeyValueWatchOption #

withKeyValueReplicas :: Int -> KeyValueConfigOption #

withKeyValueStorage :: StorageType -> KeyValueConfigOption #

withKeyValueTTL :: NominalDiffTime -> KeyValueConfigOption #

withKeyValueUpdatesOnly :: KeyValueWatchOption #

KeyValueJetStreamError JetStreamError
KeyValueInvalidBucketName KeyValueBucketName
KeyValueInvalidKey KeyValueKey
KeyValueInvalidPattern KeyValuePattern
KeyValueInvalidHistory Int
KeyValueInvalidMaxValueSize Int32
KeyValueInvalidMaxBytes Integer
KeyValueInvalidTTL NominalDiffTime
KeyValueInvalidReplicas Int
KeyValueInvalidWatchOptions
KeyValueBucketNotFound KeyValueBucketName
KeyValueBucketExists KeyValueBucketName
KeyValueInvalidBucket KeyValueBucketName
KeyValueKeyNotFound KeyValueBucketName KeyValueKey
KeyValueKeyExists KeyValueBucketName KeyValueKey
KeyValueRevisionMismatch KeyValueBucketName KeyValueKey KeyValueRevision
KeyValueNoKeysFound KeyValueBucketName
KeyValueDecodeError String