Database.Redis.Schema

The schema-based Redis module. This module is intended to be imported qualified. That's why we don't have RedisRef but rather Ref.

Documentation

newtype Pool inst

Each instance has a distinct connection pool type. (Hedis names it Connection but it's a pool.)

Constructors

Pool

Fields

• _unPool :: Connection

newtype RedisM inst a

Instance-indexed monad for Redis computations.

Constructors

Redis

Fields

• unRedis :: Redis a

Instances

Monad (RedisM inst)

Defined in Database.Redis.Schema

Methods

(>>=) :: RedisM inst a -> (a -> RedisM inst b) -> RedisM inst b

(>>) :: RedisM inst a -> RedisM inst b -> RedisM inst b

return :: a -> RedisM inst a

Functor (RedisM inst)

Defined in Database.Redis.Schema

Methods

fmap :: (a -> b) -> RedisM inst a -> RedisM inst b

(<$) :: a -> RedisM inst b -> RedisM inst a

Applicative (RedisM inst)

Defined in Database.Redis.Schema

Methods

pure :: a -> RedisM inst a

(<*>) :: RedisM inst (a -> b) -> RedisM inst a -> RedisM inst b

liftA2 :: (a -> b -> c) -> RedisM inst a -> RedisM inst b -> RedisM inst c

(*>) :: RedisM inst a -> RedisM inst b -> RedisM inst b

(<*) :: RedisM inst a -> RedisM inst b -> RedisM inst a

MonadIO (RedisM inst)

Defined in Database.Redis.Schema

Methods

liftIO :: IO a -> RedisM inst a

MonadRedis (RedisM inst)

Defined in Database.Redis.Schema

Methods

liftRedis :: Redis a -> RedisM inst a

RedisCtx (RedisM inst) (Either Reply)

Defined in Database.Redis.Schema

Methods

returnDecode :: RedisResult a => Reply -> RedisM inst (Either Reply a)

type Redis = RedisM DefaultInstance

The Redis monad related to the default instance.

type Instance = Type

The kind of Redis instances. Ideally, this would be a user-defined DataKind, but since Haskell does not have implicit arguments, that would require that we index everything with it explicitly, which would create a lot of syntactic noise.

(Ab)using the Type kind for instances is a compromise.

data DefaultInstance

We also define a default instance. This is convenient for code bases using only one Redis instance, since RefInstance defaults to this. (See the Ref typeclass below.)

data Tx inst a

Redis transactions.

In comparison with Hedis transactions:

• Tx is newtyped as a separate functor for clearer types and better error messages.
• Tx is not a monad, just an Applicative functor. Applicative exactly corresponds to the nature of Redis transactions, and does not need Queued hacks.
• Tx supports throwing, and catching via Alternative. Beware that Tx is Applicative so all side effects will be carried out, whether any actions throw or not. Throwing and catching is done at the level where the _results_ of the individual applicative actions are composed.

You can still have do-notation with the ApplicativeDo extension.

Instances

Functor (Tx inst)

Defined in Database.Redis.Schema

Methods

fmap :: (a -> b) -> Tx inst a -> Tx inst b

(<$) :: a -> Tx inst b -> Tx inst a

Applicative (Tx inst)

Defined in Database.Redis.Schema

Methods

pure :: a -> Tx inst a

(<*>) :: Tx inst (a -> b) -> Tx inst a -> Tx inst b

liftA2 :: (a -> b -> c) -> Tx inst a -> Tx inst b -> Tx inst c

(*>) :: Tx inst a -> Tx inst b -> Tx inst b

(<*) :: Tx inst a -> Tx inst b -> Tx inst a

Alternative (Tx inst)

Defined in Database.Redis.Schema

Methods

empty :: Tx inst a

(<|>) :: Tx inst a -> Tx inst a -> Tx inst a

some :: Tx inst a -> Tx inst [a]

many :: Tx inst a -> Tx inst [a]

atomically :: Tx inst a -> RedisM inst a

Run a Tx transaction, propagating any errors.

runTx :: Tx inst a -> RedisM inst (TxResult (Either RedisException a))

Run a Redis transaction and return its result.

Most code will probably want to use atomically instead, which automatically propagates errors.

data RedisException

Constructors

BadConnectionString String String

CouldNotPing String

UnexpectedResult String String

UserException String

TransactionAborted

TransactionError String

CouldNotDecodeValue (Maybe ByteString)

LockAcquireTimeout

UnexpectedStatus String Status

EmptyAlternative

Instances

Show RedisException

Defined in Database.Redis.Schema

Methods

showsPrec :: Int -> RedisException -> ShowS

show :: RedisException -> String

showList :: [RedisException] -> ShowS

Exception RedisException

Defined in Database.Redis.Schema

Methods

toException :: RedisException -> SomeException

fromException :: SomeException -> Maybe RedisException

displayException :: RedisException -> String

class Value (RefInstance ref) (ValueType ref) => Ref ref where

Reference to some abstract Redis value.

ByteStrings are inappropriate for this purpose:

• Refs are typed.
• bytestring concatenation and other faffing is ugly and error-prone.
• some values may be stored across several Redis keys, (such as Tiers.Redis.Profile), in which case bytestrings are not even sufficient.

All methods have defaults for easy implementation of SimpleValues for new types. For simple values, it's sufficient to implement (or newtype-derive) SimpleValue, and declare an empty instance Value TheType.

Associated Types

type ValueType ref :: Type

Type of the value that this ref points to.

type RefInstance ref :: Instance

RedisM instance this ref points into, with a default.

type RefInstance ref = DefaultInstance

Methods

toIdentifier :: ref -> Identifier (ValueType ref)

How to convert the ref to an identifier that its value accepts.

Instances

(Ref ref, ValueType ref ~ Map k v, Serializable k, SimpleValue (RefInstance ref) v) => Ref (MapItem ref k v)

Defined in Database.Redis.Schema

Associated Types

type ValueType (MapItem ref k v)

type RefInstance (MapItem ref k v)

Methods

toIdentifier :: MapItem ref k v -> Identifier (ValueType (MapItem ref k v))

(Ref ref, ValueType ref ~ Record fieldF, SimpleValue (RefInstance ref) val, RecordField fieldF) => Ref (RecordItem ref fieldF val)

Defined in Database.Redis.Schema

Associated Types

type ValueType (RecordItem ref fieldF val)

type RefInstance (RecordItem ref fieldF val)

Methods

toIdentifier :: RecordItem ref fieldF val -> Identifier (ValueType (RecordItem ref fieldF val))

class Value inst val where

Type that can be read/written from Redis.

This can be a simple value, such as string or integer, or a composite value, such as a complex record stored across multiple keys, hashes, sets and lists.

We parameterise the typeclass with the Redis instance. Most Value instances will want to keep inst open but some may need to restrict it to a particular Redis instance; especially those that access Refs under the hood, since Refs are instance-specific.

Minimal complete definition

Nothing

Associated Types

type Identifier val :: Type

How the value is identified in Redis.

Types like hashes, sets or list are always top-level keys in Redis, so these are identified by bytestrings. Simple values can be top-level or hash fields, so they are identified by SimpleValueIdentifier. Complex values may be identified by something else; for example Profile is identified by a Token, because it's a complex value spread across multiple Redis keys.

type Identifier val = SimpleValueIdentifier

Methods

txValGet :: Identifier val -> Tx inst (Maybe val)

Read a value from Redis in a transaction.

default txValGet :: SimpleValue inst val => Identifier val -> Tx inst (Maybe val)

txValSet :: Identifier val -> val -> Tx inst ()

Write a value to Redis in a transaction.

default txValSet :: SimpleValue inst val => Identifier val -> val -> Tx inst ()

txValDelete :: Identifier val -> Tx inst ()

Delete a value from Redis in a transaction.

default txValDelete :: SimpleValue inst val => Identifier val -> Tx inst ()

txValSetTTLIfExists :: Identifier val -> TTL -> Tx inst Bool

Set time-to-live for a value in a transaction. Return True if the value exists.

default txValSetTTLIfExists :: SimpleValue inst val => Identifier val -> TTL -> Tx inst Bool

valGet :: Identifier val -> RedisM inst (Maybe val)

Read a value.

default valGet :: SimpleValue inst val => Identifier val -> RedisM inst (Maybe val)

valSet :: Identifier val -> val -> RedisM inst ()

Write a value.

default valSet :: SimpleValue inst val => Identifier val -> val -> RedisM inst ()

valDelete :: Identifier val -> RedisM inst ()

Delete a value.

default valDelete :: SimpleValue inst val => Identifier val -> RedisM inst ()

valSetTTLIfExists :: Identifier val -> TTL -> RedisM inst Bool

Set time-to-live for a value. Return True if the value exists.

default valSetTTLIfExists :: SimpleValue inst val => Identifier val -> TTL -> RedisM inst Bool

Instances

Value (inst :: k) ByteString

Defined in Database.Redis.Schema

Associated Types

type Identifier ByteString

Methods

txValGet :: Identifier ByteString -> Tx inst (Maybe ByteString)

txValSet :: Identifier ByteString -> ByteString -> Tx inst ()

txValDelete :: Identifier ByteString -> Tx inst ()

txValSetTTLIfExists :: Identifier ByteString -> TTL -> Tx inst Bool

valGet :: Identifier ByteString -> RedisM inst (Maybe ByteString)

valSet :: Identifier ByteString -> ByteString -> RedisM inst ()

valDelete :: Identifier ByteString -> RedisM inst ()

valSetTTLIfExists :: Identifier ByteString -> TTL -> RedisM inst Bool

Value (inst :: k) ByteString

Defined in Database.Redis.Schema

Associated Types

type Identifier ByteString

Methods

txValGet :: Identifier ByteString -> Tx inst (Maybe ByteString)

txValSet :: Identifier ByteString -> ByteString -> Tx inst ()

txValDelete :: Identifier ByteString -> Tx inst ()

txValSetTTLIfExists :: Identifier ByteString -> TTL -> Tx inst Bool

valGet :: Identifier ByteString -> RedisM inst (Maybe ByteString)

valSet :: Identifier ByteString -> ByteString -> RedisM inst ()

valDelete :: Identifier ByteString -> RedisM inst ()

valSetTTLIfExists :: Identifier ByteString -> TTL -> RedisM inst Bool

Value (inst :: k) LocalTime

Defined in Database.Redis.Schema

Associated Types

type Identifier LocalTime

Methods

txValGet :: Identifier LocalTime -> Tx inst (Maybe LocalTime)

txValSet :: Identifier LocalTime -> LocalTime -> Tx inst ()

txValDelete :: Identifier LocalTime -> Tx inst ()

txValSetTTLIfExists :: Identifier LocalTime -> TTL -> Tx inst Bool

valGet :: Identifier LocalTime -> RedisM inst (Maybe LocalTime)

valSet :: Identifier LocalTime -> LocalTime -> RedisM inst ()

valDelete :: Identifier LocalTime -> RedisM inst ()

valSetTTLIfExists :: Identifier LocalTime -> TTL -> RedisM inst Bool

Value (inst :: k) Day

Defined in Database.Redis.Schema

Associated Types

type Identifier Day

Methods

txValGet :: Identifier Day -> Tx inst (Maybe Day)

txValSet :: Identifier Day -> Day -> Tx inst ()

txValDelete :: Identifier Day -> Tx inst ()

txValSetTTLIfExists :: Identifier Day -> TTL -> Tx inst Bool

valGet :: Identifier Day -> RedisM inst (Maybe Day)

valSet :: Identifier Day -> Day -> RedisM inst ()

valDelete :: Identifier Day -> RedisM inst ()

valSetTTLIfExists :: Identifier Day -> TTL -> RedisM inst Bool

Value (inst :: k) UTCTime

Defined in Database.Redis.Schema

Associated Types

type Identifier UTCTime

Methods

txValGet :: Identifier UTCTime -> Tx inst (Maybe UTCTime)

txValSet :: Identifier UTCTime -> UTCTime -> Tx inst ()

txValDelete :: Identifier UTCTime -> Tx inst ()

txValSetTTLIfExists :: Identifier UTCTime -> TTL -> Tx inst Bool

valGet :: Identifier UTCTime -> RedisM inst (Maybe UTCTime)

valSet :: Identifier UTCTime -> UTCTime -> RedisM inst ()

valDelete :: Identifier UTCTime -> RedisM inst ()

valSetTTLIfExists :: Identifier UTCTime -> TTL -> RedisM inst Bool

Value (inst :: k) Bool

Defined in Database.Redis.Schema

Associated Types

type Identifier Bool

Methods

txValGet :: Identifier Bool -> Tx inst (Maybe Bool)

txValSet :: Identifier Bool -> Bool -> Tx inst ()

txValDelete :: Identifier Bool -> Tx inst ()

txValSetTTLIfExists :: Identifier Bool -> TTL -> Tx inst Bool

valGet :: Identifier Bool -> RedisM inst (Maybe Bool)

valSet :: Identifier Bool -> Bool -> RedisM inst ()

valDelete :: Identifier Bool -> RedisM inst ()

valSetTTLIfExists :: Identifier Bool -> TTL -> RedisM inst Bool

Value (inst :: k) Double

Defined in Database.Redis.Schema

Associated Types

type Identifier Double

Methods

txValGet :: Identifier Double -> Tx inst (Maybe Double)

txValSet :: Identifier Double -> Double -> Tx inst ()

txValDelete :: Identifier Double -> Tx inst ()

txValSetTTLIfExists :: Identifier Double -> TTL -> Tx inst Bool

valGet :: Identifier Double -> RedisM inst (Maybe Double)

valSet :: Identifier Double -> Double -> RedisM inst ()

valDelete :: Identifier Double -> RedisM inst ()

valSetTTLIfExists :: Identifier Double -> TTL -> RedisM inst Bool

Value (inst :: k) Integer

Defined in Database.Redis.Schema

Associated Types

type Identifier Integer

Methods

txValGet :: Identifier Integer -> Tx inst (Maybe Integer)

txValSet :: Identifier Integer -> Integer -> Tx inst ()

txValDelete :: Identifier Integer -> Tx inst ()

txValSetTTLIfExists :: Identifier Integer -> TTL -> Tx inst Bool

valGet :: Identifier Integer -> RedisM inst (Maybe Integer)

valSet :: Identifier Integer -> Integer -> RedisM inst ()

valDelete :: Identifier Integer -> RedisM inst ()

valSetTTLIfExists :: Identifier Integer -> TTL -> RedisM inst Bool

Value (inst :: k) Int64

Defined in Database.Redis.Schema

Associated Types

type Identifier Int64

Methods

txValGet :: Identifier Int64 -> Tx inst (Maybe Int64)

txValSet :: Identifier Int64 -> Int64 -> Tx inst ()

txValDelete :: Identifier Int64 -> Tx inst ()

txValSetTTLIfExists :: Identifier Int64 -> TTL -> Tx inst Bool

valGet :: Identifier Int64 -> RedisM inst (Maybe Int64)

valSet :: Identifier Int64 -> Int64 -> RedisM inst ()

valDelete :: Identifier Int64 -> RedisM inst ()

valSetTTLIfExists :: Identifier Int64 -> TTL -> RedisM inst Bool

Value (inst :: k) Word32

Defined in Database.Redis.Schema

Associated Types

type Identifier Word32

Methods

txValGet :: Identifier Word32 -> Tx inst (Maybe Word32)

txValSet :: Identifier Word32 -> Word32 -> Tx inst ()

txValDelete :: Identifier Word32 -> Tx inst ()

txValSetTTLIfExists :: Identifier Word32 -> TTL -> Tx inst Bool

valGet :: Identifier Word32 -> RedisM inst (Maybe Word32)

valSet :: Identifier Word32 -> Word32 -> RedisM inst ()

valDelete :: Identifier Word32 -> RedisM inst ()

valSetTTLIfExists :: Identifier Word32 -> TTL -> RedisM inst Bool

Value (inst :: k) Int

Defined in Database.Redis.Schema

Associated Types

type Identifier Int

Methods

txValGet :: Identifier Int -> Tx inst (Maybe Int)

txValSet :: Identifier Int -> Int -> Tx inst ()

txValDelete :: Identifier Int -> Tx inst ()

txValSetTTLIfExists :: Identifier Int -> TTL -> Tx inst Bool

valGet :: Identifier Int -> RedisM inst (Maybe Int)

valSet :: Identifier Int -> Int -> RedisM inst ()

valDelete :: Identifier Int -> RedisM inst ()

valSetTTLIfExists :: Identifier Int -> TTL -> RedisM inst Bool

Value (inst :: k) Text

Defined in Database.Redis.Schema

Associated Types

type Identifier Text

Methods

txValGet :: Identifier Text -> Tx inst (Maybe Text)

txValSet :: Identifier Text -> Text -> Tx inst ()

txValDelete :: Identifier Text -> Tx inst ()

txValSetTTLIfExists :: Identifier Text -> TTL -> Tx inst Bool

valGet :: Identifier Text -> RedisM inst (Maybe Text)

valSet :: Identifier Text -> Text -> RedisM inst ()

valDelete :: Identifier Text -> RedisM inst ()

valSetTTLIfExists :: Identifier Text -> TTL -> RedisM inst Bool

Value (inst :: k) ()

Defined in Database.Redis.Schema

Associated Types

type Identifier ()

Methods

txValGet :: Identifier () -> Tx inst (Maybe ())

txValSet :: Identifier () -> () -> Tx inst ()

txValDelete :: Identifier () -> Tx inst ()

txValSetTTLIfExists :: Identifier () -> TTL -> Tx inst Bool

valGet :: Identifier () -> RedisM inst (Maybe ())

valSet :: Identifier () -> () -> RedisM inst ()

valDelete :: Identifier () -> RedisM inst ()

valSetTTLIfExists :: Identifier () -> TTL -> RedisM inst Bool

(Serializable a, Ord a) => Value (inst :: k) (Set a)

Redis sets.

Defined in Database.Redis.Schema

Associated Types

type Identifier (Set a)

Methods

txValGet :: Identifier (Set a) -> Tx inst (Maybe (Set a))

txValSet :: Identifier (Set a) -> Set a -> Tx inst ()

txValDelete :: Identifier (Set a) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Set a) -> TTL -> Tx inst Bool

