Safe Haskell	None
Language	Haskell2010

Database.Redis.Cluster

Synopsis

data Connection = Connection {
- connectionNodes :: HashMap NodeID NodeConnection
- connectionPipeline :: MVar Pipeline
- connectionShardMap :: MVar ShardMap
- connectionInfoMap :: InfoMap
- connectionHooks :: Hooks
}
data NodeRole
- = Master
- | Slave
data NodeConnection = NodeConnection {
- nodeConnectionContext :: ConnectionContext
- nodeConnectionLastRecvRef :: IORef (Maybe ByteString)
- nodeConnectionNodeId :: NodeID
}
data Node = Node {
- nodeId :: NodeID
- nodeRole :: NodeRole
- nodeHost :: Host
- nodePort :: Port
}
newtype ShardMap = ShardMap (IntMap Shard)
data HashSlot
data Shard = Shard {
- shardMaster :: MasterNode
- shardSlaves :: [SlaveNode]
}
connect :: [CommandInfo] -> MVar ShardMap -> Maybe Int -> Hooks -> IO Connection
connectWith :: Maybe ByteString -> Maybe ByteString -> Maybe ClientParams -> [CommandInfo] -> MVar ShardMap -> Maybe Int -> Hooks -> IO Connection
disconnect :: Connection -> IO ()
requestPipelined :: IO ShardMap -> Connection -> [ByteString] -> IO Reply
nodes :: ShardMap -> [Node]
hooks :: Connection -> Hooks
requestMasterNodes :: Connection -> [ByteString] -> IO [Reply]
masterNodes :: Connection -> IO [NodeConnection]
getRandomConnection :: NodeConnection -> Connection -> NodeConnection

Documentation

data Connection Source #

A connection to a redis cluster, it is composed of a map from Node IDs to | NodeConnections, a Pipeline, and a ShardMap

Constructors

Connection
Fields connectionNodes :: HashMap NodeID NodeConnection connectionPipeline :: MVar Pipeline connectionShardMap :: MVar ShardMap connectionInfoMap :: InfoMap connectionHooks :: Hooks

data NodeRole Source #

Constructors

Master
Slave

Instances

Instances details

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

data NodeConnection Source #

A connection to a single node in the cluster, similar to Connection

Constructors

NodeConnection
Fields nodeConnectionContext :: ConnectionContext nodeConnectionLastRecvRef :: IORef (Maybe ByteString) nodeConnectionNodeId :: NodeID

Instances

Instances details

Eq NodeConnection Source #
Instance details Defined in Database.Redis.Cluster Methods (==) :: NodeConnection -> NodeConnection -> Bool # (/=) :: NodeConnection -> NodeConnection -> Bool #
Ord NodeConnection Source #
Instance details Defined in Database.Redis.Cluster Methods compare :: NodeConnection -> NodeConnection -> Ordering # (<) :: NodeConnection -> NodeConnection -> Bool # (<=) :: NodeConnection -> NodeConnection -> Bool # (>) :: NodeConnection -> NodeConnection -> Bool # (>=) :: NodeConnection -> NodeConnection -> Bool # max :: NodeConnection -> NodeConnection -> NodeConnection # min :: NodeConnection -> NodeConnection -> NodeConnection #

data Node Source #

Represents a single node, note that this type does not include the connection to the node because the shard map can be shared amongst multiple connections

Constructors

Node
Fields nodeId :: NodeID nodeRole :: NodeRole nodeHost :: Host nodePort :: Port

Instances

Instances details

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

newtype ShardMap Source #

A map from hashslot to shards

Constructors

ShardMap (IntMap Shard)

Instances

Instances details

Show ShardMap Source #
Instance details Defined in Database.Redis.Cluster Methods showsPrec :: Int -> ShardMap -> ShowS # show :: ShardMap -> String # showList :: [ShardMap] -> ShowS #

data HashSlot Source #

Instances

Instances details

Enum HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods succ :: HashSlot -> HashSlot # pred :: HashSlot -> HashSlot # toEnum :: Int -> HashSlot # fromEnum :: HashSlot -> Int # enumFrom :: HashSlot -> [HashSlot] # enumFromThen :: HashSlot -> HashSlot -> [HashSlot] # enumFromTo :: HashSlot -> HashSlot -> [HashSlot] # enumFromThenTo :: HashSlot -> HashSlot -> HashSlot -> [HashSlot] #
Num HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods (+) :: HashSlot -> HashSlot -> HashSlot # (-) :: HashSlot -> HashSlot -> HashSlot # (*) :: HashSlot -> HashSlot -> HashSlot # negate :: HashSlot -> HashSlot # abs :: HashSlot -> HashSlot # signum :: HashSlot -> HashSlot # fromInteger :: Integer -> HashSlot #
Integral HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods quot :: HashSlot -> HashSlot -> HashSlot # rem :: HashSlot -> HashSlot -> HashSlot # div :: HashSlot -> HashSlot -> HashSlot # mod :: HashSlot -> HashSlot -> HashSlot # quotRem :: HashSlot -> HashSlot -> (HashSlot, HashSlot) # divMod :: HashSlot -> HashSlot -> (HashSlot, HashSlot) # toInteger :: HashSlot -> Integer #
Real HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods toRational :: HashSlot -> Rational #
Show HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods showsPrec :: Int -> HashSlot -> ShowS # show :: HashSlot -> String # showList :: [HashSlot] -> ShowS #
Eq HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods (==) :: HashSlot -> HashSlot -> Bool # (/=) :: HashSlot -> HashSlot -> Bool #
Ord HashSlot Source #
Instance details Defined in Database.Redis.Cluster.HashSlot Methods compare :: HashSlot -> HashSlot -> Ordering # (<) :: HashSlot -> HashSlot -> Bool # (<=) :: HashSlot -> HashSlot -> Bool # (>) :: HashSlot -> HashSlot -> Bool # (>=) :: HashSlot -> HashSlot -> Bool # max :: HashSlot -> HashSlot -> HashSlot # min :: HashSlot -> HashSlot -> HashSlot #

data Shard Source #

A shard is a master node and 0 or more slaves, (the master, slave terminology is unfortunate but I felt it better to follow the documentation until it changes).

Constructors

Shard
Fields shardMaster :: MasterNode shardSlaves :: [SlaveNode]

Instances

Instances details

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

connect :: [CommandInfo] -> MVar ShardMap -> Maybe Int -> Hooks -> IO Connection Source #

Deprecated: Use connectWith instead, passing Nothing for the parameters you don't need.

Backwards compatible version of connect that can't provide authentication or TLS parameters.

connectWith :: Maybe ByteString -> Maybe ByteString -> Maybe ClientParams -> [CommandInfo] -> MVar ShardMap -> Maybe Int -> Hooks -> IO Connection Source #

Connects to cluster.

disconnect :: Connection -> IO () Source #

requestPipelined :: IO ShardMap -> Connection -> [ByteString] -> IO Reply Source #

nodes :: ShardMap -> [Node] Source #

hooks :: Connection -> Hooks Source #

requestMasterNodes :: Connection -> [ByteString] -> IO [Reply] Source #

Send a request to all master nodes in the cluster. This is useful for commands that need to be sent to all master nodes, such as FLUSHALL or `CONFIG SET`.

masterNodes :: Connection -> IO [NodeConnection] Source #

Get connection to a master nodes in the cluster. This is useful for commands that need to be sent to all master nodes, such as FLUSHALL or `CONFIG SET`.

getRandomConnection :: NodeConnection -> Connection -> NodeConnection Source #

Get connection to a random node in the cluster that is not the same as the provided connection.