Database.Persist.Redis

Documentation

newtype RedisAuth

Constructors

RedisAuth Text

Instances

Eq RedisAuth

Defined in Database.Persist.Redis.Config

Methods

(==) :: RedisAuth -> RedisAuth -> Bool

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

Show RedisAuth

Defined in Database.Persist.Redis.Config

Methods

showsPrec :: Int -> RedisAuth -> ShowS

show :: RedisAuth -> String

showList :: [RedisAuth] -> ShowS

FromJSON RedisAuth

Defined in Database.Persist.Redis.Config

Methods

parseJSON :: Value -> Parser RedisAuth

parseJSONList :: Value -> Parser [RedisAuth]

data RedisConf

Information required to connect to a Redis server

Constructors

RedisConf

Fields

• rdHost :: Text

  Host

• rdPort :: PortID

  Port

• rdAuth :: Maybe RedisAuth

  Auth info

• rdMaxConn :: Int

  Maximum number of connections

Instances

Show RedisConf

Defined in Database.Persist.Redis.Config

Methods

showsPrec :: Int -> RedisConf -> ShowS

show :: RedisConf -> String

showList :: [RedisConf] -> ShowS

PersistConfig RedisConf

Defined in Database.Persist.Redis.Config

Associated Types

type PersistConfigBackend RedisConf :: (Type -> Type) -> Type -> Type

type PersistConfigPool RedisConf

Methods

loadConfig :: Value -> Parser RedisConf

applyEnv :: RedisConf -> IO RedisConf

createPoolConfig :: RedisConf -> IO (PersistConfigPool RedisConf)

runPool :: MonadUnliftIO m => RedisConf -> PersistConfigBackend RedisConf m a -> PersistConfigPool RedisConf -> m a

type PersistConfigPool RedisConf

Defined in Database.Persist.Redis.Config

type PersistConfigPool RedisConf = Connection

type PersistConfigBackend RedisConf

Defined in Database.Persist.Redis.Config

type PersistConfigBackend RedisConf = RedisT

class MonadRedis m => RedisCtx (m :: Type -> Type) (f :: Type -> Type) | m -> f

This class captures the following behaviour: In a context m, a command will return its result wrapped in a "container" of type f.

Please refer to the Command Type Signatures section of this page for more information.

Minimal complete definition

returnDecode

Instances

RedisCtx RedisTx Queued

Defined in Database.Redis.Transactions

Methods

returnDecode :: RedisResult a => Reply -> RedisTx (Queued a)

RedisCtx Redis (Either Reply)

Defined in Database.Redis.Core

Methods

returnDecode :: RedisResult a => Reply -> Redis (Either Reply a)

data Redis a

Context for normal command execution, outside of transactions. Use runRedis to run actions of this type.

In this context, each result is wrapped in an Either to account for the possibility of Redis returning an Error reply.

Instances

Monad Redis

Defined in Database.Redis.Core.Internal

Methods

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

(>>) :: Redis a -> Redis b -> Redis b

return :: a -> Redis a

Functor Redis

Defined in Database.Redis.Core.Internal

Methods

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

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

MonadFail Redis

Defined in Database.Redis.Core.Internal

Methods

fail :: String -> Redis a

Applicative Redis

Defined in Database.Redis.Core.Internal

Methods

pure :: a -> Redis a

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

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

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

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

MonadIO Redis

Defined in Database.Redis.Core.Internal

Methods

liftIO :: IO a -> Redis a

MonadRedis Redis

Defined in Database.Redis.Core

Methods

liftRedis :: Redis a -> Redis a

RedisCtx Redis (Either Reply)

Defined in Database.Redis.Core

Methods

returnDecode :: RedisResult a => Reply -> Redis (Either Reply a)

data Connection

A threadsafe pool of network connections to a Redis server. Use the connect function to create one.

Instances

HasPersistBackend Connection

Defined in Database.Persist.Redis.Store

Associated Types

type BaseBackend Connection

Methods

persistBackend :: Connection -> BaseBackend Connection

PersistCore Connection

Defined in Database.Persist.Redis.Store

Associated Types

data BackendKey Connection

PersistStoreRead Connection

Defined in Database.Persist.Redis.Store

Methods

get :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> ReaderT Connection m (Maybe record)

getMany :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => [Key record] -> ReaderT Connection m (Map (Key record) record)

PersistStoreWrite Connection

Defined in Database.Persist.Redis.Store

Methods

insert :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => record -> ReaderT Connection m (Key record)

insert_ :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => record -> ReaderT Connection m ()

insertMany :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => [record] -> ReaderT Connection m [Key record]

insertMany_ :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => [record] -> ReaderT Connection m ()

insertEntityMany :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => [Entity record] -> ReaderT Connection m ()

insertKey :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> record -> ReaderT Connection m ()

repsert :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> record -> ReaderT Connection m ()

repsertMany :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => [(Key record, record)] -> ReaderT Connection m ()

replace :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> record -> ReaderT Connection m ()

delete :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> ReaderT Connection m ()