valGet :: Identifier (Set a) -> RedisM inst (Maybe (Set a))

valSet :: Identifier (Set a) -> Set a -> RedisM inst ()

valDelete :: Identifier (Set a) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Set a) -> TTL -> RedisM inst Bool

Serializable a => Value (inst :: k) [a]

Redis lists.

Defined in Database.Redis.Schema

Associated Types

type Identifier [a]

Methods

txValGet :: Identifier [a] -> Tx inst (Maybe [a])

txValSet :: Identifier [a] -> [a] -> Tx inst ()

txValDelete :: Identifier [a] -> Tx inst ()

txValSetTTLIfExists :: Identifier [a] -> TTL -> Tx inst Bool

valGet :: Identifier [a] -> RedisM inst (Maybe [a])

valSet :: Identifier [a] -> [a] -> RedisM inst ()

valDelete :: Identifier [a] -> RedisM inst ()

valSetTTLIfExists :: Identifier [a] -> TTL -> RedisM inst Bool

Serializables as => Value (inst :: k) (Tuple as)

Defined in Database.Redis.Schema

Associated Types

type Identifier (Tuple as)

Methods

txValGet :: Identifier (Tuple as) -> Tx inst (Maybe (Tuple as))

txValSet :: Identifier (Tuple as) -> Tuple as -> Tx inst ()

txValDelete :: Identifier (Tuple as) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Tuple as) -> TTL -> Tx inst Bool

valGet :: Identifier (Tuple as) -> RedisM inst (Maybe (Tuple as))

valSet :: Identifier (Tuple as) -> Tuple as -> RedisM inst ()

valDelete :: Identifier (Tuple as) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Tuple as) -> TTL -> RedisM inst Bool

Value (inst :: k) (Record fieldF)

Defined in Database.Redis.Schema

Associated Types

type Identifier (Record fieldF)

Methods

txValGet :: Identifier (Record fieldF) -> Tx inst (Maybe (Record fieldF))

txValSet :: Identifier (Record fieldF) -> Record fieldF -> Tx inst ()

txValDelete :: Identifier (Record fieldF) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Record fieldF) -> TTL -> Tx inst Bool

valGet :: Identifier (Record fieldF) -> RedisM inst (Maybe (Record fieldF))

valSet :: Identifier (Record fieldF) -> Record fieldF -> RedisM inst ()

valDelete :: Identifier (Record fieldF) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Record fieldF) -> TTL -> RedisM inst Bool

(Ord k2, Serializable k2, Serializable v) => Value (inst :: k1) (Map k2 v)

Redis hashes.

Defined in Database.Redis.Schema

Associated Types