update :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> [Update record] -> ReaderT Connection m ()

updateGet :: forall record (m :: Type -> Type). (MonadIO m, PersistRecordBackend record Connection) => Key record -> [Update record] -> ReaderT Connection m record

Eq (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

(==) :: BackendKey Connection -> BackendKey Connection -> Bool

(/=) :: BackendKey Connection -> BackendKey Connection -> Bool

Ord (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

compare :: BackendKey Connection -> BackendKey Connection -> Ordering

(<) :: BackendKey Connection -> BackendKey Connection -> Bool

(<=) :: BackendKey Connection -> BackendKey Connection -> Bool

(>) :: BackendKey Connection -> BackendKey Connection -> Bool

(>=) :: BackendKey Connection -> BackendKey Connection -> Bool

max :: BackendKey Connection -> BackendKey Connection -> BackendKey Connection

min :: BackendKey Connection -> BackendKey Connection -> BackendKey Connection

Read (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

readsPrec :: Int -> ReadS (BackendKey Connection)

readList :: ReadS [BackendKey Connection]

readPrec :: ReadPrec (BackendKey Connection)

readListPrec :: ReadPrec [BackendKey Connection]

Show (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

showsPrec :: Int -> BackendKey Connection -> ShowS

show :: BackendKey Connection -> String

showList :: [BackendKey Connection] -> ShowS

ToJSON (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

toJSON :: BackendKey Connection -> Value

toEncoding :: BackendKey Connection -> Encoding

toJSONList :: [BackendKey Connection] -> Value

toEncodingList :: [BackendKey Connection] -> Encoding

FromJSON (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

parseJSON :: Value -> Parser (BackendKey Connection)

parseJSONList :: Value -> Parser [BackendKey Connection]

ToHttpApiData (BackendKey RedisBackend)

Defined in Database.Persist.Redis.Store

Methods

toUrlPiece :: BackendKey RedisBackend -> Text

toEncodedUrlPiece :: BackendKey RedisBackend -> Builder

toHeader :: BackendKey RedisBackend -> ByteString

toQueryParam :: BackendKey RedisBackend -> Text

FromHttpApiData (BackendKey RedisBackend)

Defined in Database.Persist.Redis.Store

Methods

parseUrlPiece :: Text -> Either Text (BackendKey RedisBackend)

parseHeader :: ByteString -> Either Text (BackendKey RedisBackend)

parseQueryParam :: Text -> Either Text (BackendKey RedisBackend)

PathPiece (BackendKey RedisBackend)

Defined in Database.Persist.Redis.Store

Methods

fromPathPiece :: Text -> Maybe (BackendKey RedisBackend)

toPathPiece :: BackendKey RedisBackend -> Text

PersistFieldSql (BackendKey RedisBackend)

Defined in Database.Persist.Redis.Store

Methods

sqlType :: Proxy (BackendKey RedisBackend) -> SqlType

PersistField (BackendKey Connection)

Defined in Database.Persist.Redis.Store

Methods

toPersistValue :: BackendKey Connection -> PersistValue

fromPersistValue :: PersistValue -> Either Text (BackendKey Connection)

type BaseBackend Connection

Defined in Database.Persist.Redis.Store

type BaseBackend Connection = Connection

newtype BackendKey Connection

Defined in Database.Persist.Redis.Store

newtype BackendKey Connection = RedisKey Text

data PortID

Constructors

PortNumber PortNumber

UnixSocket String

Instances

Eq PortID

Defined in Database.Redis.ConnectionContext

Methods

(==) :: PortID -> PortID -> Bool

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

Show PortID

Defined in Database.Redis.ConnectionContext

Methods

showsPrec :: Int -> PortID -> ShowS

show :: PortID -> String

showList :: [PortID] -> ShowS

FromJSON PortID

Defined in Database.Persist.Redis.Config

Methods

parseJSON :: Value -> Parser PortID

parseJSONList :: Value -> Parser [PortID]

type RedisT = ReaderT Connection

Monad reader transformer keeping Redis connection through out the work

runRedisPool :: RedisT m a -> Connection -> m a

withRedisConn :: MonadIO m => RedisConf -> (Connection -> m a) -> m a

Run a connection reader function against a Redis configuration

thisConnection :: Monad m => RedisT m Connection

Extracts connection from RedisT monad transformer

module Database.Persist

execRedisT :: MonadIO m => RedisTx (Queued a) -> RedisT m a

Execute Redis transaction inside RedisT monad transformer

type RedisBackend = Connection

data RedisException

Constructors

NotSupportedOperation String

ParserError String

NotSupportedValueType String

IncorrectUpdate String

IncorrectBehavior

Instances

Show RedisException

Defined in Database.Persist.Redis.Exception

Methods

showsPrec :: Int -> RedisException -> ShowS

show :: RedisException -> String

showList :: [RedisException] -> ShowS

Exception RedisException

Defined in Database.Persist.Redis.Exception

Methods

toException :: RedisException -> SomeException

fromException :: SomeException -> Maybe RedisException

displayException :: RedisException -> String