type Identifier (Map k2 v)

Methods

txValGet :: Identifier (Map k2 v) -> Tx inst (Maybe (Map k2 v))

txValSet :: Identifier (Map k2 v) -> Map k2 v -> Tx inst ()

txValDelete :: Identifier (Map k2 v) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Map k2 v) -> TTL -> Tx inst Bool

valGet :: Identifier (Map k2 v) -> RedisM inst (Maybe (Map k2 v))

valSet :: Identifier (Map k2 v) -> Map k2 v -> RedisM inst ()

valDelete :: Identifier (Map k2 v) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Map k2 v) -> TTL -> RedisM inst Bool

(SimpleValue inst a, SimpleValue inst b) => Value (inst :: k) (a, b)

Defined in Database.Redis.Schema

Associated Types

type Identifier (a, b)

Methods

txValGet :: Identifier (a, b) -> Tx inst (Maybe (a, b))

txValSet :: Identifier (a, b) -> (a, b) -> Tx inst ()

txValDelete :: Identifier (a, b) -> Tx inst ()

txValSetTTLIfExists :: Identifier (a, b) -> TTL -> Tx inst Bool

valGet :: Identifier (a, b) -> RedisM inst (Maybe (a, b))

valSet :: Identifier (a, b) -> (a, b) -> RedisM inst ()

valDelete :: Identifier (a, b) -> RedisM inst ()

valSetTTLIfExists :: Identifier (a, b) -> TTL -> RedisM inst Bool

Value (inst :: k1) (PubSub msg)

Defined in Database.Redis.Schema

Associated Types

type Identifier (PubSub msg)

Methods

txValGet :: Identifier (PubSub msg) -> Tx inst (Maybe (PubSub msg))

txValSet :: Identifier (PubSub msg) -> PubSub msg -> Tx inst ()

txValDelete :: Identifier (PubSub msg) -> Tx inst ()

txValSetTTLIfExists :: Identifier (PubSub msg) -> TTL -> Tx inst Bool

valGet :: Identifier (PubSub msg) -> RedisM inst (Maybe (PubSub msg))

valSet :: Identifier (PubSub msg) -> PubSub msg -> RedisM inst ()

valDelete :: Identifier (PubSub msg) -> RedisM inst ()

valSetTTLIfExists :: Identifier (PubSub msg) -> TTL -> RedisM inst Bool

(SimpleValue inst a, SimpleValue inst b, SimpleValue inst c) => Value (inst :: k) (a, b, c)

Defined in Database.Redis.Schema

Associated Types

type Identifier (a, b, c)

Methods

txValGet :: Identifier (a, b, c) -> Tx inst (Maybe (a, b, c))

txValSet :: Identifier (a, b, c) -> (a, b, c) -> Tx inst ()

txValDelete :: Identifier (a, b, c) -> Tx inst ()

txValSetTTLIfExists :: Identifier (a, b, c) -> TTL -> Tx inst Bool

valGet :: Identifier (a, b, c) -> RedisM inst (Maybe (a, b, c))

valSet :: Identifier (a, b, c) -> (a, b, c) -> RedisM inst ()

valDelete :: Identifier (a, b, c) -> RedisM inst ()

valSetTTLIfExists :: Identifier (a, b, c) -> TTL -> RedisM inst Bool

Value (inst :: Type) ShareableLock

Defined in Database.Redis.Schema.Lock

Associated Types

type Identifier ShareableLock

Methods

txValGet :: Identifier ShareableLock -> Tx inst (Maybe ShareableLock)

txValSet :: Identifier ShareableLock -> ShareableLock -> Tx inst ()

txValDelete :: Identifier ShareableLock -> Tx inst ()

txValSetTTLIfExists :: Identifier ShareableLock -> TTL -> Tx inst Bool

valGet :: Identifier ShareableLock -> RedisM inst (Maybe ShareableLock)

valSet :: Identifier ShareableLock -> ShareableLock -> RedisM inst ()

valDelete :: Identifier ShareableLock -> RedisM inst ()

valSetTTLIfExists :: Identifier ShareableLock -> TTL -> RedisM inst Bool

Value (inst :: Type) LockSharing

Defined in Database.Redis.Schema.Lock

Associated Types

type Identifier LockSharing

Methods

txValGet :: Identifier LockSharing -> Tx inst (Maybe LockSharing)

txValSet :: Identifier LockSharing -> LockSharing -> Tx inst ()

txValDelete :: Identifier LockSharing -> Tx inst ()

txValSetTTLIfExists :: Identifier LockSharing -> TTL -> Tx inst Bool

valGet :: Identifier LockSharing -> RedisM inst (Maybe LockSharing)

valSet :: Identifier LockSharing -> LockSharing -> RedisM inst ()

valDelete :: Identifier LockSharing -> RedisM inst ()

valSetTTLIfExists :: Identifier LockSharing -> TTL -> RedisM inst Bool

Value (inst :: Type) ExclusiveLock

Defined in Database.Redis.Schema.Lock

Associated Types

type Identifier ExclusiveLock

Methods

txValGet :: Identifier ExclusiveLock -> Tx inst (Maybe ExclusiveLock)

txValSet :: Identifier ExclusiveLock -> ExclusiveLock -> Tx inst ()

txValDelete :: Identifier ExclusiveLock -> Tx inst ()

txValSetTTLIfExists :: Identifier ExclusiveLock -> TTL -> Tx inst Bool

valGet :: Identifier ExclusiveLock -> RedisM inst (Maybe ExclusiveLock)

valSet :: Identifier ExclusiveLock -> ExclusiveLock -> RedisM inst ()

valDelete :: Identifier ExclusiveLock -> RedisM inst ()

valSetTTLIfExists :: Identifier ExclusiveLock -> TTL -> RedisM inst Bool

type SimpleRef ref = (Ref ref, SimpleValue (RefInstance ref) (ValueType ref))

Ref pointing to a SimpleValue.

class (Value inst val, Identifier val ~ SimpleValueIdentifier, Serializable val) => SimpleValue inst val

Simple values, like strings, integers or enums, that be represented as a single bytestring.

Of course, any value can be represented as a single bytestring, but structures like lists, hashes and sets have special support in Redis. This allows insertions, updates, etc. in Redis directly, but they cannot be read or written as bytestrings, and thus are not SimpleValues.

Instances

SimpleValue (inst :: k) ByteString

Defined in Database.Redis.Schema

SimpleValue (inst :: k) ByteString

Defined in Database.Redis.Schema

SimpleValue (inst :: k) LocalTime

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Day

Defined in Database.Redis.Schema

SimpleValue (inst :: k) UTCTime

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Bool

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Double

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Integer

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Int64

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Word32

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Int

Defined in Database.Redis.Schema

SimpleValue (inst :: k) Text

Defined in Database.Redis.Schema

SimpleValue (inst :: k) ()

Defined in Database.Redis.Schema

Serializables as => SimpleValue (inst :: k) (Tuple as)

Defined in Database.Redis.Schema

(SimpleValue inst a, SimpleValue inst b) => SimpleValue (inst :: k) (a, b)

Defined in Database.Redis.Schema

(SimpleValue inst a, SimpleValue inst b, SimpleValue inst c) => SimpleValue (inst :: k) (a, b, c)

Defined in Database.Redis.Schema

SimpleValue (inst :: Type) LockSharing

Defined in Database.Redis.Schema.Lock

SimpleValue (inst :: Type) ExclusiveLock

Defined in Database.Redis.Schema.Lock

data SimpleValueIdentifier

Constructors

SviTopLevel ByteString

Stored in a top-level key.

SviHash ByteString ByteString

Stored in a hash field.

class Serializable val where

Methods

fromBS :: ByteString -> Maybe val

toBS :: val -> ByteString

Instances

Serializable Bool

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Bool

toBS :: Bool -> ByteString

Serializable Double

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Double

toBS :: Double -> ByteString

Serializable Int

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Int

toBS :: Int -> ByteString

Serializable Int64

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Int64

toBS :: Int64 -> ByteString

Serializable Integer

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Integer

toBS :: Integer -> ByteString

Serializable Word32

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Word32

toBS :: Word32 -> ByteString

Serializable ()

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe ()

toBS :: () -> ByteString

Serializable ByteString

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString0 -> Maybe ByteString

toBS :: ByteString -> ByteString0

Serializable ByteString

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe ByteString

toBS :: ByteString -> ByteString

Serializable Text

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Text

toBS :: Text -> ByteString

Serializable LocalTime

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe LocalTime

toBS :: LocalTime -> ByteString

Serializable UTCTime

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe UTCTime

toBS :: UTCTime -> ByteString

Serializable Day

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Day

toBS :: Day -> ByteString

Serializable UUID

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe UUID

toBS :: UUID -> ByteString

Serializable Priority

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Priority

toBS :: Priority -> ByteString

Serializable LockSharing

Defined in Database.Redis.Schema.Lock

Methods

fromBS :: ByteString -> Maybe LockSharing

toBS :: LockSharing -> ByteString

Serializable ExclusiveLock

Defined in Database.Redis.Schema.Lock

Methods

fromBS :: ByteString -> Maybe ExclusiveLock

toBS :: ExclusiveLock -> ByteString

Serializable a => Serializable (Maybe a)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (Maybe a)

toBS :: Maybe a -> ByteString

Serializables as => Serializable (Tuple as)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (Tuple as)

toBS :: Tuple as -> ByteString

(Serializable a, Serializable b) => Serializable (Either a b)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (Either a b)

toBS :: Either a b -> ByteString

(Serializable a, Serializable b) => Serializable (a, b)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (a, b)

toBS :: (a, b) -> ByteString

(Serializable a, Serializable b, Serializable c) => Serializable (a, b, c)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (a, b, c)

toBS :: (a, b, c) -> ByteString

class Serializables (as :: [Type]) where

Methods

encodeSerializables :: Tuple as -> [ByteString]

decodeSerializables :: [ByteString] -> Maybe (Tuple as)

Instances

Serializables ('[] :: [Type])

Defined in Database.Redis.Schema

Methods

encodeSerializables :: Tuple '[] -> [ByteString]

decodeSerializables :: [ByteString] -> Maybe (Tuple '[])

(Serializable a, Serializables as) => Serializables (a ': as)

Defined in Database.Redis.Schema

Methods

encodeSerializables :: Tuple (a ': as) -> [ByteString]

decodeSerializables :: [ByteString] -> Maybe (Tuple (a ': as))

newtype TTL

Time-To-Live for Redis values. The Num instance works in (integral) seconds.

Constructors

TTLSec

Fields

• ttlToSeconds :: Integer

Instances

Eq TTL

Defined in Database.Redis.Schema

Methods

(==) :: TTL -> TTL -> Bool

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

Num TTL

Defined in Database.Redis.Schema

Methods

(+) :: TTL -> TTL -> TTL

(-) :: TTL -> TTL -> TTL

(*) :: TTL -> TTL -> TTL

negate :: TTL -> TTL

abs :: TTL -> TTL

signum :: TTL -> TTL

fromInteger :: Integer -> TTL

Ord TTL

Defined in Database.Redis.Schema

Methods

compare :: TTL -> TTL -> Ordering

(<) :: TTL -> TTL -> Bool

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

(>) :: TTL -> TTL -> Bool

(>=) :: TTL -> TTL -> Bool

max :: TTL -> TTL -> TTL

min :: TTL -> TTL -> TTL

run :: MonadIO m => Pool inst -> RedisM inst a -> m a

connect :: String -> Int -> IO (Pool inst)

Open a connection pool to redis

incrementBy :: (SimpleRef ref, Num (ValueType ref)) => ref -> Integer -> RedisM (RefInstance ref) (ValueType ref)

Increment the value under the given ref.

incrementByFloat :: (SimpleRef ref, Floating (ValueType ref)) => ref -> Double -> RedisM (RefInstance ref) (ValueType ref)

Increment the value under the given ref.

txIncrementBy :: (SimpleRef ref, Num (ValueType ref)) => ref -> Integer -> Tx (RefInstance ref) (ValueType ref)

get :: Ref ref => ref -> RedisM (RefInstance ref) (Maybe (ValueType ref))

set :: Ref ref => ref -> ValueType ref -> RedisM (RefInstance ref) ()

getSet :: forall ref. SimpleRef ref => ref -> ValueType ref -> RedisM (RefInstance ref) (Maybe (ValueType ref))

Atomically set a value and return its old value.

txGet :: Ref ref => ref -> Tx (RefInstance ref) (Maybe (ValueType ref))

txSet :: Ref ref => ref -> ValueType ref -> Tx (RefInstance ref) ()

txExpect :: (Eq a, Show a) => String -> a -> Tx inst a -> Tx inst ()

Expect an exact value.

setWithTTL :: forall ref. SimpleRef ref => ref -> TTL -> ValueType ref -> RedisM (RefInstance ref) ()

Set value and TTL atomically.

setIfNotExists :: forall ref. SimpleRef ref => ref -> ValueType ref -> RedisM (RefInstance ref) Bool

setIfNotExists_ :: SimpleRef ref => ref -> ValueType ref -> RedisM (RefInstance ref) ()

txSetWithTTL :: SimpleRef ref => ref -> TTL -> ValueType ref -> Tx (RefInstance ref) ()

txSetIfNotExists :: forall ref. SimpleRef ref => ref -> ValueType ref -> Tx (RefInstance ref) Bool

txSetIfNotExists_ :: SimpleRef ref => ref -> ValueType ref -> Tx (RefInstance ref) ()

delete_ :: forall ref. Ref ref => ref -> RedisM (RefInstance ref) ()

txDelete_ :: forall ref. Ref ref => ref -> Tx (RefInstance ref) ()

take :: Ref ref => ref -> RedisM (RefInstance ref) (Maybe (ValueType ref))

Atomically read and delete.

txTake :: Ref ref => ref -> Tx (RefInstance ref) (Maybe (ValueType ref))

Atomically read and delete in a transaction.

setTTL :: Ref ref => ref -> TTL -> RedisM (RefInstance ref) ()

setTTLIfExists :: forall ref. Ref ref => ref -> TTL -> RedisM (RefInstance ref) Bool

Bump the TTL without changing the content.

setTTLIfExists_ :: Ref ref => ref -> TTL -> RedisM (RefInstance ref) ()

txSetTTL :: Ref ref => ref -> TTL -> Tx (RefInstance ref) ()

txSetTTLIfExists :: forall ref. Ref ref => ref -> TTL -> Tx (RefInstance ref) Bool

txSetTTLIfExists_ :: forall ref. Ref ref => ref -> TTL -> Tx (RefInstance ref) ()

readBS :: Read val => ByteString -> Maybe val

showBS :: Show val => val -> ByteString

showBinary :: Binary val => val -> ByteString

readBinary :: Binary val => ByteString -> Maybe val

colonSep :: [ByteString] -> ByteString

data Tuple :: [Type] -> Type where

Constructors

Nil :: Tuple '[]

(:*:) :: a -> Tuple as -> Tuple (a ': as) infixr 3

Instances

Serializables as => SimpleValue (inst :: k) (Tuple as)

Defined in Database.Redis.Schema

Serializables as => Value (inst :: k) (Tuple as)

Defined in Database.Redis.Schema

Associated Types

type Identifier (Tuple as)

Methods

txValGet :: Identifier (Tuple as) -> Tx inst (Maybe (Tuple as))

txValSet :: Identifier (Tuple as) -> Tuple as -> Tx inst ()

txValDelete :: Identifier (Tuple as) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Tuple as) -> TTL -> Tx inst Bool

valGet :: Identifier (Tuple as) -> RedisM inst (Maybe (Tuple as))

valSet :: Identifier (Tuple as) -> Tuple as -> RedisM inst ()

valDelete :: Identifier (Tuple as) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Tuple as) -> TTL -> RedisM inst Bool

(Eq a, Eq (Tuple as)) => Eq (Tuple (a ': as))

Defined in Database.Redis.Schema

Methods

(==) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

(/=) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

Eq (Tuple ('[] :: [Type]))

Defined in Database.Redis.Schema

Methods

(==) :: Tuple '[] -> Tuple '[] -> Bool

(/=) :: Tuple '[] -> Tuple '[] -> Bool

(Ord a, Ord (Tuple as)) => Ord (Tuple (a ': as))

Defined in Database.Redis.Schema

Methods

compare :: Tuple (a ': as) -> Tuple (a ': as) -> Ordering

(<) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

(<=) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

(>) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

(>=) :: Tuple (a ': as) -> Tuple (a ': as) -> Bool

max :: Tuple (a ': as) -> Tuple (a ': as) -> Tuple (a ': as)

min :: Tuple (a ': as) -> Tuple (a ': as) -> Tuple (a ': as)

Ord (Tuple ('[] :: [Type]))

Defined in Database.Redis.Schema

Methods

compare :: Tuple '[] -> Tuple '[] -> Ordering

(<) :: Tuple '[] -> Tuple '[] -> Bool

(<=) :: Tuple '[] -> Tuple '[] -> Bool

(>) :: Tuple '[] -> Tuple '[] -> Bool

(>=) :: Tuple '[] -> Tuple '[] -> Bool

max :: Tuple '[] -> Tuple '[] -> Tuple '[]

min :: Tuple '[] -> Tuple '[] -> Tuple '[]

Serializables as => Serializable (Tuple as)

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe (Tuple as)

toBS :: Tuple as -> ByteString

type Identifier (Tuple as)

Defined in Database.Redis.Schema

type Identifier (Tuple as) = SimpleValueIdentifier

day :: TTL

hour :: TTL

minute :: TTL

second :: TTL

throw :: RedisException -> RedisM inst a

throwMsg :: String -> RedisM inst a

sInsert :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> [a] -> RedisM (RefInstance ref) ()

Insert into a Redis set.

sDelete :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> [a] -> RedisM (RefInstance ref) ()

Delete from a Redis set.

sContains :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> a -> RedisM (RefInstance ref) Bool

Check membership in a Redis set.

sSize :: (Ref ref, ValueType ref ~ Set a) => ref -> RedisM (RefInstance ref) Integer

Get set size.

newtype Priority

Priority for a sorted set

Constructors

Priority

Fields

• unPriority :: Double

Instances

Bounded Priority

Defined in Database.Redis.Schema

Methods

minBound :: Priority

maxBound :: Priority

Serializable Priority

Defined in Database.Redis.Schema

Methods

fromBS :: ByteString -> Maybe Priority

toBS :: Priority -> ByteString

zInsert :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> [(Priority, a)] -> RedisM (RefInstance ref) ()

Add elements to a sorted set

zSize :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> RedisM (RefInstance ref) Integer

Get the cardinality (number of elements) of a sorted set

zCount :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> Priority -> Priority -> RedisM (RefInstance ref) Integer

Returns the number of elements in the sorted set that have a score between minScore and maxScore inclusive.

zDelete :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> a -> RedisM (RefInstance ref) ()

Delete from a Redis sorted set

zPopMin :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> Integer -> RedisM (RefInstance ref) [(Priority, a)]

Remove given number of smallest elements from a sorted set. Available since Redis 5.0.0

bzPopMin :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> Integer -> RedisM (RefInstance ref) (Maybe (Priority, a))

Remove the smallest element from a sorted set, and block for the given number of seconds when it is not there yet. Available since Redis 5.0.0

zRangeByScoreLimit :: forall ref a. (Ref ref, ValueType ref ~ [(Priority, a)], Serializable a) => ref -> Priority -> Priority -> Integer -> Integer -> RedisM (RefInstance ref) [a]

Get elements from a sorted set, between the given min and max values, and with the given offset and limit.

txSInsert :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> [a] -> Tx (RefInstance ref) ()

Insert into a Redis set in a transaction.

txSDelete :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> [a] -> Tx (RefInstance ref) ()

Delete from a Redis set in a transaction.

txSContains :: forall ref a. (Ref ref, ValueType ref ~ Set a, Serializable a) => ref -> a -> Tx (RefInstance ref) Bool

Check membership in a Redis set, in a transaction.

txSSize :: (Ref ref, ValueType ref ~ Set a) => ref -> Tx (RefInstance ref) Integer

Get set size, in a transaction.

data MapItem :: Type -> Type -> Type -> Type where

Map field addressing operator. If ref is a Ref pointing to a Map k v, then (ref :/ k) is a ref with type v, pointing to the entry in the map identified by k.

Constructors

(:/) :: (Ref ref, ValueType ref ~ Map k v) => ref -> k -> MapItem ref k v infix 3

Instances

(Ref ref, ValueType ref ~ Map k v, Serializable k, SimpleValue (RefInstance ref) v) => Ref (MapItem ref k v)

Defined in Database.Redis.Schema

Associated Types

type ValueType (MapItem ref k v)

type RefInstance (MapItem ref k v)

Methods

toIdentifier :: MapItem ref k v -> Identifier (ValueType (MapItem ref k v))

type ValueType (MapItem ref k v)

Defined in Database.Redis.Schema

type ValueType (MapItem ref k v) = v

type RefInstance (MapItem ref k v)

Defined in Database.Redis.Schema

type RefInstance (MapItem ref k v) = RefInstance ref

class RecordField (fieldF :: Type -> Type) where

Class of record fields. See Record for details.

Methods

rfToBS :: fieldF a -> ByteString

data RecordItem ref fieldF val

Record item addressing operator. If ref is a ref pointing to a Record fieldF, and k :: fieldF v is a field of that record, then (ref :. k) is a ref with type v, pointing to that field of that record.

Constructors

(:.) ref (fieldF val) infix 3

Instances

(Ref ref, ValueType ref ~ Record fieldF, SimpleValue (RefInstance ref) val, RecordField fieldF) => Ref (RecordItem ref fieldF val)

Defined in Database.Redis.Schema

Associated Types

type ValueType (RecordItem ref fieldF val)

type RefInstance (RecordItem ref fieldF val)

Methods

toIdentifier :: RecordItem ref fieldF val -> Identifier (ValueType (RecordItem ref fieldF val))

type ValueType (RecordItem ref fieldF val)

Defined in Database.Redis.Schema

type ValueType (RecordItem ref fieldF val) = val

type RefInstance (RecordItem ref fieldF val)

Defined in Database.Redis.Schema

type RefInstance (RecordItem ref fieldF val) = RefInstance ref

data Record (fieldF :: Type -> Type)

The value type for refs that point to records. Can be deleted and SetTTLed. Can't be read or written as a whole (at the moment).

The parameter fieldF gives the field functor for this record. This is usually a GADT indexed by the type of the corresponding record field.

Record and Map are related but different:

• Map is a homogeneous variable-size collection of associations k -> v, where all refs have the same type and all values have the same type, just like a Haskell Map.

Maps can be read/written to Redis as whole entities out-of-the-box.

• Record is a heterogeneous fixed-size record of items with different types, just like Haskell records.

Records cannot be read/written whole at the moment. There's no special reason for that, except that it would probably be too much type-level code that noone needs at the moment.

See also: (:.).

Instances

Value (inst :: k) (Record fieldF)

Defined in Database.Redis.Schema

Associated Types

type Identifier (Record fieldF)

Methods

txValGet :: Identifier (Record fieldF) -> Tx inst (Maybe (Record fieldF))

txValSet :: Identifier (Record fieldF) -> Record fieldF -> Tx inst ()

txValDelete :: Identifier (Record fieldF) -> Tx inst ()

txValSetTTLIfExists :: Identifier (Record fieldF) -> TTL -> Tx inst Bool

valGet :: Identifier (Record fieldF) -> RedisM inst (Maybe (Record fieldF))

valSet :: Identifier (Record fieldF) -> Record fieldF -> RedisM inst ()

valDelete :: Identifier (Record fieldF) -> RedisM inst ()

valSetTTLIfExists :: Identifier (Record fieldF) -> TTL -> RedisM inst Bool

type Identifier (Record fieldF)

Defined in Database.Redis.Schema

type Identifier (Record fieldF) = ByteString

lLength :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> RedisM (RefInstance ref) Integer

Length of a Redis list

lAppend :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> [a] -> RedisM (RefInstance ref) ()

Append to a Redis list.

txLAppend :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> [a] -> Tx (RefInstance ref) ()

Append to a Redis list in a transaction.

lPushLeft :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> [a] -> RedisM (RefInstance ref) ()

Prepend to a Redis list.

lPopRight :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> RedisM (RefInstance ref) (Maybe a)

Pop from the right.

lPopRightBlocking :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => TTL -> ref -> RedisM (RefInstance ref) (Maybe a)

Pop from the right, blocking.

lRem :: forall ref a. (Ref ref, ValueType ref ~ [a], Serializable a) => ref -> Integer -> a -> RedisM (RefInstance ref) ()

Delete from a Redis list

watch :: SimpleRef ref => ref -> RedisM (RefInstance ref) ()

Make any subsequent transaction fail if the watched ref is modified between the call to watch and the transaction.

unwatch :: RedisM inst ()

Unwatch all watched keys. I can't find it anywhere in the documentation but I hope that this unwatches only the keys for the current connection, and does not affect other connections. Nothing else would make much sense.

unliftIO :: ((forall a. RedisM inst a -> IO a) -> IO b) -> RedisM inst b

deleteIfEqual :: forall ref. SimpleRef ref => ref -> ValueType ref -> RedisM (RefInstance ref) Bool

setIfNotExistsTTL :: forall ref. SimpleRef ref => ref -> ValueType ref -> TTL -> RedisM (RefInstance ref) Bool

data PubSub msg

PubSub channels.

Instances

Value (inst :: k1) (PubSub msg)

Defined in Database.Redis.Schema

Associated Types

type Identifier (PubSub msg)

Methods

txValGet :: Identifier (PubSub msg) -> Tx inst (Maybe (PubSub msg))

txValSet :: Identifier (PubSub msg) -> PubSub msg -> Tx inst ()

txValDelete :: Identifier (PubSub msg) -> Tx inst ()

txValSetTTLIfExists :: Identifier (PubSub msg) -> TTL -> Tx inst Bool

valGet :: Identifier (PubSub msg) -> RedisM inst (Maybe (PubSub msg))

valSet :: Identifier (PubSub msg) -> PubSub msg -> RedisM inst ()

valDelete :: Identifier (PubSub msg) -> RedisM inst ()

valSetTTLIfExists :: Identifier (PubSub msg) -> TTL -> RedisM inst Bool

type Identifier (PubSub msg)

Defined in Database.Redis.Schema

type Identifier (PubSub msg) = ByteString

pubSubListen :: (Ref ref, ValueType ref ~ PubSub msg, Serializable msg) => ref -> (Either RedisException msg -> IO Bool) -> RedisM (RefInstance ref) ()

pubSubCountSubs :: (Ref ref, ValueType ref ~ PubSub msg) => ref -> RedisM (RefInstance ref) Integer

Orphan instances

(RedisResult a, RedisResult b, RedisResult c) => RedisResult (a, b, c)

Methods

decode :: Reply -> Either Reply (a, b, c)