Safe Haskell	None
Language	Haskell2010

Database.Redis.ManualCommands

Synopsis

objectRefcount :: RedisCtx m f => ByteString -> m (f Integer)
objectIdletime :: RedisCtx m f => ByteString -> m (f Integer)
objectEncoding :: RedisCtx m f => ByteString -> m (f ByteString)
linsertBefore :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Integer)
linsertAfter :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Integer)
data ListDirection
- = ListLeft
- | ListRight
data LPosOpts = LPosOpts {
- lposRank :: Maybe Integer
- lposMaxlen :: Maybe Integer
}
defaultLPosOpts :: LPosOpts
lpos :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe Integer))
lposOpts :: RedisCtx m f => ByteString -> ByteString -> LPosOpts -> m (f (Maybe Integer))
lposCount :: RedisCtx m f => ByteString -> ByteString -> Integer -> m (f [Integer])
lposCountOpts :: RedisCtx m f => ByteString -> ByteString -> Integer -> LPosOpts -> m (f [Integer])
lposOptsToArgs :: LPosOpts -> [ByteString]
lposOptsParts :: LPosOpts -> ([ByteString], [ByteString])
lmove :: RedisCtx m f => ByteString -> ByteString -> ListDirection -> ListDirection -> m (f (Maybe ByteString))
blmove :: RedisCtx m f => ByteString -> ByteString -> ListDirection -> ListDirection -> Integer -> m (f (Maybe ByteString))
lmpop :: RedisCtx m f => NonEmpty ByteString -> ListDirection -> m (f (Maybe (ByteString, [ByteString])))
lmpopCount :: RedisCtx m f => NonEmpty ByteString -> ListDirection -> Integer -> m (f (Maybe (ByteString, [ByteString])))
blmpop :: RedisCtx m f => Double -> NonEmpty ByteString -> ListDirection -> m (f (Maybe (ByteString, [ByteString])))
blmpopCount :: RedisCtx m f => Double -> NonEmpty ByteString -> ListDirection -> Integer -> m (f (Maybe (ByteString, [ByteString])))
getType :: RedisCtx m f => ByteString -> m (f RedisType)
data Slowlog = Slowlog {
- slowlogId :: Integer
- slowlogTimestamp :: Integer
- slowlogMicros :: Integer
- slowlogCmd :: [ByteString]
- slowlogClientIpAndPort :: Maybe ByteString
- slowlogClientName :: Maybe ByteString
}
slowlogGet :: RedisCtx m f => Integer -> m (f [Slowlog])
slowlogLen :: RedisCtx m f => m (f Integer)
slowlogReset :: RedisCtx m f => m (f Status)
zrange :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f [ByteString])
zrangeWithscores :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f [(ByteString, Double)])
zrevrange :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f [ByteString])
zrevrangeWithscores :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f [(ByteString, Double)])
zrangebyscore :: RedisCtx m f => ByteString -> Double -> Double -> m (f [ByteString])
zrangebyscoreWithscores :: RedisCtx m f => ByteString -> Double -> Double -> m (f [(ByteString, Double)])
zrangebyscoreLimit :: RedisCtx m f => ByteString -> Double -> Double -> Integer -> Integer -> m (f [ByteString])
zrangebyscoreWithscoresLimit :: RedisCtx m f => ByteString -> Double -> Double -> Integer -> Integer -> m (f [(ByteString, Double)])
zrevrangebyscore :: RedisCtx m f => ByteString -> Double -> Double -> m (f [ByteString])
zrevrangebyscoreWithscores :: RedisCtx m f => ByteString -> Double -> Double -> m (f [(ByteString, Double)])
zrevrangebyscoreLimit :: RedisCtx m f => ByteString -> Double -> Double -> Integer -> Integer -> m (f [ByteString])
zrevrangebyscoreWithscoresLimit :: RedisCtx m f => ByteString -> Double -> Double -> Integer -> Integer -> m (f [(ByteString, Double)])
data SortOpts = SortOpts {
- sortBy :: Maybe ByteString
- sortLimit :: (Integer, Integer)
- sortGet :: [ByteString]
- sortOrder :: SortOrder
- sortAlpha :: Bool
}
defaultSortOpts :: SortOpts
data SortOrder
- = Asc
- | Desc
sortStore :: RedisCtx m f => ByteString -> ByteString -> SortOpts -> m (f Integer)
sort :: RedisCtx m f => ByteString -> SortOpts -> m (f [ByteString])
sortInternal :: (RedisResult a, RedisCtx m f) => ByteString -> Maybe ByteString -> SortOpts -> m (f a)
data Aggregate
- = Sum
- | Min
- | Max
zunionstore :: RedisCtx m f => ByteString -> [ByteString] -> Aggregate -> m (f Integer)
zunionstoreWeights :: RedisCtx m f => ByteString -> [(ByteString, Double)] -> Aggregate -> m (f Integer)
zinterstore :: RedisCtx m f => ByteString -> NonEmpty ByteString -> Aggregate -> m (f Integer)
zinterstoreWeights :: RedisCtx m f => ByteString -> NonEmpty (ByteString, Double) -> Aggregate -> m (f Integer)
zstoreInternal :: RedisCtx m f => ByteString -> ByteString -> [ByteString] -> [Double] -> Aggregate -> m (f Integer)
zdiff :: RedisCtx m f => NonEmpty ByteString -> m (f [ByteString])
zdiffWithscores :: RedisCtx m f => NonEmpty ByteString -> m (f [(ByteString, Double)])
zdiffstore :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f Integer)
zinter :: RedisCtx m f => NonEmpty ByteString -> m (f [ByteString])
data ZAggregateOpts = ZAggregateOpts {
- zAggregateWeights :: [Double]
- zAggregateAggregate :: Aggregate
}
defaultZAggregateOpts :: ZAggregateOpts
zinterWithscores :: RedisCtx m f => NonEmpty ByteString -> m (f [(ByteString, Double)])
zinterOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [ByteString])
zinterWithscoresOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [(ByteString, Double)])
zunion :: RedisCtx m f => NonEmpty ByteString -> m (f [ByteString])
zunionWithscores :: RedisCtx m f => NonEmpty ByteString -> m (f [(ByteString, Double)])
zunionOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [ByteString])
zunionWithscoresOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [(ByteString, Double)])
zAggregateKeysArgs :: ByteString -> NonEmpty ByteString -> [ByteString]
zAggregateInternalArgs :: ByteString -> NonEmpty ByteString -> ZAggregateOpts -> Bool -> [ByteString]
eval :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a)
evalsha :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a)
fcall :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a)
fcallReadonly :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a)
data FunctionListOpts = FunctionListOpts {
- functionListLibraryName :: Maybe ByteString
- functionListWithCode :: Bool
}
defaultFunctionListOpts :: FunctionListOpts
data FunctionRestorePolicy
- = FunctionRestoreAppend
- | FunctionRestoreFlush
- | FunctionRestoreReplace
functionDelete :: RedisCtx m f => ByteString -> m (f Status)
functionDump :: RedisCtx m f => m (f ByteString)
functionFlush :: RedisCtx m f => m (f Status)
functionFlushOpts :: RedisCtx m f => FlushOpts -> m (f Status)
functionHelp :: RedisCtx m f => m (f [ByteString])
functionKill :: RedisCtx m f => m (f Status)
functionList :: RedisCtx m f => m (f Reply)
functionListOpts :: RedisCtx m f => FunctionListOpts -> m (f Reply)
functionLoad :: RedisCtx m f => ByteString -> m (f ByteString)
functionLoadReplace :: RedisCtx m f => ByteString -> m (f ByteString)
functionRestore :: RedisCtx m f => ByteString -> Maybe FunctionRestorePolicy -> m (f Status)
functionStats :: RedisCtx m f => m (f Reply)
bitcount :: RedisCtx m f => ByteString -> m (f Integer)
bitcountRange :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f Integer)
bitopAnd :: RedisCtx m f => ByteString -> [ByteString] -> m (f Integer)
bitopOr :: RedisCtx m f => ByteString -> [ByteString] -> m (f Integer)
bitopXor :: RedisCtx m f => ByteString -> [ByteString] -> m (f Integer)
bitopNot :: RedisCtx m f => ByteString -> ByteString -> m (f Integer)
bitop :: RedisCtx m f => ByteString -> [ByteString] -> m (f Integer)
data VAddQuantization
- = VAddNoQuant
- | VAddQ8
- | VAddBin
data VAddOpts = VAddOpts {
- vAddReduceDim :: Maybe Integer
- vAddCas :: Bool
- vAddQuantization :: Maybe VAddQuantization
- vAddBuildExplorationFactor :: Maybe Integer
- vAddAttributes :: Maybe ByteString
- vAddNumLinks :: Maybe Integer
}
data VQuantization
- = VQuantizationFP32
- | VQuantizationBin
- | VQuantizationQ8
data VEmbRawResponse = VEmbRawResponse {
- vEmbRawQuantization :: VQuantization
- vEmbRawData :: ByteString
- vEmbRawNorm :: Double
- vEmbRawRange :: Maybe Double
}
data VInfoResponse = VInfoResponse {
- vInfoQuantization :: Maybe ByteString
- vInfoVectorDim :: Maybe Integer
- vInfoSize :: Maybe Integer
- vInfoMaxLevel :: Maybe Integer
- vInfoUid :: Maybe Integer
- vInfoHnswMaxNodeUid :: Maybe Integer
}
newtype VLinksResponse = VLinksResponse {
- vLinksLayers :: [[ByteString]]
}
newtype VLinksWithScoresResponse = VLinksWithScoresResponse {
- vLinksWithScoresLayers :: [[(ByteString, Double)]]
}
data VSimQuery
- = VSimByElement ByteString
- | VSimByFp32 ByteString
- | VSimByValues (NonEmpty Double)
data VSimOpts = VSimOpts {
- vSimCount :: Maybe Integer
- vSimEpsilon :: Maybe Double
- vSimEf :: Maybe Integer
- vSimFilter :: Maybe ByteString
- vSimFilterEf :: Maybe Integer
- vSimTruth :: Bool
- vSimNoThread :: Bool
}
defaultVSimOpts :: VSimOpts
data VSimWithAttribsResult = VSimWithAttribsResult {
- vSimResultElement :: ByteString
- vSimResultScore :: Double
- vSimResultAttributes :: Maybe ByteString
}
newtype VSimWithAttribsResponse = VSimWithAttribsResponse {
- vSimWithAttribsResults :: [VSimWithAttribsResult]
}
defaultVAddOpts :: VAddOpts
vadd :: RedisCtx m f => ByteString -> NonEmpty Double -> ByteString -> m (f Bool)
vaddOpts :: RedisCtx m f => ByteString -> NonEmpty Double -> ByteString -> VAddOpts -> m (f Bool)
vcard :: RedisCtx m f => ByteString -> m (f Integer)
vdim :: RedisCtx m f => ByteString -> m (f Integer)
vemb :: RedisCtx m f => ByteString -> ByteString -> m (f [Double])
vembRaw :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe VEmbRawResponse))
vgetattr :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe ByteString))
vinfo :: RedisCtx m f => ByteString -> m (f (Maybe VInfoResponse))
vismember :: RedisCtx m f => ByteString -> ByteString -> m (f Bool)
vlinks :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe VLinksResponse))
vlinksWithScores :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe VLinksWithScoresResponse))
vrandmember :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
vrandmemberCount :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString])
vrange :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f [ByteString])
vrangeCount :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> m (f [ByteString])
vrem :: RedisCtx m f => ByteString -> ByteString -> m (f Bool)
vsetattr :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Bool)
vsim :: RedisCtx m f => ByteString -> VSimQuery -> m (f [ByteString])
vsimOpts :: RedisCtx m f => ByteString -> VSimQuery -> VSimOpts -> m (f [ByteString])
vsimWithScores :: RedisCtx m f => ByteString -> VSimQuery -> m (f [(ByteString, Double)])
vsimWithScoresOpts :: RedisCtx m f => ByteString -> VSimQuery -> VSimOpts -> m (f [(ByteString, Double)])
vsimWithScoresWithAttribs :: RedisCtx m f => ByteString -> VSimQuery -> m (f VSimWithAttribsResponse)
vsimWithScoresWithAttribsOpts :: RedisCtx m f => ByteString -> VSimQuery -> VSimOpts -> m (f VSimWithAttribsResponse)
vSimQueryArgs :: VSimQuery -> [ByteString]
vSimOptsArgs :: VSimOpts -> [ByteString]
migrate :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> Integer -> m (f Status)
data MigrateAuth
- = MigrateAuth ByteString
- | MigrateAuth2 ByteString ByteString
data MigrateOpts = MigrateOpts {
- migrateCopy :: Bool
- migrateReplace :: Bool
- migrateAuth :: Maybe MigrateAuth
}
defaultMigrateOpts :: MigrateOpts
migrateMultiple :: RedisCtx m f => ByteString -> ByteString -> Integer -> Integer -> MigrateOpts -> [ByteString] -> m (f Status)
restore :: RedisCtx m f => ByteString -> Integer -> ByteString -> m (f Status)
data RestoreOpts = RestoreOpts {
- restoreOptsReplace :: Bool
- restoreOptsAbsTTL :: Bool
- restoreOptsIdle :: Maybe Integer
- restoreOptsFreq :: Maybe Integer
}
restoreOpts :: RedisCtx m f => ByteString -> Integer -> ByteString -> RestoreOpts -> m (f Status)
restoreReplace :: RedisCtx m f => ByteString -> Integer -> ByteString -> m (f Status)
data CopyOpts = CopyOpts {
- copyDestinationDb :: Maybe Integer
- copyReplace :: Bool
}
defaultCopyOpts :: CopyOpts
copy :: RedisCtx m f => ByteString -> ByteString -> m (f Bool)
copyOpts :: RedisCtx m f => ByteString -> ByteString -> CopyOpts -> m (f Bool)
expiretime :: RedisCtx m f => ByteString -> m (f Integer)
pexpiretime :: RedisCtx m f => ByteString -> m (f Integer)
set :: RedisCtx m f => ByteString -> ByteString -> m (f Status)
data Condition
- = Nx
- | Xx
data SetOpts = SetOpts {
- setSeconds :: Maybe Integer
- setMilliseconds :: Maybe Integer
- setUnixSeconds :: Maybe Integer
- setUnixMilliseconds :: Maybe Integer
- setCondition :: Maybe Condition
- setKeepTTL :: Bool
}
defaultSetOpts :: SetOpts
internalSetOptsToArgs :: SetOpts -> [ByteString]
setOpts :: RedisCtx m f => ByteString -> ByteString -> SetOpts -> m (f Status)
setGet :: RedisCtx m f => ByteString -> ByteString -> m (f ByteString)
setGetOpts :: RedisCtx m f => ByteString -> ByteString -> SetOpts -> m (f ByteString)
msetex :: RedisCtx m f => NonEmpty (ByteString, ByteString) -> m (f Bool)
msetexOpts :: RedisCtx m f => NonEmpty (ByteString, ByteString) -> SetOpts -> m (f Bool)
data GetExOpts = GetExOpts {
- getExSeconds :: Maybe Integer
- getExMilliseconds :: Maybe Integer
- getExUnixSeconds :: Maybe Integer
- getExUnixMilliseconds :: Maybe Integer
- getExPersist :: Bool
}
defaultGetExOpts :: GetExOpts
getdel :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
data DelexCondition
- = DelexIfEq ByteString
- | DelexIfNe ByteString
- | DelexIfDigestEq ByteString
- | DelexIfDigestNe ByteString
delexConditionToArgs :: DelexCondition -> [ByteString]
delex :: RedisCtx m f => ByteString -> m (f Bool)
delexWhen :: RedisCtx m f => ByteString -> DelexCondition -> m (f Bool)
digest :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
getex :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
getexOpts :: RedisCtx m f => ByteString -> GetExOpts -> m (f (Maybe ByteString))
data HGetExOpts = HGetExOpts {
- hGetExSeconds :: Maybe Integer
- hGetExMilliseconds :: Maybe Integer
- hGetExUnixSeconds :: Maybe Integer
- hGetExUnixMilliseconds :: Maybe Integer
- hGetExPersist :: Bool
}
defaultHGetExOpts :: HGetExOpts
hgetex :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe ByteString])
hgetexOpts :: RedisCtx m f => ByteString -> NonEmpty ByteString -> HGetExOpts -> m (f [Maybe ByteString])
hgetdel :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe ByteString])
data HSetExCondition
- = HSetExFnx
- | HSetExFxx
data HSetExOpts = HSetExOpts {
- hSetExSeconds :: Maybe Integer
- hSetExMilliseconds :: Maybe Integer
- hSetExUnixSeconds :: Maybe Integer
- hSetExUnixMilliseconds :: Maybe Integer
- hSetExCondition :: Maybe HSetExCondition
- hSetExKeepTTL :: Bool
}
defaultHSetExOpts :: HSetExOpts
hsetex :: RedisCtx m f => ByteString -> NonEmpty (ByteString, ByteString) -> m (f Bool)
hsetexOpts :: RedisCtx m f => ByteString -> NonEmpty (ByteString, ByteString) -> HSetExOpts -> m (f Bool)
data HashFieldExpirationStatus
- = HashFieldExpirationNoSuchField
- | HashFieldExpirationConditionNotMet
- | HashFieldExpirationSet
- | HashFieldExpirationDeleted
data HashFieldExpirationInfo
- = HashFieldExpirationInfoNoSuchField
- | HashFieldExpirationInfoNoExpiration
- | HashFieldExpirationInfo Integer
hashFieldExpirationOptsToArgs :: ExpireOpts -> [ByteString]
hashFieldArgs :: NonEmpty ByteString -> [ByteString]
hexpire :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f [HashFieldExpirationStatus])
hexpireOpts :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> ExpireOpts -> m (f [HashFieldExpirationStatus])
hpexpire :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f [HashFieldExpirationStatus])
hpexpireOpts :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> ExpireOpts -> m (f [HashFieldExpirationStatus])
hexpireat :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f [HashFieldExpirationStatus])
hexpireatOpts :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> ExpireOpts -> m (f [HashFieldExpirationStatus])
hpexpireat :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f [HashFieldExpirationStatus])
hpexpireatOpts :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> ExpireOpts -> m (f [HashFieldExpirationStatus])
httl :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo])
hpttl :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo])
hexpiretime :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo])
hpexpiretime :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo])
data DebugMode
- = Yes
- | Sync
- | No
scriptDebug :: RedisCtx m f => DebugMode -> m (f Bool)
zadd :: RedisCtx m f => ByteString -> [(Double, ByteString)] -> m (f Integer)
data SizeCondition
- = CGT
- | CLT
data ZaddOpts = ZaddOpts {
- zaddCondition :: Maybe Condition
- zaddSizeCondition :: Maybe SizeCondition
- zaddChange :: Bool
- zaddIncrement :: Bool
}
defaultZaddOpts :: ZaddOpts
zaddOpts :: RedisCtx m f => ByteString -> [(Double, ByteString)] -> ZaddOpts -> m (f Integer)
data ReplyMode
- = On
- | Off
- | Skip
clientReply :: RedisCtx m f => ReplyMode -> m (f Bool)
clientUnpause :: RedisCtx m f => m (f Status)
clientNoTouch :: RedisCtx m f => Bool -> m (f Status)
data ClientSetInfoOpts
- = ClientSetInfoLibName ByteString
- | ClientSetInfoLibVer ByteString
clientSetinfo :: RedisCtx m f => ClientSetInfoOpts -> m (f Status)
srandmember :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
srandmemberN :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString])
spop :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
spopN :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString])
smismember :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Bool])
data SintercardOpts = SintercardOpts {
- sintercardLimit :: Maybe Integer
}
defaultSintercardOpts :: SintercardOpts
sintercard :: RedisCtx m f => NonEmpty ByteString -> m (f Integer)
sintercardOpts :: RedisCtx m f => NonEmpty ByteString -> SintercardOpts -> m (f Integer)
info :: RedisCtx m f => m (f ByteString)
infoSection :: RedisCtx m f => ByteString -> m (f ByteString)
exists :: RedisCtx m f => ByteString -> m (f Bool)
newtype Cursor = Cursor ByteString
cursor0 :: Cursor
scan :: RedisCtx m f => Cursor -> m (f (Cursor, [ByteString]))
data ScanOpts = ScanOpts {
- scanMatch :: Maybe ByteString
- scanCount :: Maybe Integer
}
defaultScanOpts :: ScanOpts
scanOpts :: RedisCtx m f => Cursor -> ScanOpts -> Maybe ByteString -> m (f (Cursor, [ByteString]))
addScanOpts :: [ByteString] -> ScanOpts -> [ByteString]
sscan :: RedisCtx m f => ByteString -> Cursor -> m (f (Cursor, [ByteString]))
sscanOpts :: RedisCtx m f => ByteString -> Cursor -> ScanOpts -> m (f (Cursor, [ByteString]))
hscan :: RedisCtx m f => ByteString -> Cursor -> m (f (Cursor, [(ByteString, ByteString)]))
hscanOpts :: RedisCtx m f => ByteString -> Cursor -> ScanOpts -> m (f (Cursor, [(ByteString, ByteString)]))
hrandfield :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
hrandfieldCount :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString])
hrandfieldCountWithValues :: RedisCtx m f => ByteString -> Integer -> m (f [(ByteString, ByteString)])
zscan :: RedisCtx m f => ByteString -> Cursor -> m (f (Cursor, [(ByteString, Double)]))
zscanOpts :: RedisCtx m f => ByteString -> Cursor -> ScanOpts -> m (f (Cursor, [(ByteString, Double)]))
data RangeLex a
- = Incl a
- | Excl a
- | Minr
- | Maxr
zrangebylex :: RedisCtx m f => ByteString -> RangeLex ByteString -> RangeLex ByteString -> m (f [ByteString])
zrangebylexLimit :: RedisCtx m f => ByteString -> RangeLex ByteString -> RangeLex ByteString -> Integer -> Integer -> m (f [ByteString])
data ZPopMinMax
- = ZPopMin
- | ZPopMax
data ZPopResponse = ZPopResponse {
- zPopResponseKey :: Maybe ByteString
- zPopResponseValues :: [(ByteString, Double)]
}
zmpop :: RedisCtx m f => NonEmpty ByteString -> ZPopMinMax -> m (f (Maybe ZPopResponse))
zmpopCount :: RedisCtx m f => NonEmpty ByteString -> ZPopMinMax -> Integer -> m (f (Maybe ZPopResponse))
bzmpop :: RedisCtx m f => Double -> NonEmpty ByteString -> ZPopMinMax -> m (f (Maybe ZPopResponse))
bzmpopCount :: RedisCtx m f => Double -> NonEmpty ByteString -> ZPopMinMax -> Integer -> m (f (Maybe ZPopResponse))
zmscore :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe Double])
zrandmember :: RedisCtx m f => ByteString -> m (f (Maybe ByteString))
zrandmemberN :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString])
zrandmemberWithscores :: RedisCtx m f => ByteString -> Integer -> m (f [(ByteString, Double)])
data ZRangeStoreRange
- = ZRangeStoreByIndex Integer Integer
- | ZRangeStoreByScore Double Double
- | ZRangeStoreByLex (RangeLex ByteString) (RangeLex ByteString)
data ZRangeStoreOpts = ZRangeStoreOpts {
- zRangeStoreRev :: Bool
- zRangeStoreLimit :: Maybe (Integer, Integer)
}
defaultZRangeStoreOpts :: ZRangeStoreOpts
zrangestore :: RedisCtx m f => ByteString -> ByteString -> Integer -> Integer -> m (f Integer)
zrangestoreOpts :: RedisCtx m f => ByteString -> ByteString -> ZRangeStoreRange -> ZRangeStoreOpts -> m (f Integer)
zRangeStoreRangeArgs :: ZRangeStoreRange -> [ByteString]
zRangeStoreOptsArgs :: ZRangeStoreOpts -> [ByteString]
data TrimStrategy
- = TrimMaxlen Integer
- | TrimMinId ByteString
data TrimType
- = TrimExact
- | TrimApprox (Maybe Integer)
data TrimOpts = TrimOpts {
- trimOptsStrategy :: TrimStrategy
- trimOptsType :: TrimType
}
internalTrimArgToList :: TrimOpts -> [ByteString]
trimOpts :: TrimStrategy -> TrimType -> TrimOpts
data XAddOpts = XAddOpts {
- xAddTrimOpts :: Maybe TrimOpts
- xAddnoMkStream :: Bool
}
defaultXAddOpts :: XAddOpts
xaddOpts :: RedisCtx m f => ByteString -> ByteString -> [(ByteString, ByteString)] -> XAddOpts -> m (f ByteString)
xadd :: RedisCtx m f => ByteString -> ByteString -> [(ByteString, ByteString)] -> m (f ByteString)
newtype XAutoclaimOpts = XAutoclaimOpts {
- xAutoclaimCount :: Maybe Integer
}
defaultXAutoclaimOpts :: XAutoclaimOpts
data XAutoclaimResult resultFormat = XAutoclaimResult {
- xAutoclaimResultId :: ByteString
- xAutoclaimClaimedMessages :: [resultFormat]
- xAutoclaimDeletedMessages :: [ByteString]
}
type XAutoclaimStreamsResult = XAutoclaimResult StreamsRecord
type XAutoclaimJustIdsResult = XAutoclaimResult ByteString
xautoclaim :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> ByteString -> m (f XAutoclaimStreamsResult)
xautoclaimOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> ByteString -> XAutoclaimOpts -> m (f XAutoclaimStreamsResult)
xautoclaimJustIds :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> ByteString -> m (f XAutoclaimJustIdsResult)
xautoclaimJustIdsOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> ByteString -> XAutoclaimOpts -> m (f XAutoclaimJustIdsResult)
data StreamsRecord = StreamsRecord {
- recordId :: ByteString
- keyValues :: [(ByteString, ByteString)]
}
data XReadOpts = XReadOpts {
- block :: Maybe Integer
- recordCount :: Maybe Integer
}
defaultXreadOpts :: XReadOpts
data XReadResponse = XReadResponse {
- stream :: ByteString
- records :: [StreamsRecord]
}
xreadOpts :: RedisCtx m f => [(ByteString, ByteString)] -> XReadOpts -> m (f (Maybe [XReadResponse]))
internalXreadArgs :: [(ByteString, ByteString)] -> XReadOpts -> [ByteString]
xread :: RedisCtx m f => [(ByteString, ByteString)] -> m (f (Maybe [XReadResponse]))
data XReadGroupOpts = XReadGroupOpts {
- xReadGroupBlock :: Maybe Integer
- xReadGroupCount :: Maybe Integer
- xReadGroupNoAck :: Bool
}
defaultXReadGroupOpts :: XReadGroupOpts
xreadGroupOpts :: RedisCtx m f => ByteString -> ByteString -> [(ByteString, ByteString)] -> XReadGroupOpts -> m (f (Maybe [XReadResponse]))
xreadGroup :: RedisCtx m f => ByteString -> ByteString -> [(ByteString, ByteString)] -> m (f (Maybe [XReadResponse]))
data XGroupCreateOpts = XGroupCreateOpts {
- xGroupCreateMkStream :: Bool
- xGroupCreateEntriesRead :: Maybe ByteString
}
defaultXGroupCreateOpts :: XGroupCreateOpts
xgroupCreate :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Status)
xgroupCreateOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> XGroupCreateOpts -> m (f Status)
xgroupCreateConsumer :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Bool)
xgroupSetId :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Status)
newtype XGroupSetIdOpts = XGroupSetIdOpts {
- xGroupSetIdEntriesRead :: Maybe ByteString
}
defaultXGroupSetIdOpts :: XGroupSetIdOpts
xgroupSetIdOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> XGroupSetIdOpts -> m (f Status)
xgroupDelConsumer :: RedisCtx m f => ByteString -> ByteString -> ByteString -> m (f Integer)
xgroupDestroy :: RedisCtx m f => ByteString -> ByteString -> m (f Bool)
data XRefPolicy
- = XRefPolicyKeepRef
- | XRefPolicyDelRef
- | XRefPolicyAcked
data XEntryDeletionOpts = XEntryDeletionOpts {
- xEntryDeletionRefPolicy :: XRefPolicy
}
defaultXEntryDeletionOpts :: XEntryDeletionOpts
data XCfgSetOpts = XCfgSetOpts {
- xCfgSetIdmpDuration :: Maybe Integer
- xCfgSetIdmpMaxsize :: Maybe Integer
}
defaultXCfgSetOpts :: XCfgSetOpts
data XNackMode
- = XNackSilent
- | XNackFail
- | XNackFatal
data XNackOpts = XNackOpts {
- xNackRetryCount :: Maybe Integer
- xNackForce :: Bool
}
defaultXNackOpts :: XNackOpts
data XEntryDeletionResult
- = XEntryDeletionResultNotFound
- | XEntryDeletionResultDeleted
- | XEntryDeletionResultNotDeleted
xEntryDeletionOptsToArgs :: XEntryDeletionOpts -> [ByteString]
xEntryIdsBlockArgs :: NonEmpty ByteString -> [ByteString]
xack :: RedisCtx m f => ByteString -> ByteString -> [ByteString] -> m (f Integer)
xackdel :: RedisCtx m f => ByteString -> ByteString -> NonEmpty ByteString -> m (f [XEntryDeletionResult])
xackdelOpts :: RedisCtx m f => ByteString -> ByteString -> NonEmpty ByteString -> XEntryDeletionOpts -> m (f [XEntryDeletionResult])
xrange :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Maybe Integer -> m (f [StreamsRecord])
xrevRange :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Maybe Integer -> m (f [StreamsRecord])
xlen :: RedisCtx m f => ByteString -> m (f Integer)
data XPendingSummaryResponse = XPendingSummaryResponse {
- numPendingMessages :: Integer
- smallestPendingMessageId :: ByteString
- largestPendingMessageId :: ByteString
- numPendingMessagesByconsumer :: [(ByteString, Integer)]
}
xpendingSummary :: RedisCtx m f => ByteString -> ByteString -> m (f XPendingSummaryResponse)
data XPendingDetailRecord = XPendingDetailRecord {
- messageId :: ByteString
- consumer :: ByteString
- millisSinceLastDelivered :: Integer
- numTimesDelivered :: Integer
}
data XPendingDetailOpts = XPendingDetailOpts {
- xPendingDetailConsumer :: Maybe ByteString
- xPendingDetailIdle :: Maybe Integer
}
defaultXPendingDetailOpts :: XPendingDetailOpts
xpendingDetail :: RedisCtx m f => ByteString -> ByteString -> ByteString -> ByteString -> Integer -> XPendingDetailOpts -> m (f [XPendingDetailRecord])
data XClaimOpts = XClaimOpts {
- xclaimIdle :: Maybe Integer
- xclaimTime :: Maybe Integer
- xclaimRetryCount :: Maybe Integer
- xclaimForce :: Bool
}
defaultXClaimOpts :: XClaimOpts
xclaimRequest :: ByteString -> ByteString -> ByteString -> Integer -> XClaimOpts -> [ByteString] -> [ByteString]
xclaim :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> XClaimOpts -> [ByteString] -> m (f [StreamsRecord])
xclaimJustIds :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Integer -> XClaimOpts -> [ByteString] -> m (f [ByteString])
data GeoUnit
- = GeoMeters
- | GeoKilometers
- | GeoFeet
- | GeoMiles
data GeoOrder
- = GeoAsc
- | GeoDesc
data GeoCoordinates = GeoCoordinates {
- geoLongitude :: Double
- geoLatitude :: Double
}
data GeoLocation = GeoLocation {
- geoLocationMember :: ByteString
- geoLocationDist :: Maybe Double
- geoLocationHash :: Maybe Integer
- geoLocationCoordinates :: Maybe GeoCoordinates
}
data GeoSearchFrom
- = GeoSearchFromMember ByteString
- | GeoSearchFromLonLat Double Double
data GeoSearchBy
- = GeoSearchByRadius Double GeoUnit
- | GeoSearchByBox Double Double GeoUnit
data GeoSearchOpts = GeoSearchOpts {
- geoSearchWithCoord :: Bool
- geoSearchWithDist :: Bool
- geoSearchWithHash :: Bool
- geoSearchCount :: Maybe Integer
- geoSearchCountAny :: Bool
- geoSearchOrder :: Maybe GeoOrder
}
defaultGeoSearchOpts :: GeoSearchOpts
data GeoSearchStoreOpts = GeoSearchStoreOpts {
- geoSearchStoreCount :: Maybe Integer
- geoSearchStoreCountAny :: Bool
- geoSearchStoreOrder :: Maybe GeoOrder
- geoSearchStoreStoredist :: Bool
}
defaultGeoSearchStoreOpts :: GeoSearchStoreOpts
data GeoAddOpts = GeoAddOpts {
- geoAddCondition :: Maybe Condition
- geoAddChange :: Bool
}
defaultGeoAddOpts :: GeoAddOpts
geoadd :: RedisCtx m f => ByteString -> [(Double, Double, ByteString)] -> m (f Integer)
geoaddOpts :: RedisCtx m f => ByteString -> [(Double, Double, ByteString)] -> GeoAddOpts -> m (f Integer)
geodist :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Maybe GeoUnit -> m (f (Maybe Double))
geopos :: RedisCtx m f => ByteString -> [ByteString] -> m (f [Maybe GeoCoordinates])
geoSearch :: RedisCtx m f => ByteString -> GeoSearchFrom -> GeoSearchBy -> GeoSearchOpts -> m (f [GeoLocation])
geoSearchStore :: RedisCtx m f => ByteString -> ByteString -> GeoSearchFrom -> GeoSearchBy -> GeoSearchStoreOpts -> m (f Integer)
geoSearchFromArgs :: GeoSearchFrom -> [ByteString]
geoSearchByArgs :: GeoSearchBy -> [ByteString]
geoSearchOptsArgs :: GeoSearchOpts -> [ByteString]
geoSearchStoreOptsArgs :: GeoSearchStoreOpts -> [ByteString]
data XInfoConsumersResponse = XInfoConsumersResponse {
- xinfoConsumerName :: ByteString
- xinfoConsumerNumPendingMessages :: Integer
- xinfoConsumerIdleTime :: Integer
- xinfoConsumerInactive :: Maybe Integer
}
xinfoConsumers :: RedisCtx m f => ByteString -> ByteString -> m (f [XInfoConsumersResponse])
data XInfoGroupsResponse = XInfoGroupsResponse {
- xinfoGroupsGroupName :: ByteString
- xinfoGroupsNumConsumers :: Integer
- xinfoGroupsNumPendingMessages :: Integer
- xinfoGroupsLastDeliveredMessageId :: ByteString
- xinfoGroupsEntriesRead :: Maybe Integer
- xinfoGroupsLag :: Maybe Integer
}
xinfoGroups :: RedisCtx m f => ByteString -> m (f [XInfoGroupsResponse])
data XInfoStreamResponse
- = XInfoStreamResponse {
  }
- | XInfoStreamEmptyResponse {
  }
xinfoStream :: RedisCtx m f => ByteString -> m (f XInfoStreamResponse)
xdel :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f Integer)
xdelex :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [XEntryDeletionResult])
xdelexOpts :: RedisCtx m f => ByteString -> NonEmpty ByteString -> XEntryDeletionOpts -> m (f [XEntryDeletionResult])
xcfgset :: RedisCtx m f => ByteString -> XCfgSetOpts -> m (f Status)
xidmprecord :: RedisCtx m f => ByteString -> ByteString -> ByteString -> ByteString -> m (f Status)
xnack :: RedisCtx m f => ByteString -> ByteString -> XNackMode -> NonEmpty ByteString -> m (f Integer)
xnackOpts :: RedisCtx m f => ByteString -> ByteString -> XNackMode -> NonEmpty ByteString -> XNackOpts -> m (f Integer)
xtrim :: RedisCtx m f => ByteString -> TrimOpts -> m (f Integer)
inf :: RealFloat a => a
data AuthOpts = AuthOpts {
- authOptsUsername :: Maybe ByteString
}
defaultAuthOpts :: AuthOpts
auth :: RedisCtx m f => ByteString -> m (f Status)
authOpts :: RedisCtx m f => ByteString -> AuthOpts -> m (f Status)
select :: RedisCtx m f => Integer -> m (f Status)
ping :: RedisCtx m f => m (f Status)
data ClusterInfoResponse = ClusterInfoResponse {
- clusterInfoResponseState :: ClusterInfoResponseState
- clusterInfoResponseSlotsAssigned :: Integer
- clusterInfoResponseSlotsOK :: Integer
- clusterInfoResponseSlotsPfail :: Integer
- clusterInfoResponseSlotsFail :: Integer
- clusterInfoResponseKnownNodes :: Integer
- clusterInfoResponseSize :: Integer
- clusterInfoResponseCurrentEpoch :: Integer
- clusterInfoResponseMyEpoch :: Integer
- clusterInfoResponseStatsMessagesSent :: Integer
- clusterInfoResponseStatsMessagesReceived :: Integer
- clusterInfoResponseTotalLinksBufferLimitExceeded :: Integer
- clusterInfoResponseStatsMessagesPingSent :: Maybe Integer
- clusterInfoResponseStatsMessagesPingReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesPongSent :: Maybe Integer
- clusterInfoResponseStatsMessagesPongReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesMeetSent :: Maybe Integer
- clusterInfoResponseStatsMessagesMeetReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesFailSent :: Maybe Integer
- clusterInfoResponseStatsMessagesFailReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesPublishSent :: Maybe Integer
- clusterInfoResponseStatsMessagesPublishReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesAuthReqSent :: Maybe Integer
- clusterInfoResponseStatsMessagesAuthReqReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesAuthAckSent :: Maybe Integer
- clusterInfoResponseStatsMessagesAuthAckReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesUpdateSent :: Maybe Integer
- clusterInfoResponseStatsMessagesUpdateReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesMfstartSent :: Maybe Integer
- clusterInfoResponseStatsMessagesMfstartReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesModuleSent :: Maybe Integer
- clusterInfoResponseStatsMessagesModuleReceived :: Maybe Integer
- clusterInfoResponseStatsMessagesPublishshardSent :: Maybe Integer
- clusterInfoResponseStatsMessagesPublishshardReceived :: Maybe Integer
}
data ClusterInfoResponseState
- = OK
- | Down
defClusterInfoResponse :: ClusterInfoResponse
parseClusterInfoResponse :: [[ByteString]] -> ClusterInfoResponse -> Maybe ClusterInfoResponse
clusterInfo :: RedisCtx m f => m (f ClusterInfoResponse)
clusterMyshardid :: RedisCtx m f => m (f ByteString)
data ClusterNodesResponse = ClusterNodesResponse {
- clusterNodesResponseEntries :: [ClusterNodesResponseEntry]
}
data ClusterNodesResponseEntry = ClusterNodesResponseEntry {
- clusterNodesResponseNodeId :: ByteString
- clusterNodesResponseNodeIp :: ByteString
- clusterNodesResponseNodePort :: Integer
- clusterNodesResponseNodeFlags :: [ByteString]
- clusterNodesResponseMasterId :: Maybe ByteString
- clusterNodesResponsePingSent :: Integer
- clusterNodesResponsePongReceived :: Integer
- clusterNodesResponseConfigEpoch :: Integer
- clusterNodesResponseLinkState :: ByteString
- clusterNodesResponseSlots :: [ClusterNodesResponseSlotSpec]
}
data ClusterNodesResponseSlotSpec
- = ClusterNodesResponseSingleSlot Integer
- | ClusterNodesResponseSlotRange Integer Integer
- | ClusterNodesResponseSlotImporting Integer ByteString
- | ClusterNodesResponseSlotMigrating Integer ByteString
clusterNodes :: RedisCtx m f => m (f ClusterNodesResponse)
data ClusterSlotsResponse = ClusterSlotsResponse {
- clusterSlotsResponseEntries :: [ClusterSlotsResponseEntry]
}
data ClusterSlotsNode = ClusterSlotsNode {
- clusterSlotsNodeIP :: ByteString
- clusterSlotsNodePort :: Int
- clusterSlotsNodeID :: ByteString
}
data ClusterSlotsResponseEntry = ClusterSlotsResponseEntry {
- clusterSlotsResponseEntryStartSlot :: Int
- clusterSlotsResponseEntryEndSlot :: Int
- clusterSlotsResponseEntryMaster :: ClusterSlotsNode
- clusterSlotsResponseEntryReplicas :: [ClusterSlotsNode]
}
clusterSlots :: RedisCtx m f => m (f ClusterSlotsResponse)
data ClusterSlotStatsMetric
- = ClusterSlotStatsKeyCount
- | ClusterSlotStatsCpuUsec
- | ClusterSlotStatsMemoryBytes
- | ClusterSlotStatsNetworkBytesIn
- | ClusterSlotStatsNetworkBytesOut
data ClusterSlotStatsOrderByOpts = ClusterSlotStatsOrderByOpts {
- clusterSlotStatsOrderByLimit :: Maybe Integer
- clusterSlotStatsOrderByDirection :: SortOrder
}
defaultClusterSlotStatsOrderByOpts :: ClusterSlotStatsOrderByOpts
data ClusterSlotStatsQuery
- = ClusterSlotStatsSlotsRange Integer Integer
- | ClusterSlotStatsOrderBy ClusterSlotStatsMetric ClusterSlotStatsOrderByOpts
data ClusterSlotStatsResponse = ClusterSlotStatsResponse {
- clusterSlotStatsResponseEntries :: [ClusterSlotStatsResponseEntry]
}
data ClusterSlotStatsResponseEntry = ClusterSlotStatsResponseEntry {
- clusterSlotStatsResponseEntrySlot :: Integer
- clusterSlotStatsResponseEntryKeyCount :: Maybe Integer
- clusterSlotStatsResponseEntryCpuUsec :: Maybe Integer
- clusterSlotStatsResponseEntryMemoryBytes :: Maybe Integer
- clusterSlotStatsResponseEntryNetworkBytesIn :: Maybe Integer
- clusterSlotStatsResponseEntryNetworkBytesOut :: Maybe Integer
}
clusterSlotStats :: RedisCtx m f => ClusterSlotStatsQuery -> m (f ClusterSlotStatsResponse)
clusterSlotStatsSlotsRange :: RedisCtx m f => Integer -> Integer -> m (f ClusterSlotStatsResponse)
clusterSlotStatsOrderBy :: RedisCtx m f => ClusterSlotStatsMetric -> m (f ClusterSlotStatsResponse)
clusterSlotStatsOrderByOpts :: RedisCtx m f => ClusterSlotStatsMetric -> ClusterSlotStatsOrderByOpts -> m (f ClusterSlotStatsResponse)
clusterSlotStatsQueryArgs :: ClusterSlotStatsQuery -> [ByteString]
clusterSetSlotImporting :: RedisCtx m f => Integer -> ByteString -> m (f Status)
clusterSetSlotMigrating :: RedisCtx m f => Integer -> ByteString -> m (f Status)
clusterSetSlotStable :: RedisCtx m f => Integer -> m (f Status)
clusterSetSlotNode :: RedisCtx m f => Integer -> ByteString -> m (f Status)
clusterGetKeysInSlot :: RedisCtx m f => Integer -> Integer -> m (f [ByteString])
data ClusterMigrationSlotRange = ClusterMigrationSlotRange {
- clusterMigrationSlotRangeStart :: Integer
- clusterMigrationSlotRangeEnd :: Integer
}
data ClusterMigrationTask = ClusterMigrationTask {
- clusterMigrationTaskId :: ByteString
- clusterMigrationTaskSlots :: [ClusterMigrationSlotRange]
- clusterMigrationTaskSource :: Maybe ByteString
- clusterMigrationTaskDest :: Maybe ByteString
- clusterMigrationTaskOperation :: Maybe ByteString
- clusterMigrationTaskState :: Maybe ByteString
- clusterMigrationTaskLastError :: Maybe ByteString
- clusterMigrationTaskRetries :: Maybe Integer
- clusterMigrationTaskCreateTime :: Maybe Integer
- clusterMigrationTaskStartTime :: Maybe Integer
- clusterMigrationTaskEndTime :: Maybe Integer
- clusterMigrationTaskWritePauseMs :: Maybe Integer
}
newtype ClusterMigrationStatusResponse = ClusterMigrationStatusResponse {
- clusterMigrationStatusTasks :: [ClusterMigrationTask]
}
clusterMigrationImport :: RedisCtx m f => NonEmpty (Integer, Integer) -> m (f ByteString)
clusterMigrationCancelId :: RedisCtx m f => ByteString -> m (f Integer)
clusterMigrationCancelAll :: RedisCtx m f => m (f Integer)
clusterMigrationStatus :: RedisCtx m f => m (f ClusterMigrationStatusResponse)
clusterMigrationStatusAll :: RedisCtx m f => m (f ClusterMigrationStatusResponse)
clusterMigrationStatusId :: RedisCtx m f => ByteString -> m (f ClusterMigrationStatusResponse)
command :: RedisCtx m f => m (f [CommandInfo])
commandList :: RedisCtx m f => m (f [ByteString])
data CommandListFilter
- = CommandListFilterByModule ByteString
- | CommandListFilterByAclCat ByteString
- | CommandListFilterByPattern ByteString
commandListOpts :: RedisCtx m f => Maybe CommandListFilter -> m (f [ByteString])
data IncrexExpiration
- = IncrexSeconds Integer
- | IncrexMilliseconds Integer
- | IncrexUnixSeconds Integer
- | IncrexUnixMilliseconds Integer
- | IncrexPersist
data IncrexOpts a = IncrexOpts {
- increxLowerBound :: Maybe a
- increxUpperBound :: Maybe a
- increxSaturate :: Bool
- increxExpiration :: Maybe IncrexExpiration
- increxExpirationIfNotExists :: Bool
}
defaultIncrexOpts :: IncrexOpts a
increx :: RedisCtx m f => ByteString -> m (f (Integer, Integer))
increxOpts :: RedisCtx m f => ByteString -> IncrexOpts Integer -> m (f (Integer, Integer))
increxBy :: RedisCtx m f => ByteString -> Integer -> IncrexOpts Integer -> m (f (Integer, Integer))
increxByFloat :: RedisCtx m f => ByteString -> Double -> IncrexOpts Double -> m (f (Double, Double))
increxCommonArgs :: RedisArg a => IncrexOpts a -> [ByteString]
data ARGrepPredicate
- = ARGrepExact ByteString
- | ARGrepMatch ByteString
- | ARGrepGlob ByteString
- | ARGrepRegex ByteString
data ARGrepCombine
- = ARGrepAnd
- | ARGrepOr
data ARGrepOpts = ARGrepOpts {
- arGrepCombine :: Maybe ARGrepCombine
- arGrepLimit :: Maybe Integer
- arGrepNoCase :: Bool
}
defaultARGrepOpts :: ARGrepOpts
data ARLastItemsOpts = ARLastItemsOpts {
- arLastItemsReverse :: Bool
}
defaultARLastItemsOpts :: ARLastItemsOpts
data ARScanOpts = ARScanOpts {
- arScanLimit :: Maybe Integer
}
defaultARScanOpts :: ARScanOpts
newtype ARIndexValuePairsResponse = ARIndexValuePairsResponse {
- arIndexValuePairs :: [(Integer, ByteString)]
}
data ARInfoResponse = ARInfoResponse {
- arInfoCount :: Integer
- arInfoLength :: Integer
- arInfoNextInsertIndex :: Integer
- arInfoSlices :: Integer
- arInfoDirectorySize :: Integer
- arInfoSuperDirEntries :: Integer
- arInfoSliceSize :: Integer
- arInfoDenseSlices :: Maybe Integer
- arInfoSparseSlices :: Maybe Integer
- arInfoAvgDenseSize :: Maybe Double
- arInfoAvgDenseFill :: Maybe Double
- arInfoAvgSparseSize :: Maybe Double
}
data AROpValue
- = AROpSum
- | AROpMin
- | AROpMax
data AROpCount
- = AROpAnd
- | AROpOr
- | AROpXor
- | AROpMatch ByteString
- | AROpUsed
argrepPredicateArgs :: ARGrepPredicate -> [ByteString]
argrepOptsArgs :: ARGrepOpts -> [ByteString]
aropValueArg :: AROpValue -> ByteString
aropCountArgs :: AROpCount -> [ByteString]
arcount :: RedisCtx m f => ByteString -> m (f Integer)
ardel :: RedisCtx m f => ByteString -> NonEmpty Integer -> m (f Integer)
argetrange :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f [Maybe ByteString])
argrep :: RedisCtx m f => ByteString -> ByteString -> ByteString -> NonEmpty ARGrepPredicate -> m (f [Integer])
argrepOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> NonEmpty ARGrepPredicate -> ARGrepOpts -> m (f [Integer])
argrepWithValues :: RedisCtx m f => ByteString -> ByteString -> ByteString -> NonEmpty ARGrepPredicate -> m (f ARIndexValuePairsResponse)
argrepWithValuesOpts :: RedisCtx m f => ByteString -> ByteString -> ByteString -> NonEmpty ARGrepPredicate -> ARGrepOpts -> m (f ARIndexValuePairsResponse)
arinfo :: RedisCtx m f => ByteString -> m (f ARInfoResponse)
arinfoFull :: RedisCtx m f => ByteString -> m (f ARInfoResponse)
arinsert :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f Integer)
arlastitems :: RedisCtx m f => ByteString -> Integer -> m (f [Maybe ByteString])
arlastitemsOpts :: RedisCtx m f => ByteString -> Integer -> ARLastItemsOpts -> m (f [Maybe ByteString])
arlen :: RedisCtx m f => ByteString -> m (f Integer)
armget :: RedisCtx m f => ByteString -> NonEmpty Integer -> m (f [Maybe ByteString])
arnext :: RedisCtx m f => ByteString -> m (f (Maybe Integer))
aropValue :: RedisCtx m f => ByteString -> Integer -> Integer -> AROpValue -> m (f (Maybe ByteString))
aropCount :: RedisCtx m f => ByteString -> Integer -> Integer -> AROpCount -> m (f (Maybe Integer))
arring :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f Integer)
arscan :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f ARIndexValuePairsResponse)
arscanOpts :: RedisCtx m f => ByteString -> Integer -> Integer -> ARScanOpts -> m (f ARIndexValuePairsResponse)
arseek :: RedisCtx m f => ByteString -> Integer -> m (f Bool)
arset :: RedisCtx m f => ByteString -> Integer -> NonEmpty ByteString -> m (f Integer)
data HotkeysMetric
- = HotkeysMetricCPU
- | HotkeysMetricNET
data HotkeysStartOpts = HotkeysStartOpts {
- hotkeysStartTopKCount :: Maybe Integer
- hotkeysStartDurationSeconds :: Maybe Integer
- hotkeysStartSampleRatio :: Maybe Integer
- hotkeysStartSlots :: Maybe (NonEmpty Integer)
}
defaultHotkeysStartOpts :: HotkeysStartOpts
data HotkeysSlotRange = HotkeysSlotRange {
- hotkeysSlotRangeStart :: Integer
- hotkeysSlotRangeEnd :: Integer
}
data HotkeysGetResponse = HotkeysGetResponse {
- hotkeysGetTrackingActive :: Bool
- hotkeysGetSampleRatio :: Integer
- hotkeysGetSelectedSlots :: [HotkeysSlotRange]
- hotkeysGetAllCommandsAllSlotsUs :: Integer
- hotkeysGetNetBytesAllCommandsAllSlots :: Integer
- hotkeysGetCollectionStartTimeUnixMs :: Integer
- hotkeysGetCollectionDurationMs :: Integer
- hotkeysGetTotalCpuTimeUserMs :: Maybe Integer
- hotkeysGetTotalCpuTimeSysMs :: Maybe Integer
- hotkeysGetTotalNetBytes :: Maybe Integer
- hotkeysGetByCpuTimeUs :: Maybe [(ByteString, Integer)]
- hotkeysGetByNetBytes :: Maybe [(ByteString, Integer)]
- hotkeysGetSampledCommandsSelectedSlotsUs :: Maybe Integer
- hotkeysGetAllCommandsSelectedSlotsUs :: Maybe Integer
- hotkeysGetNetBytesSampledCommandsSelectedSlots :: Maybe Integer
- hotkeysGetNetBytesAllCommandsSelectedSlots :: Maybe Integer
}
hotkeysStart :: RedisCtx m f => NonEmpty HotkeysMetric -> m (f Status)
hotkeysStartOpts :: RedisCtx m f => NonEmpty HotkeysMetric -> HotkeysStartOpts -> m (f Status)
hotkeysGet :: RedisCtx m f => m (f HotkeysGetResponse)
hotkeysStop :: RedisCtx m f => m (f Status)
hotkeysReset :: RedisCtx m f => m (f Status)
data ExpireOpts
- = ExpireOptsTime Condition
- | ExpireOptsValue SizeCondition
pexpireatOpts :: RedisCtx m f => ByteString -> Integer -> ExpireOpts -> m (f Bool)
expireOpts :: RedisCtx m f => ByteString -> Integer -> ExpireOpts -> m (f Bool)
expireatOpts :: RedisCtx m f => ByteString -> Integer -> ExpireOpts -> m (f Bool)
data FlushOpts
- = FlushOptsSync
- | FlushOptsAsync
flushdbOpts :: RedisCtx m f => FlushOpts -> m (f Status)
flushallOpts :: RedisCtx m f => FlushOpts -> m (f Status)
data BitposType
- = Byte
- | Bit
data BitposOpts
- = BitposOptsStart Integer
- | BitposOptsStartEnd Integer Integer (Maybe BitposType)
bitposOpts :: RedisCtx m f => ByteString -> Integer -> BitposOpts -> m (f Integer)
substr :: RedisCtx m f => ByteString -> Integer -> Integer -> m (f ByteString)

Documentation

objectRefcount Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f Integer)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

objectIdletime Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f Integer)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

objectEncoding Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f ByteString)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

linsertBefore Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	pivot
-> ByteString	value
-> m (f Integer)

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter. Since Redis 2.2.0

linsertAfter Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	pivot
-> ByteString	value
-> m (f Integer)

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter. Since Redis 2.2.0

data ListDirection Source #

Constructors

ListLeft
ListRight

Instances

Instances details

Show ListDirection Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ListDirection -> ShowS # show :: ListDirection -> String # showList :: [ListDirection] -> ShowS #
Eq ListDirection Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ListDirection -> ListDirection -> Bool # (/=) :: ListDirection -> ListDirection -> Bool #
RedisArg ListDirection Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: ListDirection -> ByteString Source #

data LPosOpts Source #

Constructors

LPosOpts
Fields lposRank :: Maybe Integer lposMaxlen :: Maybe Integer

Instances

Instances details

Show LPosOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> LPosOpts -> ShowS # show :: LPosOpts -> String # showList :: [LPosOpts] -> ShowS #
Eq LPosOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: LPosOpts -> LPosOpts -> Bool # (/=) :: LPosOpts -> LPosOpts -> Bool #

defaultLPosOpts :: LPosOpts Source #

lpos :: RedisCtx m f => ByteString -> ByteString -> m (f (Maybe Integer)) Source #

Returns the index of the first matching element in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

lposOpts :: RedisCtx m f => ByteString -> ByteString -> LPosOpts -> m (f (Maybe Integer)) Source #

Returns the index of the first matching element in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

lposCount :: RedisCtx m f => ByteString -> ByteString -> Integer -> m (f [Integer]) Source #

Returns the indexes of matching elements in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

lposCountOpts :: RedisCtx m f => ByteString -> ByteString -> Integer -> LPosOpts -> m (f [Integer]) Source #

Returns the indexes of matching elements in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

lposOptsToArgs :: LPosOpts -> [ByteString] Source #

lposOptsParts :: LPosOpts -> ([ByteString], [ByteString]) Source #

lmove Source #

Arguments

:: RedisCtx m f
=> ByteString	Source
-> ByteString	Destination
-> ListDirection	Direction where to get the element from in the source list
-> ListDirection	Direction where to push the element to in the destination list
-> m (f (Maybe ByteString))

Move an element after taking it from one list and pushing it to another (https://redis.io/commands/lmove).

In clustered environments source and destination keys must be in the same hash slot, which can be ensured by using hash tags (e.g. {tag}source and {tag}destination). O(1)

Since Redis 6.2.0

blmove Source #

Arguments

:: RedisCtx m f
=> ByteString	Source
-> ByteString	Destination
-> ListDirection	Direction where to get the element from in the source list
-> ListDirection	Direction where to push the element to in the destination list
-> Integer
-> m (f (Maybe ByteString))

Move an element after taking it from one list and pushing it to another, or blocks until one is available (https://redis.io/commands/blmove).

In clustered environments source and destination keys must be in the same hash slot, which can be ensured by using hash tags (e.g. {tag}source and {tag}destination).

O(1)

Since Redis 6.2.0

lmpop :: RedisCtx m f => NonEmpty ByteString -> ListDirection -> m (f (Maybe (ByteString, [ByteString]))) Source #

Pops one or more elements from the first non-empty list from a list of keys (https://redis.io/commands/lmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

lmpopCount :: RedisCtx m f => NonEmpty ByteString -> ListDirection -> Integer -> m (f (Maybe (ByteString, [ByteString]))) Source #

Pops one or more elements from the first non-empty list from a list of keys (https://redis.io/commands/lmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

blmpop :: RedisCtx m f => Double -> NonEmpty ByteString -> ListDirection -> m (f (Maybe (ByteString, [ByteString]))) Source #

Pops one or more elements from the first non-empty list from a list of keys, or blocks until one is available (https://redis.io/commands/blmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

blmpopCount :: RedisCtx m f => Double -> NonEmpty ByteString -> ListDirection -> Integer -> m (f (Maybe (ByteString, [ByteString]))) Source #

Pops one or more elements from the first non-empty list from a list of keys, or blocks until one is available (https://redis.io/commands/blmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

getType Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f RedisType)

Determine the type stored at key (http://redis.io/commands/type). Since Redis 1.0.0

data Slowlog Source #

A single entry from the slowlog.

Constructors

Slowlog

Fields

slowlogId :: Integer
A unique progressive identifier for every slow log entry.
slowlogTimestamp :: Integer
The unix timestamp at which the logged command was processed.
slowlogMicros :: Integer
The amount of time needed for its execution, in microseconds.
slowlogCmd :: [ByteString]
The command and it's arguments.
slowlogClientIpAndPort :: Maybe ByteString
slowlogClientName :: Maybe ByteString

Instances

Instances details

Show Slowlog Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> Slowlog -> ShowS # show :: Slowlog -> String # showList :: [Slowlog] -> ShowS #
Eq Slowlog Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: Slowlog -> Slowlog -> Bool # (/=) :: Slowlog -> Slowlog -> Bool #
RedisResult Slowlog Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply Slowlog Source #

slowlogGet Source #

Arguments

:: RedisCtx m f
=> Integer	cnt
-> m (f [Slowlog])

slowlogLen :: RedisCtx m f => m (f Integer) Source #

slowlogReset :: RedisCtx m f => m (f Status) Source #

zrange Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	stop
-> m (f [ByteString])

Return a range of members in a sorted set, by index (http://redis.io/commands/zrange). The Redis command ZRANGE is split up into zrange, zrangeWithscores. Since Redis 1.2.0

zrangeWithscores Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	stop
-> m (f [(ByteString, Double)])

Return a range of members in a sorted set, by index (http://redis.io/commands/zrange). The Redis command ZRANGE is split up into zrange, zrangeWithscores. Since Redis 1.2.0

zrevrange Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	stop
-> m (f [ByteString])

zrevrangeWithscores Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	stop
-> m (f [(ByteString, Double)])

zrangebyscore Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	min
-> Double	max
-> m (f [ByteString])

zrangebyscoreWithscores Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	min
-> Double	max
-> m (f [(ByteString, Double)])

zrangebyscoreLimit Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	min
-> Double	max
-> Integer	offset
-> Integer	count
-> m (f [ByteString])

zrangebyscoreWithscoresLimit Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	min
-> Double	max
-> Integer	offset
-> Integer	count
-> m (f [(ByteString, Double)])

zrevrangebyscore Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	max
-> Double	min
-> m (f [ByteString])

zrevrangebyscoreWithscores Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	max
-> Double	min
-> m (f [(ByteString, Double)])

zrevrangebyscoreLimit Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	max
-> Double	min
-> Integer	offset
-> Integer	count
-> m (f [ByteString])

zrevrangebyscoreWithscoresLimit Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Double	max
-> Double	min
-> Integer	offset
-> Integer	count
-> m (f [(ByteString, Double)])

data SortOpts Source #

Options for the sort command.

Constructors

SortOpts
Fields sortBy :: Maybe ByteString sortLimit :: (Integer, Integer) sortGet :: [ByteString] sortOrder :: SortOrder sortAlpha :: Bool

Instances

Instances details

Show SortOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> SortOpts -> ShowS # show :: SortOpts -> String # showList :: [SortOpts] -> ShowS #
Eq SortOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: SortOpts -> SortOpts -> Bool # (/=) :: SortOpts -> SortOpts -> Bool #

defaultSortOpts :: SortOpts Source #

Redis default SortOpts. Equivalent to omitting all optional parameters.

SortOpts
    { sortBy    = Nothing -- omit the BY option
    , sortLimit = (0,-1)  -- return entire collection
    , sortGet   = []      -- omit the GET option
    , sortOrder = Asc     -- sort in ascending order
    , sortAlpha = False   -- sort numerically, not lexicographically
    }

data SortOrder Source #

Constructors

Asc
Desc

Instances

Instances details

Show SortOrder Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> SortOrder -> ShowS # show :: SortOrder -> String # showList :: [SortOrder] -> ShowS #
Eq SortOrder Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: SortOrder -> SortOrder -> Bool # (/=) :: SortOrder -> SortOrder -> Bool #

sortStore Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	destination
-> SortOpts
-> m (f Integer)

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore. Since Redis 1.0.0

sort Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> SortOpts
-> m (f [ByteString])

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore. Since Redis 1.0.0

sortInternal Source #

Arguments

:: (RedisResult a, RedisCtx m f)
=> ByteString	key
-> Maybe ByteString	destination
-> SortOpts
-> m (f a)

data Aggregate Source #

Constructors

Sum
Min
Max

Instances

Instances details

Show Aggregate Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> Aggregate -> ShowS # show :: Aggregate -> String # showList :: [Aggregate] -> ShowS #
Eq Aggregate Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: Aggregate -> Aggregate -> Bool # (/=) :: Aggregate -> Aggregate -> Bool #

zunionstore Source #

Arguments

:: RedisCtx m f
=> ByteString	destination
-> [ByteString]	keys
-> Aggregate
-> m (f Integer)

zunionstoreWeights Source #

Arguments

:: RedisCtx m f
=> ByteString	destination
-> [(ByteString, Double)]	weighted keys
-> Aggregate
-> m (f Integer)

zinterstore Source #

Arguments

:: RedisCtx m f
=> ByteString	destination
-> NonEmpty ByteString	keys
-> Aggregate
-> m (f Integer)

Intersect multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zinterstore). The Redis command ZINTERSTORE is split up into zinterstore, zinterstoreWeights. Since Redis 2.0.0

zinterstoreWeights Source #

Arguments

:: RedisCtx m f
=> ByteString	destination
-> NonEmpty (ByteString, Double)	weighted keys
-> Aggregate
-> m (f Integer)

Intersect multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zinterstore). The Redis command ZINTERSTORE is split up into zinterstore, zinterstoreWeights. Since Redis 2.0.0

zstoreInternal Source #

Arguments

:: RedisCtx m f
=> ByteString	cmd
-> ByteString	destination
-> [ByteString]	keys
-> [Double]	weights
-> Aggregate
-> m (f Integer)

zdiff :: RedisCtx m f => NonEmpty ByteString -> m (f [ByteString]) Source #

Returns the difference between multiple sorted sets (https://redis.io/commands/zdiff).

O(L + (N - K)log(N)) worst case where $L$ is the total number of elements in all the sorted sets, N is the size of the first sorted set, and K is the size of the result set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

zdiffWithscores Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> m (f [(ByteString, Double)])

Returns the difference between multiple sorted sets with scores (https://redis.io/commands/zdiff).

O(L + (N - K)log(N)) worst case where $L$ is the total number of elements in all the sorted sets, N is the size of the first sorted set, and K is the size of the result set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

zdiffstore Source #

Arguments

:: RedisCtx m f
=> ByteString	Destination key.
-> NonEmpty ByteString	Sorted set keys.
-> m (f Integer)

Stores the difference of multiple sorted sets in a key (https://redis.io/commands/zdiffstore).

O(L + (N - K)log(N)) worst case where $L$ is the total number of elements in all the sorted sets, N is the size of the first sorted set, and K is the size of the result set.

In clustered environment, commands must operate on keys within the same hash slot.

Keys that do not exist are considered to be empty sets.

If destination already exists, it is overwritten.

Since Redis 6.2.0

zinter Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> m (f [ByteString])

Returns the intersection of multiple sorted sets (https://redis.io/commands/zinter).

O(NK) + O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

data ZAggregateOpts Source #

Constructors

ZAggregateOpts

Fields

zAggregateWeights :: [Double]
WEIGHTS option, it is possible to specify a multiplication factor for each input sorted set. Each element's score is multiplied by its corresponding weight before aggregation. When WEIGHTS is not given, the multiplication factors default to 1.
zAggregateAggregate :: Aggregate
AGGREGATE option, it is possible to specify how the results of the union are aggregated

Instances

Instances details

Show ZAggregateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZAggregateOpts -> ShowS # show :: ZAggregateOpts -> String # showList :: [ZAggregateOpts] -> ShowS #
Eq ZAggregateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZAggregateOpts -> ZAggregateOpts -> Bool # (/=) :: ZAggregateOpts -> ZAggregateOpts -> Bool #

defaultZAggregateOpts :: ZAggregateOpts Source #

zinterWithscores Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> m (f [(ByteString, Double)])

Returns the intersection of multiple sorted sets with scores (https://redis.io/commands/zinter).

O(NK) + O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

zinterOpts Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> ZAggregateOpts
-> m (f [ByteString])

Returns the intersection of multiple sorted sets (https://redis.io/commands/zinter).

O(NK) + O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

zinterWithscoresOpts Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> ZAggregateOpts
-> m (f [(ByteString, Double)])

Returns the intersection of multiple sorted sets with scores (https://redis.io/commands/zinter).

O(NK) + O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 6.2.0

zunion Source #

Arguments

:: RedisCtx m f
=> NonEmpty ByteString	Sorted set keys.
-> m (f [ByteString])

Returns the union of multiple sorted sets (https://redis.io/commands/zunion).

O(N) + O(Mlog(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.

Since Redis 6.2.0

zunionWithscores :: RedisCtx m f => NonEmpty ByteString -> m (f [(ByteString, Double)]) Source #

Returns the union of multiple sorted sets with scores (https://redis.io/commands/zunion).

O(N) + O(Mlog(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.

Since Redis 6.2.0

zunionOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [ByteString]) Source #

Returns the union of multiple sorted sets (https://redis.io/commands/zunion).

O(N) + O(Mlog(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.

Since Redis 6.2.0

zunionWithscoresOpts :: RedisCtx m f => NonEmpty ByteString -> ZAggregateOpts -> m (f [(ByteString, Double)]) Source #

Returns the union of multiple sorted sets with scores (https://redis.io/commands/zunion).

O(N) + O(Mlog(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.

Since Redis 6.2.0

zAggregateKeysArgs :: ByteString -> NonEmpty ByteString -> [ByteString] Source #

zAggregateInternalArgs :: ByteString -> NonEmpty ByteString -> ZAggregateOpts -> Bool -> [ByteString] Source #

eval Source #

Arguments

:: (RedisCtx m f, RedisResult a)
=> ByteString	script
-> [ByteString]	keys
-> [ByteString]	args
-> m (f a)

Execute a Lua script server side (http://redis.io/commands/eval). Since Redis 2.6.0

evalsha Source #

Arguments

:: (RedisCtx m f, RedisResult a)
=> ByteString	base16-encoded sha1 hash of the script
-> [ByteString]	keys
-> [ByteString]	args
-> m (f a)

Works like eval, but sends the SHA1 hash of the script instead of the script itself. Fails if the server does not recognise the hash, in which case, eval should be used instead.

fcall :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a) Source #

Invokes a function (https://redis.io/commands/fcall).

Complexity depends on the function that is executed.

Since Redis 7.0.0

fcallReadonly :: (RedisCtx m f, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m (f a) Source #

Invokes a read-only function (https://redis.io/commands/fcall_ro).

Complexity depends on the function that is executed.

Since Redis 7.0.0

data FunctionListOpts Source #

Constructors

FunctionListOpts
Fields functionListLibraryName :: Maybe ByteString functionListWithCode :: Bool

Instances

Instances details

Show FunctionListOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> FunctionListOpts -> ShowS # show :: FunctionListOpts -> String # showList :: [FunctionListOpts] -> ShowS #
Eq FunctionListOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: FunctionListOpts -> FunctionListOpts -> Bool # (/=) :: FunctionListOpts -> FunctionListOpts -> Bool #

defaultFunctionListOpts :: FunctionListOpts Source #

data FunctionRestorePolicy Source #

Constructors

FunctionRestoreAppend
FunctionRestoreFlush
FunctionRestoreReplace

Instances

Instances details

Show FunctionRestorePolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> FunctionRestorePolicy -> ShowS # show :: FunctionRestorePolicy -> String # showList :: [FunctionRestorePolicy] -> ShowS #
Eq FunctionRestorePolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: FunctionRestorePolicy -> FunctionRestorePolicy -> Bool # (/=) :: FunctionRestorePolicy -> FunctionRestorePolicy -> Bool #
RedisArg FunctionRestorePolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: FunctionRestorePolicy -> ByteString Source #

functionDelete :: RedisCtx m f => ByteString -> m (f Status) Source #

Deletes a library and its functions (https://redis.io/commands/function-delete).

O(1)

Since Redis 7.0.0

functionDump :: RedisCtx m f => m (f ByteString) Source #

Dumps all libraries into a serialized binary payload (https://redis.io/commands/function-dump).

O(N) where N is the number of functions.

Since Redis 7.0.0

functionFlush :: RedisCtx m f => m (f Status) Source #

Deletes all libraries and functions (https://redis.io/commands/function-flush).

O(N) where N is the number of functions deleted.

Since Redis 7.0.0

functionFlushOpts :: RedisCtx m f => FlushOpts -> m (f Status) Source #

Deletes all libraries and functions (https://redis.io/commands/function-flush).

O(N) where N is the number of functions deleted.

Since Redis 7.0.0

functionHelp :: RedisCtx m f => m (f [ByteString]) Source #

Returns helpful text about FUNCTION subcommands (https://redis.io/commands/function-help).

O(1)

Since Redis 7.0.0

functionKill :: RedisCtx m f => m (f Status) Source #

Terminates a function during execution (https://redis.io/commands/function-kill).

O(1)

Since Redis 7.0.0

functionList :: RedisCtx m f => m (f Reply) Source #

Returns information about all libraries (https://redis.io/commands/function-list).

O(N) where N is the number of functions.

Since Redis 7.0.0

functionListOpts :: RedisCtx m f => FunctionListOpts -> m (f Reply) Source #

Returns information about all libraries (https://redis.io/commands/function-list).

O(N) where N is the number of functions.

Since Redis 7.0.0

functionLoad :: RedisCtx m f => ByteString -> m (f ByteString) Source #

Creates a library (https://redis.io/commands/function-load).

O(N) where N is the number of bytes in the function's source code.

Since Redis 7.0.0

functionLoadReplace :: RedisCtx m f => ByteString -> m (f ByteString) Source #

Creates a library, replacing an existing one with the same name (https://redis.io/commands/function-load).

O(N) where N is the number of bytes in the function's source code.

Since Redis 7.0.0

functionRestore :: RedisCtx m f => ByteString -> Maybe FunctionRestorePolicy -> m (f Status) Source #

Restores all libraries from a payload (https://redis.io/commands/function-restore).

O(N) where N is the number of functions restored.

Since Redis 7.0.0

functionStats :: RedisCtx m f => m (f Reply) Source #

Returns information about a function during execution (https://redis.io/commands/function-stats).

O(1)

Since Redis 7.0.0

bitcount Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f Integer)

bitcountRange Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	end
-> m (f Integer)

bitopAnd Source #

Arguments

:: RedisCtx m f
=> ByteString	destkey
-> [ByteString]	srckeys
-> m (f Integer)

bitopOr Source #

Arguments

:: RedisCtx m f
=> ByteString	destkey
-> [ByteString]	srckeys
-> m (f Integer)

bitopXor Source #

Arguments

:: RedisCtx m f
=> ByteString	destkey
-> [ByteString]	srckeys
-> m (f Integer)

bitopNot Source #

Arguments

:: RedisCtx m f
=> ByteString	destkey
-> ByteString	srckey
-> m (f Integer)

bitop Source #

Arguments

:: RedisCtx m f
=> ByteString	operation
-> [ByteString]	keys
-> m (f Integer)

data VAddQuantization Source #

Constructors

VAddNoQuant
VAddQ8
VAddBin

Instances

Instances details

Show VAddQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VAddQuantization -> ShowS # show :: VAddQuantization -> String # showList :: [VAddQuantization] -> ShowS #
Eq VAddQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VAddQuantization -> VAddQuantization -> Bool # (/=) :: VAddQuantization -> VAddQuantization -> Bool #
RedisArg VAddQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: VAddQuantization -> ByteString Source #

data VAddOpts Source #

Constructors

VAddOpts
Fields vAddReduceDim :: Maybe Integer vAddCas :: Bool vAddQuantization :: Maybe VAddQuantization vAddBuildExplorationFactor :: Maybe Integer vAddAttributes :: Maybe ByteString vAddNumLinks :: Maybe Integer

Instances

Instances details

Show VAddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VAddOpts -> ShowS # show :: VAddOpts -> String # showList :: [VAddOpts] -> ShowS #
Eq VAddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VAddOpts -> VAddOpts -> Bool # (/=) :: VAddOpts -> VAddOpts -> Bool #

data VQuantization Source #

Constructors

VQuantizationFP32
VQuantizationBin
VQuantizationQ8

Instances

Instances details

Show VQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VQuantization -> ShowS # show :: VQuantization -> String # showList :: [VQuantization] -> ShowS #
Eq VQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VQuantization -> VQuantization -> Bool # (/=) :: VQuantization -> VQuantization -> Bool #
RedisArg VQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: VQuantization -> ByteString Source #
RedisResult VQuantization Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VQuantization Source #

data VEmbRawResponse Source #

Constructors

VEmbRawResponse
Fields vEmbRawQuantization :: VQuantization vEmbRawData :: ByteString vEmbRawNorm :: Double vEmbRawRange :: Maybe Double

Instances

Instances details

Show VEmbRawResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VEmbRawResponse -> ShowS # show :: VEmbRawResponse -> String # showList :: [VEmbRawResponse] -> ShowS #
Eq VEmbRawResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VEmbRawResponse -> VEmbRawResponse -> Bool # (/=) :: VEmbRawResponse -> VEmbRawResponse -> Bool #
RedisResult VEmbRawResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VEmbRawResponse Source #

data VInfoResponse Source #

Constructors

VInfoResponse
Fields vInfoQuantization :: Maybe ByteString vInfoVectorDim :: Maybe Integer vInfoSize :: Maybe Integer vInfoMaxLevel :: Maybe Integer vInfoUid :: Maybe Integer vInfoHnswMaxNodeUid :: Maybe Integer

Instances

Instances details

Show VInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VInfoResponse -> ShowS # show :: VInfoResponse -> String # showList :: [VInfoResponse] -> ShowS #
Eq VInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VInfoResponse -> VInfoResponse -> Bool # (/=) :: VInfoResponse -> VInfoResponse -> Bool #
RedisResult VInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VInfoResponse Source #

newtype VLinksResponse Source #

Constructors

VLinksResponse
Fields vLinksLayers :: [[ByteString]]

Instances

Instances details

Show VLinksResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VLinksResponse -> ShowS # show :: VLinksResponse -> String # showList :: [VLinksResponse] -> ShowS #
Eq VLinksResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VLinksResponse -> VLinksResponse -> Bool # (/=) :: VLinksResponse -> VLinksResponse -> Bool #
RedisResult VLinksResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VLinksResponse Source #

newtype VLinksWithScoresResponse Source #

Constructors

VLinksWithScoresResponse
Fields vLinksWithScoresLayers :: [[(ByteString, Double)]]

Instances

Instances details

Show VLinksWithScoresResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VLinksWithScoresResponse -> ShowS # show :: VLinksWithScoresResponse -> String # showList :: [VLinksWithScoresResponse] -> ShowS #
Eq VLinksWithScoresResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VLinksWithScoresResponse -> VLinksWithScoresResponse -> Bool # (/=) :: VLinksWithScoresResponse -> VLinksWithScoresResponse -> Bool #
RedisResult VLinksWithScoresResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VLinksWithScoresResponse Source #

data VSimQuery Source #

Constructors

VSimByElement ByteString
VSimByFp32 ByteString
VSimByValues (NonEmpty Double)

Instances

Instances details

Show VSimQuery Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VSimQuery -> ShowS # show :: VSimQuery -> String # showList :: [VSimQuery] -> ShowS #
Eq VSimQuery Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VSimQuery -> VSimQuery -> Bool # (/=) :: VSimQuery -> VSimQuery -> Bool #

data VSimOpts Source #

Constructors

VSimOpts
Fields vSimCount :: Maybe Integer vSimEpsilon :: Maybe Double vSimEf :: Maybe Integer vSimFilter :: Maybe ByteString vSimFilterEf :: Maybe Integer vSimTruth :: Bool vSimNoThread :: Bool

Instances

Instances details

Show VSimOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VSimOpts -> ShowS # show :: VSimOpts -> String # showList :: [VSimOpts] -> ShowS #
Eq VSimOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VSimOpts -> VSimOpts -> Bool # (/=) :: VSimOpts -> VSimOpts -> Bool #

defaultVSimOpts :: VSimOpts Source #

data VSimWithAttribsResult Source #

Constructors

VSimWithAttribsResult
Fields vSimResultElement :: ByteString vSimResultScore :: Double vSimResultAttributes :: Maybe ByteString

Instances

Instances details

Show VSimWithAttribsResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VSimWithAttribsResult -> ShowS # show :: VSimWithAttribsResult -> String # showList :: [VSimWithAttribsResult] -> ShowS #
Eq VSimWithAttribsResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VSimWithAttribsResult -> VSimWithAttribsResult -> Bool # (/=) :: VSimWithAttribsResult -> VSimWithAttribsResult -> Bool #
RedisResult VSimWithAttribsResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VSimWithAttribsResult Source #

newtype VSimWithAttribsResponse Source #

Constructors

VSimWithAttribsResponse
Fields vSimWithAttribsResults :: [VSimWithAttribsResult]

Instances

Instances details

Show VSimWithAttribsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> VSimWithAttribsResponse -> ShowS # show :: VSimWithAttribsResponse -> String # showList :: [VSimWithAttribsResponse] -> ShowS #
Eq VSimWithAttribsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: VSimWithAttribsResponse -> VSimWithAttribsResponse -> Bool # (/=) :: VSimWithAttribsResponse -> VSimWithAttribsResponse -> Bool #
RedisResult VSimWithAttribsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply VSimWithAttribsResponse Source #

defaultVAddOpts :: VAddOpts Source #

Redis default VAddOpts. Equivalent to omitting all optional parameters.

vadd Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that will hold the vector set data.
-> NonEmpty Double	The vector values as floating point numbers. This uses the `VALUES` argument form and automatically supplies the number of vector elements.
-> ByteString	The name of the element that is being added to the vector set.
-> m (f Bool)

Adds a new element to a vector set, or updates its vector if it already exists (https://redis.io/commands/vadd).

O(log(N)) for each element added, where N is the number of elements in the vector set.

Since Redis 8.0.0

vaddOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that will hold the vector set data.
-> NonEmpty Double	The vector values as floating point numbers.
-> ByteString	The name of the element that is being added to the vector set.
-> VAddOpts	Additional parameters. `REDUCE dim` reduces the dimensionality of the vector using random projection. `CAS` performs the slow neighbor candidate collection in the background. `NOQUANT`, `Q8`, and `BIN` control quantization and are mutually exclusive. `EF` sets the build exploration factor. `SETATTR` associates attributes with the entry. `M` sets the maximum number of graph links per node.
-> m (f Bool)

Adds a new element to a vector set, or updates its vector if it already exists (https://redis.io/commands/vadd).

O(log(N)) for each element added, where N is the number of elements in the vector set.

Since Redis 8.0.0

vcard Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> m (f Integer)

Return the number of elements in the specified vector set (https://redis.io/commands/vcard).

O(1)

Since Redis 8.0.0

vdim Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> m (f Integer)

Return the number of dimensions of the vectors in the specified vector set (https://redis.io/commands/vdim).

O(1)

Since Redis 8.0.0

vemb Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element whose vector you want to retrieve.
-> m (f [Double])

Return the approximate vector associated with a given element in the vector set (https://redis.io/commands/vemb).

O(1)

Since Redis 8.0.0

vembRaw Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element whose vector you want to retrieve.
-> m (f (Maybe VEmbRawResponse))

Return the raw internal representation of the vector associated with a given element in the vector set (https://redis.io/commands/vemb).

O(1)

Since Redis 8.0.0

vgetattr Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element whose attributes you want to retrieve.
-> m (f (Maybe ByteString))

Retrieve the JSON attributes of an element in a vector set (https://redis.io/commands/vgetattr).

O(1)

Since Redis 8.0.0

vinfo Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> m (f (Maybe VInfoResponse))

Return metadata and internal details about a vector set (https://redis.io/commands/vinfo).

O(1)

Since Redis 8.0.0

vismember Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element to check.
-> m (f Bool)

Check if an element exists in a vector set (https://redis.io/commands/vismember).

O(1)

Since Redis 8.0.0

vlinks Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element whose HNSW neighbors you want to inspect.
-> m (f (Maybe VLinksResponse))

Return the neighbors of a specified element in a vector set (https://redis.io/commands/vlinks).

O(1)

Since Redis 8.0.0

vlinksWithScores Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element whose HNSW neighbors you want to inspect.
-> m (f (Maybe VLinksWithScoresResponse))

Return the neighbors of a specified element in a vector set together with their similarity scores (https://redis.io/commands/vlinks).

O(1)

Since Redis 8.0.0

vrandmember Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> m (f (Maybe ByteString))

Return one random element from a vector set (https://redis.io/commands/vrandmember).

O(N) where N is the absolute value of the count argument.

Since Redis 8.0.0

vrandmemberCount Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> Integer	The number of elements to return. Positive values return distinct elements; negative values allow duplicates.
-> m (f [ByteString])

Return one or multiple random elements from a vector set (https://redis.io/commands/vrandmember).

O(N) where N is the absolute value of the count argument.

Since Redis 8.0.0

vrange Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the vector set key from which to retrieve elements.
-> ByteString	The starting point of the lexicographical range. Use a value prefixed with `[` for an inclusive bound, a value prefixed with `(` for an exclusive bound, or `-` for the minimum element.
-> ByteString	The ending point of the lexicographical range. Use a value prefixed with `[` for an inclusive bound, a value prefixed with `(` for an exclusive bound, or `+` for the maximum element.
-> m (f [ByteString])

Returns elements in a lexicographical range (https://redis.io/commands/vrange).

O(log(K)+M) where K is the number of elements in the start prefix, and M is the number of elements returned. In practical terms, the command is just O(M).

Since Redis 8.4.0

vrangeCount Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the vector set key from which to retrieve elements.
-> ByteString	The starting point of the lexicographical range.
-> ByteString	The ending point of the lexicographical range.
-> Integer	The maximum number of elements to return. If `count` is negative, the command returns all elements in the specified range.
-> m (f [ByteString])

Returns elements in a lexicographical range (https://redis.io/commands/vrange).

O(log(K)+M) where K is the number of elements in the start prefix, and M is the number of elements returned. In practical terms, the command is just O(M).

Since Redis 8.4.0

vrem Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element to remove from the vector set.
-> m (f Bool)

Remove an element from a vector set (https://redis.io/commands/vrem).

O(log(N)) for each element removed, where N is the number of elements in the vector set.

Since Redis 8.0.0

vsetattr Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set.
-> ByteString	The name of the element in the vector set.
-> ByteString	The attributes as a JSON object string. Use the empty string to remove existing attributes.
-> m (f Bool)

Associate or remove the JSON attributes of an element in a vector set (https://redis.io/commands/vsetattr).

O(1)

Since Redis 8.0.0

vsim Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set data.
-> VSimQuery	Query vector source. Use `VSimByElement` to refer to an existing element, `VSimByFp32` for binary float format, or `VSimByValues` for a list of float values.
-> m (f [ByteString])

Return elements similar to a given vector or element (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.0.0

vsimOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set data.
-> VSimQuery	Query vector source.
-> VSimOpts	Additional search options. `COUNT` limits the number of returned results. `EPSILON` filters out elements that are too far from the query vector. `EF` controls the exploration factor. `FILTER` applies a filtering expression and `FILTER-EF` limits filtering effort. `TRUTH` forces an exact linear scan. `NOTHREAD` executes the search in the main thread.
-> m (f [ByteString])

Return elements similar to a given vector or element (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.0.0

vsimWithScores Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set data.
-> VSimQuery	Query vector source.
-> m (f [(ByteString, Double)])

Return elements similar to a given vector or element together with their similarity scores (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.0.0

vsimWithScoresOpts :: RedisCtx m f => ByteString -> VSimQuery -> VSimOpts -> m (f [(ByteString, Double)]) Source #

Return elements similar to a given vector or element together with their similarity scores (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.0.0

vsimWithScoresWithAttribs Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key that holds the vector set data.
-> VSimQuery	Query vector source.
-> m (f VSimWithAttribsResponse)

Return elements similar to a given vector or element together with their similarity scores and JSON attributes (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.2.0

vsimWithScoresWithAttribsOpts :: RedisCtx m f => ByteString -> VSimQuery -> VSimOpts -> m (f VSimWithAttribsResponse) Source #

Return elements similar to a given vector or element together with their similarity scores and JSON attributes (https://redis.io/commands/vsim).

O(log(N)) where N is the number of elements in the vector set.

Since Redis 8.2.0

vSimQueryArgs :: VSimQuery -> [ByteString] Source #

vSimOptsArgs :: VSimOpts -> [ByteString] Source #

migrate Source #

Arguments

:: RedisCtx m f
=> ByteString	host
-> ByteString	port
-> ByteString	key
-> Integer	destinationDb
-> Integer	timeout
-> m (f Status)

Atomically transfer a key from a Redis instance to another one (http://redis.io/commands/migrate). The Redis command MIGRATE is split up into migrate, migrateMultiple. Since Redis 2.6.0

data MigrateAuth Source #

Constructors

MigrateAuth ByteString
MigrateAuth2 ByteString ByteString

Instances

Instances details

Show MigrateAuth Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> MigrateAuth -> ShowS # show :: MigrateAuth -> String # showList :: [MigrateAuth] -> ShowS #
Eq MigrateAuth Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: MigrateAuth -> MigrateAuth -> Bool # (/=) :: MigrateAuth -> MigrateAuth -> Bool #

data MigrateOpts Source #

Options for the migrate command.

Constructors

MigrateOpts
Fields migrateCopy :: Bool migrateReplace :: Bool migrateAuth :: Maybe MigrateAuth

Instances

Instances details

Show MigrateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> MigrateOpts -> ShowS # show :: MigrateOpts -> String # showList :: [MigrateOpts] -> ShowS #
Eq MigrateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: MigrateOpts -> MigrateOpts -> Bool # (/=) :: MigrateOpts -> MigrateOpts -> Bool #

defaultMigrateOpts :: MigrateOpts Source #

Redis default MigrateOpts. Equivalent to omitting all optional parameters.

MigrateOpts
    { migrateCopy    = False -- remove the key from the local instance
    , migrateReplace = False -- don't replace existing key on the remote instance
    , migrateAuth = Nothing
    }

migrateMultiple Source #

Arguments

:: RedisCtx m f
=> ByteString	host
-> ByteString	port
-> Integer	destinationDb
-> Integer	timeout
-> MigrateOpts
-> [ByteString]	keys
-> m (f Status)

Atomically transfer a key from a Redis instance to another one (http://redis.io/commands/migrate). The Redis command MIGRATE is split up into migrate, migrateMultiple. Since Redis 2.6.0

restore Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	timeToLive
-> ByteString	serializedValue
-> m (f Status)

Create a key using the provided serialized value, previously obtained using DUMP (http://redis.io/commands/restore). The Redis command RESTORE is split up into restore, restoreReplace. Since Redis 2.6.0

data RestoreOpts Source #

Constructors

RestoreOpts
Fields restoreOptsReplace :: Bool restoreOptsAbsTTL :: Bool restoreOptsIdle :: Maybe Integer restoreOptsFreq :: Maybe Integer

restoreOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	timeToLive
-> ByteString	serializedValue
-> RestoreOpts	restore options
-> m (f Status)

Create a key using the provided serialized value, previously obtained using DUMP (http://redis.io/commands/restore). The Redis command RESTORE is split up into restore, restoreReplace. Since Redis 2.6.0

restoreReplace Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	timeToLive
-> ByteString	serializedValue
-> m (f Status)

Create a key using the provided serialized value, previously obtained using DUMP (http://redis.io/commands/restore). The Redis command RESTORE is split up into restore, restoreReplace. Since Redis 2.6.0

data CopyOpts Source #

Options for the copy command.

Constructors

CopyOpts
Fields copyDestinationDb :: Maybe Integer Destination database number. copyReplace :: Bool Replace the destination key if it already exists.

Instances

Instances details

Show CopyOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> CopyOpts -> ShowS # show :: CopyOpts -> String # showList :: [CopyOpts] -> ShowS #
Eq CopyOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: CopyOpts -> CopyOpts -> Bool # (/=) :: CopyOpts -> CopyOpts -> Bool #

defaultCopyOpts :: CopyOpts Source #

Redis default CopyOpts. Equivalent to omitting all optional parameters.

copy Source #

Arguments

:: RedisCtx m f
=> ByteString	Source key
-> ByteString	Destination key
-> m (f Bool)

Copies the value of a key to a new key (https://redis.io/commands/copy).

O(N) worst case for collections, where N is the number of nested items. O(1) for string values.

Since Redis 6.2.0

copyOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Source key
-> ByteString	Destination key
-> CopyOpts	Copy options
-> m (f Bool)

Copies the value of a key to a new key (https://redis.io/commands/copy).

O(N) worst case for collections, where N is the number of nested items. O(1) for string values.

Since Redis 6.2.0

expiretime :: RedisCtx m f => ByteString -> m (f Integer) Source #

Returns the expiration time of a key as a Unix timestamp (https://redis.io/commands/expiretime).

Returns -2 if the key does not exist; -1 if the key exists but has no associated expiration.

O(1). Since Redis 7.0.0

pexpiretime :: RedisCtx m f => ByteString -> m (f Integer) Source #

Returns the expiration time of a key as a Unix timestamp in milliseconds (https://redis.io/commands/pexpiretime).

Returns -2 if the key does not exist; -1 if the key exists but has no associated expiration.

O(1). Since Redis 7.0.0

set Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	value
-> m (f Status)

data Condition Source #

Constructors

Nx	Only set the key if it does not already exist.
Xx	Only set the key if it already exists.

Instances

Instances details

Show Condition Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> Condition -> ShowS # show :: Condition -> String # showList :: [Condition] -> ShowS #
Eq Condition Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: Condition -> Condition -> Bool # (/=) :: Condition -> Condition -> Bool #
RedisArg Condition Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: Condition -> ByteString Source #

data SetOpts Source #

Constructors

SetOpts

Fields

setSeconds :: Maybe Integer
Set the specified expire time, in seconds.
setMilliseconds :: Maybe Integer
Set the specified expire time, in milliseconds.
setUnixSeconds :: Maybe Integer
Set the specified Unix time at which the key will expire, in seconds.
Since Redis 6.2
setUnixMilliseconds :: Maybe Integer
Set the specified Unix time at which the key will expire, in milliseconds.
setCondition :: Maybe Condition
Set the key on condition
setKeepTTL :: Bool
Retain the time to live associated with the key.
Since Redis 6.0

Instances

Instances details

Show SetOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> SetOpts -> ShowS # show :: SetOpts -> String # showList :: [SetOpts] -> ShowS #
Eq SetOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: SetOpts -> SetOpts -> Bool # (/=) :: SetOpts -> SetOpts -> Bool #

defaultSetOpts :: SetOpts Source #

Redis default SetOpts. Equivalent to omitting all optional parameters.

internalSetOptsToArgs :: SetOpts -> [ByteString] Source #

setOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	value
-> SetOpts
-> m (f Status)

setGet Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	value
-> m (f ByteString)

setGetOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> ByteString	value
-> SetOpts
-> m (f ByteString)

msetex Source #

Arguments

:: RedisCtx m f
=> NonEmpty (ByteString, ByteString)	A series of key/value pairs.
-> m (f Bool)

Atomically sets multiple string keys with an optional shared expiration in a single operation (https://redis.io/commands/msetex).

O(N) where N is the number of keys to set.

Since Redis 8.4.0

msetexOpts Source #

Arguments

:: RedisCtx m f
=> NonEmpty (ByteString, ByteString)	A series of key/value pairs.
-> SetOpts	Shared condition and expiration flags. The `MSETEX` command supports a set of options that modify its behavior: `NX` sets the keys and their expiration time only if none of the specified keys exist. `XX` sets the keys and their expiration time only if all of the specified keys already exist. `EX``PX``EXAT`/`PXAT` set the shared expiration for the specified keys. `KEEPTTL` retains the time to live associated with the keys.
-> m (f Bool)

Atomically sets multiple string keys with an optional shared expiration in a single operation (https://redis.io/commands/msetex).

O(N) where N is the number of keys to set.

Since Redis 8.4.0

data GetExOpts Source #

Constructors

GetExOpts
Fields getExSeconds :: Maybe Integer getExMilliseconds :: Maybe Integer getExUnixSeconds :: Maybe Integer getExUnixMilliseconds :: Maybe Integer getExPersist :: Bool

Instances

Instances details

Show GetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GetExOpts -> ShowS # show :: GetExOpts -> String # showList :: [GetExOpts] -> ShowS #
Eq GetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GetExOpts -> GetExOpts -> Bool # (/=) :: GetExOpts -> GetExOpts -> Bool #

defaultGetExOpts :: GetExOpts Source #

getdel :: RedisCtx m f => ByteString -> m (f (Maybe ByteString)) Source #

Returns the string value of a key after deleting the key (https://redis.io/commands/getdel).

O(1)

Since Redis 6.2.0

data DelexCondition Source #

Constructors

DelexIfEq ByteString
DelexIfNe ByteString
DelexIfDigestEq ByteString
DelexIfDigestNe ByteString

Instances

Instances details

Show DelexCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> DelexCondition -> ShowS # show :: DelexCondition -> String # showList :: [DelexCondition] -> ShowS #
Eq DelexCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: DelexCondition -> DelexCondition -> Bool # (/=) :: DelexCondition -> DelexCondition -> Bool #

delexConditionToArgs :: DelexCondition -> [ByteString] Source #

delex Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the string.
-> m (f Bool)

Conditionally removes the specified key based on value or hash digest comparison (https://redis.io/commands/delex).

O(1) for IFEQ and IFNE. O(N) for IFDEQ and IFDNE, where N is the length of the string value.

Since Redis 8.4.0

delexWhen Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the string.
-> DelexCondition	Condition to enforce. The `DELEX` command supports a set of options that modify its behavior. Only one option can be specified: `IFEQ` removes the key if the value is equal to the specified value. `IFNE` removes the key if the value is not equal to the specified value. `IFDEQ` removes the key if its hash digest is equal to the specified hash digest. `IFDNE` removes the key if its hash digest is not equal to the specified hash digest.
-> m (f Bool)

Conditionally removes the specified key based on value or hash digest comparison (https://redis.io/commands/delex).

O(1) for IFEQ and IFNE. O(N) for IFDEQ and IFDNE, where N is the length of the string value.

Since Redis 8.4.0

digest Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the string.
-> m (f (Maybe ByteString))

Returns the hash digest of a string value (https://redis.io/commands/digest).

O(N) where N is the length of the string value.

Since Redis 8.4.0

getex :: RedisCtx m f => ByteString -> m (f (Maybe ByteString)) Source #

Returns the string value of a key after setting its expiration time (https://redis.io/commands/getex).

O(1)

Since Redis 6.2.0

getexOpts :: RedisCtx m f => ByteString -> GetExOpts -> m (f (Maybe ByteString)) Source #

Returns the string value of a key after setting its expiration time (https://redis.io/commands/getex).

O(1)

Since Redis 6.2.0

data HGetExOpts Source #

Constructors

HGetExOpts
Fields hGetExSeconds :: Maybe Integer hGetExMilliseconds :: Maybe Integer hGetExUnixSeconds :: Maybe Integer hGetExUnixMilliseconds :: Maybe Integer hGetExPersist :: Bool

Instances

Instances details

Show HGetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HGetExOpts -> ShowS # show :: HGetExOpts -> String # showList :: [HGetExOpts] -> ShowS #
Eq HGetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HGetExOpts -> HGetExOpts -> Bool # (/=) :: HGetExOpts -> HGetExOpts -> Bool #

defaultHGetExOpts :: HGetExOpts Source #

hgetex :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe ByteString]) Source #

Returns the values associated with the specified fields in a hash and optionally updates the key expiration (https://redis.io/commands/hgetex).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

hgetexOpts :: RedisCtx m f => ByteString -> NonEmpty ByteString -> HGetExOpts -> m (f [Maybe ByteString]) Source #

Returns the values associated with the specified fields in a hash and optionally updates the key expiration (https://redis.io/commands/hgetex).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

hgetdel :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe ByteString]) Source #

Returns the values associated with the specified fields in a hash and deletes those fields (https://redis.io/commands/hgetdel).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

data HSetExCondition Source #

Constructors

HSetExFnx
HSetExFxx

Instances

Instances details

Show HSetExCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HSetExCondition -> ShowS # show :: HSetExCondition -> String # showList :: [HSetExCondition] -> ShowS #
Eq HSetExCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HSetExCondition -> HSetExCondition -> Bool # (/=) :: HSetExCondition -> HSetExCondition -> Bool #
RedisArg HSetExCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: HSetExCondition -> ByteString Source #

data HSetExOpts Source #

Constructors

HSetExOpts
Fields hSetExSeconds :: Maybe Integer hSetExMilliseconds :: Maybe Integer hSetExUnixSeconds :: Maybe Integer hSetExUnixMilliseconds :: Maybe Integer hSetExCondition :: Maybe HSetExCondition hSetExKeepTTL :: Bool

Instances

Instances details

Show HSetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HSetExOpts -> ShowS # show :: HSetExOpts -> String # showList :: [HSetExOpts] -> ShowS #
Eq HSetExOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HSetExOpts -> HSetExOpts -> Bool # (/=) :: HSetExOpts -> HSetExOpts -> Bool #

defaultHSetExOpts :: HSetExOpts Source #

hsetex :: RedisCtx m f => ByteString -> NonEmpty (ByteString, ByteString) -> m (f Bool) Source #

Sets fields in a hash and optionally updates the key expiration (https://redis.io/commands/hsetex).

O(N) where N is the number of fields set.

Since Redis 8.0.0

hsetexOpts :: RedisCtx m f => ByteString -> NonEmpty (ByteString, ByteString) -> HSetExOpts -> m (f Bool) Source #

Sets fields in a hash and optionally updates the key expiration (https://redis.io/commands/hsetex).

O(N) where N is the number of fields set.

Since Redis 8.0.0

data HashFieldExpirationStatus Source #

Constructors

HashFieldExpirationNoSuchField
HashFieldExpirationConditionNotMet
HashFieldExpirationSet
HashFieldExpirationDeleted

Instances

Instances details

Show HashFieldExpirationStatus Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HashFieldExpirationStatus -> ShowS # show :: HashFieldExpirationStatus -> String # showList :: [HashFieldExpirationStatus] -> ShowS #
Eq HashFieldExpirationStatus Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HashFieldExpirationStatus -> HashFieldExpirationStatus -> Bool # (/=) :: HashFieldExpirationStatus -> HashFieldExpirationStatus -> Bool #
RedisResult HashFieldExpirationStatus Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply HashFieldExpirationStatus Source #

data HashFieldExpirationInfo Source #

Constructors

HashFieldExpirationInfoNoSuchField
HashFieldExpirationInfoNoExpiration
HashFieldExpirationInfo Integer

Instances

Instances details

Show HashFieldExpirationInfo Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HashFieldExpirationInfo -> ShowS # show :: HashFieldExpirationInfo -> String # showList :: [HashFieldExpirationInfo] -> ShowS #
Eq HashFieldExpirationInfo Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HashFieldExpirationInfo -> HashFieldExpirationInfo -> Bool # (/=) :: HashFieldExpirationInfo -> HashFieldExpirationInfo -> Bool #
RedisResult HashFieldExpirationInfo Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply HashFieldExpirationInfo Source #

hashFieldExpirationOptsToArgs :: ExpireOpts -> [ByteString] Source #

hashFieldArgs :: NonEmpty ByteString -> [ByteString] Source #

hexpire Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Seconds until expiration.
-> NonEmpty ByteString	List of fields to set expiration for.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using relative time to expire in seconds (https://redis.io/commands/hexpire).

O(N) where N is the number of specified fields.

Set an expiration (TTL or time to live) on one or more fields of a given hash key. You must specify at least one field. Field(s) will automatically be deleted from the hash key when their TTLs expire.

Field expirations will only be cleared by commands that delete or overwrite the contents of the hash fields, including HDEL and HSET commands. This means that all the operations that conceptually alter the value stored at a hash key's field without replacing it with a new one will leave the TTL untouched.

You can clear the TTL using the hpersist command, which turns the hash field back into a persistent field.

Note that calling hexpirehpexpire with a zero TTL or hexpireathpexpireat with a time in the past will result in the hash field being deleted.

Since Redis 7.4.0

hexpireOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Seconds until expiration.
-> NonEmpty ByteString	List of fields to set expiration for.
-> ExpireOpts	Expiration options.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using relative time to expire in seconds (https://redis.io/commands/hexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpexpire Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Milliseconds until expiration.
-> NonEmpty ByteString	List of fields to set expiration for.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using relative time to expire in milliseconds (https://redis.io/commands/hpexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpexpireOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Milliseconds until expiration.
-> NonEmpty ByteString	List of fields to set expiration for.
-> ExpireOpts	Expiration options.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using relative time to expire in milliseconds (https://redis.io/commands/hpexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hexpireat Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Absolute Unix timestamp in seconds at which the hash fields will expire.
-> NonEmpty ByteString	List of fields to set expiration for.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using an absolute Unix timestamp in seconds (https://redis.io/commands/hexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hexpireatOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Absolute Unix timestamp in seconds at which the hash fields will expire.
-> NonEmpty ByteString	List of fields to set expiration for.
-> ExpireOpts	Expiration options.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using an absolute Unix timestamp in seconds (https://redis.io/commands/hexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpexpireat Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Absolute Unix timestamp in milliseconds at which the hash fields will expire.
-> NonEmpty ByteString	List of fields to set expiration for.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using an absolute Unix timestamp in milliseconds (https://redis.io/commands/hpexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpexpireatOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> Integer	Absolute Unix timestamp in milliseconds at which the hash fields will expire.
-> NonEmpty ByteString	List of fields to set expiration for.
-> ExpireOpts	Expiration options.
-> m (f [HashFieldExpirationStatus])

Sets expiration for hash fields using an absolute Unix timestamp in milliseconds (https://redis.io/commands/hpexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

httl Source #

Arguments

:: RedisCtx m f
=> ByteString	Key of the hash.
-> NonEmpty ByteString	List of fields to get TTL for.
-> m (f [HashFieldExpirationInfo])

Returns the TTL in seconds of hash fields (https://redis.io/commands/httl).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpttl :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo]) Source #

Returns the TTL in milliseconds of hash fields (https://redis.io/commands/hpttl).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hexpiretime :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo]) Source #

Returns the expiration time of hash fields as a Unix timestamp in seconds (https://redis.io/commands/hexpiretime).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

hpexpiretime :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [HashFieldExpirationInfo]) Source #

Returns the expiration time of hash fields as a Unix timestamp in milliseconds (https://redis.io/commands/hpexpiretime).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

data DebugMode Source #

Constructors

Yes
Sync
No

Instances

Instances details

Show DebugMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> DebugMode -> ShowS # show :: DebugMode -> String # showList :: [DebugMode] -> ShowS #
Eq DebugMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: DebugMode -> DebugMode -> Bool # (/=) :: DebugMode -> DebugMode -> Bool #
RedisArg DebugMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: DebugMode -> ByteString Source #

scriptDebug :: RedisCtx m f => DebugMode -> m (f Bool) Source #

Set the debug mode for executed scripts (http://redis.io/commands/script-debug). Since Redis 3.2.0

zadd Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> [(Double, ByteString)]	scoreMember
-> m (f Integer)

Add one or more members to a sorted set, or update its score if it already exists (http://redis.io/commands/zadd). The Redis command ZADD is split up into zadd, zaddOpts. Since Redis 1.2.0

data SizeCondition Source #

Constructors

CGT	Only update existing elements if the new score is greater than the current score. This flag doesn't prevent adding new elements.
CLT	Only update existing elements if the new score is less than the current score. This flag doesn't prevent adding new elements.

Instances

Instances details

Show SizeCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> SizeCondition -> ShowS # show :: SizeCondition -> String # showList :: [SizeCondition] -> ShowS #
Eq SizeCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: SizeCondition -> SizeCondition -> Bool # (/=) :: SizeCondition -> SizeCondition -> Bool #
RedisArg SizeCondition Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: SizeCondition -> ByteString Source #

data ZaddOpts Source #

Add one or more members to a sorted set, or update its score if it already exists (http://redis.io/commands/zadd). The Redis command ZADD is split up into zadd, zaddOpts. Since Redis 1.2.0

Constructors

ZaddOpts

Fields

zaddCondition :: Maybe Condition
Add on condition
zaddSizeCondition :: Maybe SizeCondition
Only update existing elements on condition
Since Redis 6.2
zaddChange :: Bool
Modify the return value from the number of new elements added, to the total number of elements changed
zaddIncrement :: Bool
When this option is specified ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.

Instances

Instances details

Show ZaddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZaddOpts -> ShowS # show :: ZaddOpts -> String # showList :: [ZaddOpts] -> ShowS #
Eq ZaddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZaddOpts -> ZaddOpts -> Bool # (/=) :: ZaddOpts -> ZaddOpts -> Bool #

defaultZaddOpts :: ZaddOpts Source #

Redis default ZaddOpts. Equivalent to omitting all optional parameters.

ZaddOpts
  { zaddCondition = Nothing -- omit NX and XX options
  , zaddChange    = False   -- don't modify the return value from the number of new elements added, to the total number of elements changed
  , zaddIncrement = False   -- don't add like ZINCRBY
  , zaddSizeCondition = Nothing -- omit GT and LT options
  }

zaddOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> [(Double, ByteString)]	scoreMember
-> ZaddOpts	options
-> m (f Integer)

data ReplyMode Source #

Constructors

On
Off
Skip

Instances

Instances details

Show ReplyMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ReplyMode -> ShowS # show :: ReplyMode -> String # showList :: [ReplyMode] -> ShowS #
Eq ReplyMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ReplyMode -> ReplyMode -> Bool # (/=) :: ReplyMode -> ReplyMode -> Bool #
RedisArg ReplyMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: ReplyMode -> ByteString Source #

clientReply :: RedisCtx m f => ReplyMode -> m (f Bool) Source #

Instruct the server whether to reply to commands (http://redis.io/commands/client-reply). Since Redis 3.2

clientUnpause :: RedisCtx m f => m (f Status) Source #

Resumes processing commands from paused clients (https://redis.io/commands/client-unpause).

O(N) where N is the number of paused clients.

Since Redis 6.2.0

clientNoTouch :: RedisCtx m f => Bool -> m (f Status) Source #

The CLIENT NO-TOUCH command controls whether commands sent by the client will alter the LRULFU of the keys they access (<https:redis.iocommands/client-notouch>).

When turned on, the current client will not change LFU/LRU stats, unless it sends the TOUCH command.

When turned off, the client touches LFU/LRU stats just as a normal client.

O(1)

Since Redis 7.2.0

data ClientSetInfoOpts Source #

Constructors

ClientSetInfoLibName ByteString
ClientSetInfoLibVer ByteString

Instances

Instances details

Show ClientSetInfoOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClientSetInfoOpts -> ShowS # show :: ClientSetInfoOpts -> String # showList :: [ClientSetInfoOpts] -> ShowS #
Eq ClientSetInfoOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClientSetInfoOpts -> ClientSetInfoOpts -> Bool # (/=) :: ClientSetInfoOpts -> ClientSetInfoOpts -> Bool #

clientSetinfo :: RedisCtx m f => ClientSetInfoOpts -> m (f Status) Source #

The CLIENT SETINFO command assigns various info attributes to the current connection which are displayed in the output of CLIENT LIST and CLIENT INFO (https://redis.io/commands/client-setinfo).

O(1)

Since Redis 7.2.0

srandmember Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f (Maybe ByteString))

Get one or multiple random members from a set (http://redis.io/commands/srandmember). The Redis command SRANDMEMBER is split up into srandmember, srandmemberN. Since Redis 1.0.0

srandmemberN Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	count
-> m (f [ByteString])

Get one or multiple random members from a set (http://redis.io/commands/srandmember). The Redis command SRANDMEMBER is split up into srandmember, srandmemberN. Since Redis 1.0.0

spop Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f (Maybe ByteString))

Remove and return one or multiple random members from a set (http://redis.io/commands/spop). The Redis command SPOP is split up into spop, spopN. Since Redis 1.0.0

spopN Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	count
-> m (f [ByteString])

Remove and return one or multiple random members from a set (http://redis.io/commands/spop). The Redis command SPOP is split up into spop, spopN. Since Redis 1.0.0

smismember :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Bool]) Source #

Determines whether multiple members belong to a set (https://redis.io/commands/smismember).

O(N) where N is the number of elements being checked for membership.

Since Redis 6.2.0

data SintercardOpts Source #

Constructors

SintercardOpts
Fields sintercardLimit :: Maybe Integer

Instances

Instances details

Show SintercardOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> SintercardOpts -> ShowS # show :: SintercardOpts -> String # showList :: [SintercardOpts] -> ShowS #
Eq SintercardOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: SintercardOpts -> SintercardOpts -> Bool # (/=) :: SintercardOpts -> SintercardOpts -> Bool #

defaultSintercardOpts :: SintercardOpts Source #

sintercard :: RedisCtx m f => NonEmpty ByteString -> m (f Integer) Source #

Returns the cardinality of the intersection of multiple sets (https://redis.io/commands/sintercard).

O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

sintercardOpts :: RedisCtx m f => NonEmpty ByteString -> SintercardOpts -> m (f Integer) Source #

Returns the cardinality of the intersection of multiple sets (https://redis.io/commands/sintercard).

O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

info :: RedisCtx m f => m (f ByteString) Source #

infoSection Source #

Arguments

:: RedisCtx m f
=> ByteString	section
-> m (f ByteString)

exists Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> m (f Bool)

Determine if a key exists (http://redis.io/commands/exists). Since Redis 1.0.0

newtype Cursor Source #

Constructors

Cursor ByteString

Instances

Instances details

Show Cursor Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> Cursor -> ShowS # show :: Cursor -> String # showList :: [Cursor] -> ShowS #
Eq Cursor Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: Cursor -> Cursor -> Bool # (/=) :: Cursor -> Cursor -> Bool #
RedisArg Cursor Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: Cursor -> ByteString Source #
RedisResult Cursor Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply Cursor Source #

cursor0 :: Cursor Source #

scan Source #

Arguments

:: RedisCtx m f
=> Cursor
-> m (f (Cursor, [ByteString]))	next cursor and values

Incrementally iterate the keys space (http://redis.io/commands/scan). The Redis command SCAN is split up into scan, scanOpts. Since Redis 2.8.0

data ScanOpts Source #

Constructors

ScanOpts
Fields scanMatch :: Maybe ByteString scanCount :: Maybe Integer

Instances

Instances details

Show ScanOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ScanOpts -> ShowS # show :: ScanOpts -> String # showList :: [ScanOpts] -> ShowS #
Eq ScanOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ScanOpts -> ScanOpts -> Bool # (/=) :: ScanOpts -> ScanOpts -> Bool #

defaultScanOpts :: ScanOpts Source #

Redis default ScanOpts. Equivalent to omitting all optional parameters.

ScanOpts
    { scanMatch = Nothing -- don't match any pattern
    , scanCount = Nothing -- don't set any requirements on number elements returned (works like value COUNT 10)
    }

scanOpts Source #

Arguments

:: RedisCtx m f
=> Cursor
-> ScanOpts
-> Maybe ByteString	types of the object to scan
-> m (f (Cursor, [ByteString]))	next cursor and values

Incrementally iterate the keys space (http://redis.io/commands/scan). The Redis command SCAN is split up into scan, scanOpts. Since Redis 2.8.0

addScanOpts Source #

Arguments

:: [ByteString]	main part of scan command
-> ScanOpts
-> [ByteString]

sscan Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> m (f (Cursor, [ByteString]))	next cursor and values

Incrementally iterate Set elements (http://redis.io/commands/sscan). The Redis command SSCAN is split up into sscan, sscanOpts. Since Redis 2.8.0

sscanOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> ScanOpts
-> m (f (Cursor, [ByteString]))	next cursor and values

Incrementally iterate Set elements (http://redis.io/commands/sscan). The Redis command SSCAN is split up into sscan, sscanOpts. Since Redis 2.8.0

hscan Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> m (f (Cursor, [(ByteString, ByteString)]))	next cursor and values

Incrementally iterate hash fields and associated values (http://redis.io/commands/hscan). The Redis command HSCAN is split up into hscan, hscanOpts. Since Redis 2.8.0

hscanOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> ScanOpts
-> m (f (Cursor, [(ByteString, ByteString)]))	next cursor and values

Incrementally iterate hash fields and associated values (http://redis.io/commands/hscan). The Redis command HSCAN is split up into hscan, hscanOpts. Since Redis 2.8.0

hrandfield :: RedisCtx m f => ByteString -> m (f (Maybe ByteString)) Source #

Returns a random field from a hash (https://redis.io/commands/hrandfield).

O(1)

Since Redis 6.2.0

hrandfieldCount :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString]) Source #

Returns one or more random fields from a hash (https://redis.io/commands/hrandfield).

O(N) where N is the number of fields returned.

If the provided count argument is positive, return an array of distinct fields. The array's length is either count or the hash's number of fields (HLEN), whichever is lower.

If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Since Redis 6.2.0

hrandfieldCountWithValues :: RedisCtx m f => ByteString -> Integer -> m (f [(ByteString, ByteString)]) Source #

Returns one or more random fields and their values from a hash (https://redis.io/commands/hrandfield).

O(N) where N is the number of fields returned.

If the provided count argument is positive, return an array of distinct fields. The array's length is either count or the hash's number of fields (HLEN), whichever is lower.

If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Since Redis 6.2.0

zscan Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> m (f (Cursor, [(ByteString, Double)]))	next cursor and values

zscanOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Cursor
-> ScanOpts
-> m (f (Cursor, [(ByteString, Double)]))	next cursor and values

data RangeLex a Source #

Constructors

Incl a
Excl a
Minr
Maxr

Instances

Instances details

Show a => Show (RangeLex a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> RangeLex a -> ShowS # show :: RangeLex a -> String # showList :: [RangeLex a] -> ShowS #
Eq a => Eq (RangeLex a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: RangeLex a -> RangeLex a -> Bool # (/=) :: RangeLex a -> RangeLex a -> Bool #
RedisArg a => RedisArg (RangeLex a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: RangeLex a -> ByteString Source #

zrangebylex Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> RangeLex ByteString	min
-> RangeLex ByteString	max
-> m (f [ByteString])

Return a range of members in a sorted set, by lexicographical range (http://redis.io/commands/zrangebylex). Since Redis 2.8.9

zrangebylexLimit Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> RangeLex ByteString	min
-> RangeLex ByteString	max
-> Integer	offset
-> Integer	count
-> m (f [ByteString])

data ZPopMinMax Source #

Constructors

ZPopMin
ZPopMax

Instances

Instances details

Show ZPopMinMax Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZPopMinMax -> ShowS # show :: ZPopMinMax -> String # showList :: [ZPopMinMax] -> ShowS #
Eq ZPopMinMax Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZPopMinMax -> ZPopMinMax -> Bool # (/=) :: ZPopMinMax -> ZPopMinMax -> Bool #
RedisArg ZPopMinMax Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: ZPopMinMax -> ByteString Source #

data ZPopResponse Source #

Constructors

ZPopResponse
Fields zPopResponseKey :: Maybe ByteString zPopResponseValues :: [(ByteString, Double)]

Instances

Instances details

Show ZPopResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZPopResponse -> ShowS # show :: ZPopResponse -> String # showList :: [ZPopResponse] -> ShowS #
Eq ZPopResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZPopResponse -> ZPopResponse -> Bool # (/=) :: ZPopResponse -> ZPopResponse -> Bool #
RedisResult ZPopResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ZPopResponse Source #

zmpop :: RedisCtx m f => NonEmpty ByteString -> ZPopMinMax -> m (f (Maybe ZPopResponse)) Source #

Removes and returns member-score pairs from the first non-empty sorted set from a list of keys (https://redis.io/commands/zmpop).

O(K) + O(Mlog(N)) where K is the number of provided keys, N is the number of elements in the sorted set, and M is the number of elements popped.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

zmpopCount :: RedisCtx m f => NonEmpty ByteString -> ZPopMinMax -> Integer -> m (f (Maybe ZPopResponse)) Source #

Removes and returns member-score pairs from the first non-empty sorted set from a list of keys (https://redis.io/commands/zmpop).

O(K) + O(Mlog(N)) where K is the number of provided keys, N is the number of elements in the sorted set, and M is the number of elements popped.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

bzmpop :: RedisCtx m f => Double -> NonEmpty ByteString -> ZPopMinMax -> m (f (Maybe ZPopResponse)) Source #

Removes and returns member-score pairs from the first non-empty sorted set from a list of keys, or blocks until one is available (https://redis.io/commands/bzmpop).

O(K) + O(Mlog(N)) where K is the number of provided keys, N is the number of elements in the sorted set, and M is the number of elements popped.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

bzmpopCount :: RedisCtx m f => Double -> NonEmpty ByteString -> ZPopMinMax -> Integer -> m (f (Maybe ZPopResponse)) Source #

Removes and returns member-score pairs from the first non-empty sorted set from a list of keys, or blocks until one is available (https://redis.io/commands/bzmpop).

O(K) + O(Mlog(N)) where K is the number of provided keys, N is the number of elements in the sorted set, and M is the number of elements popped.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

zmscore :: RedisCtx m f => ByteString -> NonEmpty ByteString -> m (f [Maybe Double]) Source #

Returns the score of one or more members in a sorted set (https://redis.io/commands/zmscore).

O(N) where N is the number of members being requested.

Since Redis 6.2.0

zrandmember :: RedisCtx m f => ByteString -> m (f (Maybe ByteString)) Source #

Returns a random member from a sorted set (https://redis.io/commands/zrandmember).

O(1) without the optional count argument.

Since Redis 6.2.0

zrandmemberN :: RedisCtx m f => ByteString -> Integer -> m (f [ByteString]) Source #

Returns one or more random members from a sorted set (https://redis.io/commands/zrandmember).

O(N) where N is the number of members returned.

Since Redis 6.2.0

zrandmemberWithscores :: RedisCtx m f => ByteString -> Integer -> m (f [(ByteString, Double)]) Source #

Returns one or more random members and their scores from a sorted set (https://redis.io/commands/zrandmember).

O(N) where N is the number of members returned.

Since Redis 6.2.0

data ZRangeStoreRange Source #

Constructors

ZRangeStoreByIndex Integer Integer
ZRangeStoreByScore Double Double
ZRangeStoreByLex (RangeLex ByteString) (RangeLex ByteString)

Instances

Instances details

Show ZRangeStoreRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZRangeStoreRange -> ShowS # show :: ZRangeStoreRange -> String # showList :: [ZRangeStoreRange] -> ShowS #
Eq ZRangeStoreRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZRangeStoreRange -> ZRangeStoreRange -> Bool # (/=) :: ZRangeStoreRange -> ZRangeStoreRange -> Bool #

data ZRangeStoreOpts Source #

Constructors

ZRangeStoreOpts
Fields zRangeStoreRev :: Bool zRangeStoreLimit :: Maybe (Integer, Integer)

Instances

Instances details

Show ZRangeStoreOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ZRangeStoreOpts -> ShowS # show :: ZRangeStoreOpts -> String # showList :: [ZRangeStoreOpts] -> ShowS #
Eq ZRangeStoreOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ZRangeStoreOpts -> ZRangeStoreOpts -> Bool # (/=) :: ZRangeStoreOpts -> ZRangeStoreOpts -> Bool #

defaultZRangeStoreOpts :: ZRangeStoreOpts Source #

zrangestore :: RedisCtx m f => ByteString -> ByteString -> Integer -> Integer -> m (f Integer) Source #

Stores a range of members from a sorted set in a destination key (https://redis.io/commands/zrangestore).

O(log(N) + M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key.

Since Redis 6.2.0

zrangestoreOpts :: RedisCtx m f => ByteString -> ByteString -> ZRangeStoreRange -> ZRangeStoreOpts -> m (f Integer) Source #

Stores a range of members from a sorted set in a destination key (https://redis.io/commands/zrangestore).

O(log(N) + M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key.

Since Redis 6.2.0

zRangeStoreRangeArgs :: ZRangeStoreRange -> [ByteString] Source #

zRangeStoreOptsArgs :: ZRangeStoreOpts -> [ByteString] Source #

data TrimStrategy Source #

Trimming strategy.

Since: 0.16.0

Constructors

TrimMaxlen Integer

Evicts entries as long as the stream's length exceeds the specified threshold, where threshold is a positive integer.

TrimMinId ByteString

Evicts entries with IDs lower than threshold, where threshold is a stream ID.

Since Redis 6.2: will fail if used on ealier versions.

data TrimType Source #

Type of the trimming.

Since: 0.16.0

Constructors

TrimExact

Exact trimming

TrimApprox (Maybe Integer)

Approximate trimming. Is faster, but may leave slightly more elements in the stream if they can't be immediately deleted.

Additional parameter Specifies the maximal count of entries that will be evicted. When LIMIT and count aren't specified, the default value of 100 * the number of entries in a macro node will be implicitly used as the count, Just 0 removes the limit entirely.

data TrimOpts Source #

Constructors

TrimOpts
Fields trimOptsStrategy :: TrimStrategy trimOptsType :: TrimType

internalTrimArgToList :: TrimOpts -> [ByteString] Source #

Converts trim options to the low level parameters

trimOpts :: TrimStrategy -> TrimType -> TrimOpts Source #

data XAddOpts Source #

Constructors

XAddOpts
Fields xAddTrimOpts :: Maybe TrimOpts Call XTRIM right after XADD xAddnoMkStream :: Bool Don't create a new stream if it doesn't exist @since Redis 6.2

defaultXAddOpts :: XAddOpts Source #

xaddOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Message ID
-> [(ByteString, ByteString)]	Message data (field, value)
-> XAddOpts	Additional parameteers
-> m (f ByteString)	ID of the added entry.

Add a value to a stream (https://redis.io/commands/xadd). The Redis command XADD is split up into xadd, xaddOpts. Since Redis 5.0.0

xadd Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name
-> ByteString	Message id
-> [(ByteString, ByteString)]	Message data (field, value)
-> m (f ByteString)

O(1) Adds a value to a stream (https://redis.io/commands/xadd). Since Redis 5.0.0

newtype XAutoclaimOpts Source #

Additional parameters.

Constructors

XAutoclaimOpts
Fields xAutoclaimCount :: Maybe Integer The upper limit of the number of entries that the command attempts to claim (default: 100).

defaultXAutoclaimOpts :: XAutoclaimOpts Source #

Default XAutoclaimOpts value.

Prefer to use this function over direct use of constructor to preserve backwards compatibility.

Defaults to [Count 100)

data XAutoclaimResult resultFormat Source #

Result of the xautoclaim family of calls

Constructors

XAutoclaimResult
Fields xAutoclaimResultId :: ByteString ID of message that should be used in the next `xautoclaim` call as a start parameter. xAutoclaimClaimedMessages :: [resultFormat] List of succesfully claimed messages. xAutoclaimDeletedMessages :: [ByteString] List of the messages that are available in the PEL but already deleted from the stream.

Instances

Instances details

Show resultFormat => Show (XAutoclaimResult resultFormat) Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XAutoclaimResult resultFormat -> ShowS # show :: XAutoclaimResult resultFormat -> String # showList :: [XAutoclaimResult resultFormat] -> ShowS #
Eq resultFormat => Eq (XAutoclaimResult resultFormat) Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XAutoclaimResult resultFormat -> XAutoclaimResult resultFormat -> Bool # (/=) :: XAutoclaimResult resultFormat -> XAutoclaimResult resultFormat -> Bool #
RedisResult a => RedisResult (XAutoclaimResult a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply (XAutoclaimResult a) Source #

type XAutoclaimStreamsResult = XAutoclaimResult StreamsRecord Source #

Version of the autoclaim result that contains data of the messages.

type XAutoclaimJustIdsResult = XAutoclaimResult ByteString Source #

Version of the autoclaim result that contains only IDs.

xautoclaim Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Consumer name.
-> Integer	Min idle time (ms).
-> ByteString	ID of the message to start.
-> m (f XAutoclaimStreamsResult)

O(1) Transfers ownership of pending stream entries that match the specified criteria. The message should be pending for more than <min-idle-time> milliseconds and ID should be greater than <start>.

XAUTOCLAIM <stream name> <consumer group name> <min idle time> <start>

This version of function claims no more than 100 mesages, use xautoclaimOpt to override this behavior.

Since Redis 7.0: fails on ealier versions.

xautoclaimOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Consumer name.
-> Integer	min idle time (ms).
-> ByteString	start ID.
-> XAutoclaimOpts	Additional parameters.
-> m (f XAutoclaimStreamsResult)

O(1) if count is small. Transfers ownership of pending stream entries that match the specified criteria. See xautoclaim for details.

Allows to pass additional optional parameters to set limit.

XAUTOCLAIM <stream name> <consumer group name> <min idle time> <start> COUNT <count>

Since Redis 7.0: fails on the ealier versions.

xautoclaimJustIds Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Consumer name.
-> Integer	Min idle time (ms).
-> ByteString	start ID.
-> m (f XAutoclaimJustIdsResult)

O(1) Transfers ownership of pending stream entries that match the specified criteria. See xautoclaim for more details about criteria.

This variant returns only id of the messages without data. This method claims no more than 100 messages, see xautoclaimJustIdsOpts for changing this default.

XAUTOCLAIM <stream name> <consumer group name> <min idle time> <start> JUSTID

Since Redis 7.0: fails on the ealier versions.

xautoclaimJustIdsOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumers group name.
-> ByteString	Consumer namee.
-> Integer	min idle time (ms).
-> ByteString	Start ID.
-> XAutoclaimOpts	Additional parametres.
-> m (f XAutoclaimJustIdsResult)

O(1) if count is small Transfers ownership of pending stream entries that match the specified criteria. See xautoclaim for more details about criteria.

This variant returns only id of the messages without data and allows to set the maximum number of messages to be claimed.

XAUTOCLAIM <stream name> <consumer group name> <min idle time> <start> COUNT <count> JUSTID

Since Redis 7.0: fails on the ealier versions.

data StreamsRecord Source #

Constructors

StreamsRecord
Fields recordId :: ByteString keyValues :: [(ByteString, ByteString)]

Instances

Instances details

Show StreamsRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> StreamsRecord -> ShowS # show :: StreamsRecord -> String # showList :: [StreamsRecord] -> ShowS #
Eq StreamsRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: StreamsRecord -> StreamsRecord -> Bool # (/=) :: StreamsRecord -> StreamsRecord -> Bool #
RedisResult StreamsRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply StreamsRecord Source #

data XReadOpts Source #

Constructors

XReadOpts
Fields block :: Maybe Integer recordCount :: Maybe Integer

Instances

Instances details

Show XReadOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XReadOpts -> ShowS # show :: XReadOpts -> String # showList :: [XReadOpts] -> ShowS #
Eq XReadOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XReadOpts -> XReadOpts -> Bool # (/=) :: XReadOpts -> XReadOpts -> Bool #

defaultXreadOpts :: XReadOpts Source #

Redis default XReadOpts. Equivalent to omitting all optional parameters.

XReadOpts
    { block = Nothing -- Don't block waiting for more records
    , recordCount    = Nothing   -- no record count
    }

data XReadResponse Source #

Constructors

XReadResponse
Fields stream :: ByteString records :: [StreamsRecord]

Instances

Instances details

Show XReadResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XReadResponse -> ShowS # show :: XReadResponse -> String # showList :: [XReadResponse] -> ShowS #
Eq XReadResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XReadResponse -> XReadResponse -> Bool # (/=) :: XReadResponse -> XReadResponse -> Bool #
RedisResult XReadResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XReadResponse Source #

xreadOpts Source #

Arguments

:: RedisCtx m f
=> [(ByteString, ByteString)]	(stream, id) pairs
-> XReadOpts	Options
-> m (f (Maybe [XReadResponse]))

Read values from a stream (https://redis.io/commands/xread). The Redis command XREAD is split up into xread, xreadOpts. Since Redis 5.0.0

internalXreadArgs :: [(ByteString, ByteString)] -> XReadOpts -> [ByteString] Source #

xread Source #

Arguments

:: RedisCtx m f
=> [(ByteString, ByteString)]	(stream, id) pairs
-> m (f (Maybe [XReadResponse]))

Read values from a stream (https://redis.io/commands/xread). The Redis command XREAD is split up into xread, xreadOpts. Since Redis 5.0.0

data XReadGroupOpts Source #

Constructors

XReadGroupOpts
Fields xReadGroupBlock :: Maybe Integer xReadGroupCount :: Maybe Integer xReadGroupNoAck :: Bool

Instances

Instances details

Show XReadGroupOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XReadGroupOpts -> ShowS # show :: XReadGroupOpts -> String # showList :: [XReadGroupOpts] -> ShowS #
Eq XReadGroupOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XReadGroupOpts -> XReadGroupOpts -> Bool # (/=) :: XReadGroupOpts -> XReadGroupOpts -> Bool #

defaultXReadGroupOpts :: XReadGroupOpts Source #

xreadGroupOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	group name
-> ByteString	consumer name
-> [(ByteString, ByteString)]	(stream, id) pairs
-> XReadGroupOpts	Options
-> m (f (Maybe [XReadResponse]))

xreadGroup Source #

Arguments

:: RedisCtx m f
=> ByteString	group name
-> ByteString	consumer name
-> [(ByteString, ByteString)]	(stream, id) pairs
-> m (f (Maybe [XReadResponse]))

data XGroupCreateOpts Source #

Additional parameters of the XGroupCreate

Constructors

XGroupCreateOpts

Fields

xGroupCreateMkStream :: Bool
If a stream does not exist, create it automatically with length of 0
xGroupCreateEntriesRead :: Maybe ByteString
Enable consumer group lag tracking, specify an arbitrary ID. An arbitrary ID is any ID that isn't the ID of the stream's first entry, last entry, or zero ("0-0") ID. Use it to find out how many entries are between the arbitrary ID (excluding it) and the stream's last entry.
Since Redis 7.0, fails if set on the ealier versions.

Instances

Instances details

Show XGroupCreateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XGroupCreateOpts -> ShowS # show :: XGroupCreateOpts -> String # showList :: [XGroupCreateOpts] -> ShowS #
Eq XGroupCreateOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XGroupCreateOpts -> XGroupCreateOpts -> Bool # (/=) :: XGroupCreateOpts -> XGroupCreateOpts -> Bool #

defaultXGroupCreateOpts :: XGroupCreateOpts Source #

Specifies default group opts.

Prefer using this method over use of constructor to preserve backwards compatibility.

xgroupCreate Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	ID of the message to start reading with.
-> m (f Status)

O(1) Creates consumer group.

Fails if called on with the stream name that does not exist, use xgroupCreateOpts to override this behavior.

xgroupCreateOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	ID of the message to start reading with.
-> XGroupCreateOpts	Additional parameters.
-> m (f Status)

O(1) Creates consumer group, accepts additional parameters.

xgroupCreateConsumer Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Consumer name.
-> m (f Bool)	Returns if the consumer was created or not.

O(1) Creates new consumer in the consumers group.

Since redis 6.2.0: fails on the ealier versions.

xgroupSetId Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumr group name.
-> ByteString	Message ID or `$`
-> m (f Status)

O(1) Sets last delivered id for a consumer group.

newtype XGroupSetIdOpts Source #

Additional parameters for the xgroupSetId method

Constructors

XGroupSetIdOpts
Fields xGroupSetIdEntriesRead :: Maybe ByteString Enable consumer group lag tracking for an arbitrary ID. An arbitrary ID is any ID that isn't the ID of the stream's first entry, its last entry or the zero (`"0-0"`) ID @since Redis 7.0, fails if set to Just on ealier versions.

defaultXGroupSetIdOpts :: XGroupSetIdOpts Source #

Default value for the XGroupSetIdOpts.

Prefer use this method over the raw constructor in order to preserve backwards compatibility.

xgroupSetIdOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Message id or @$S
-> XGroupSetIdOpts	Additional parameters.
-> m (f Status)

O(1) a variant of the xgroupSetId that allowes to pass additional parameters.

xgroupDelConsumer Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	Consumer name.
-> m (f Integer)	The number of pending messages owned by the consumer.

O(1) Delete consumer.

xgroupDestroy Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> m (f Bool)	Tells if the group was destroyed or not.

O(1) destroys a group.

data XRefPolicy Source #

Constructors

XRefPolicyKeepRef	Deletes the specified entries from the stream, but preserves existing references to these entries in all consumer groups
XRefPolicyDelRef	Deletes the specified entries from the stream and also removes all references to these entries from all consumer groups' pending entry lists, effectively cleaning up all traces of the messages. If an entry ID is not in the stream, but there are dangling references, XDELEX with DELREF would still remove all those references.
XRefPolicyAcked	Deletes the specified entries from the stream only if they have been acknowledged by all consumer groups.

Instances

Instances details

Show XRefPolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XRefPolicy -> ShowS # show :: XRefPolicy -> String # showList :: [XRefPolicy] -> ShowS #
Eq XRefPolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XRefPolicy -> XRefPolicy -> Bool # (/=) :: XRefPolicy -> XRefPolicy -> Bool #
RedisArg XRefPolicy Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: XRefPolicy -> ByteString Source #

data XEntryDeletionOpts Source #

Constructors

XEntryDeletionOpts
Fields xEntryDeletionRefPolicy :: XRefPolicy

Instances

Instances details

Show XEntryDeletionOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XEntryDeletionOpts -> ShowS # show :: XEntryDeletionOpts -> String # showList :: [XEntryDeletionOpts] -> ShowS #
Eq XEntryDeletionOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XEntryDeletionOpts -> XEntryDeletionOpts -> Bool # (/=) :: XEntryDeletionOpts -> XEntryDeletionOpts -> Bool #

defaultXEntryDeletionOpts :: XEntryDeletionOpts Source #

data XCfgSetOpts Source #

Constructors

XCfgSetOpts
Fields xCfgSetIdmpDuration :: Maybe Integer The duration in seconds that each idempotent ID is retained. xCfgSetIdmpMaxsize :: Maybe Integer The maximum number of idempotent IDs tracked per producer.

Instances

Instances details

Show XCfgSetOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XCfgSetOpts -> ShowS # show :: XCfgSetOpts -> String # showList :: [XCfgSetOpts] -> ShowS #
Eq XCfgSetOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XCfgSetOpts -> XCfgSetOpts -> Bool # (/=) :: XCfgSetOpts -> XCfgSetOpts -> Bool #

defaultXCfgSetOpts :: XCfgSetOpts Source #

Redis default XCfgSetOpts. Equivalent to omitting all optional parameters.

At least one field must be set before calling xcfgset.

data XNackMode Source #

Constructors

XNackSilent
XNackFail
XNackFatal

Instances

Instances details

Show XNackMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XNackMode -> ShowS # show :: XNackMode -> String # showList :: [XNackMode] -> ShowS #
Eq XNackMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XNackMode -> XNackMode -> Bool # (/=) :: XNackMode -> XNackMode -> Bool #
RedisArg XNackMode Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: XNackMode -> ByteString Source #

data XNackOpts Source #

Constructors

XNackOpts
Fields xNackRetryCount :: Maybe Integer xNackForce :: Bool

Instances

Instances details

Show XNackOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XNackOpts -> ShowS # show :: XNackOpts -> String # showList :: [XNackOpts] -> ShowS #
Eq XNackOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XNackOpts -> XNackOpts -> Bool # (/=) :: XNackOpts -> XNackOpts -> Bool #

defaultXNackOpts :: XNackOpts Source #

Redis default XNackOpts. Equivalent to omitting all optional parameters.

data XEntryDeletionResult Source #

Constructors

XEntryDeletionResultNotFound
XEntryDeletionResultDeleted
XEntryDeletionResultNotDeleted

Instances

Instances details

Show XEntryDeletionResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XEntryDeletionResult -> ShowS # show :: XEntryDeletionResult -> String # showList :: [XEntryDeletionResult] -> ShowS #
Eq XEntryDeletionResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XEntryDeletionResult -> XEntryDeletionResult -> Bool # (/=) :: XEntryDeletionResult -> XEntryDeletionResult -> Bool #
RedisResult XEntryDeletionResult Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XEntryDeletionResult Source #

xEntryDeletionOptsToArgs :: XEntryDeletionOpts -> [ByteString] Source #

xEntryIdsBlockArgs :: NonEmpty ByteString -> [ByteString] Source #

xack Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> ByteString	group name
-> [ByteString]	message IDs
-> m (f Integer)

xackdel Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> NonEmpty ByteString	Entry IDs.
-> m (f [XEntryDeletionResult])

Acknowledges and conditionally deletes entries for a consumer group (https://redis.io/commands/xackdel).

O(1) for each entry ID processed.

Since Redis 8.2.0

xackdelOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> NonEmpty ByteString	Entry IDs.
-> XEntryDeletionOpts	Additional options.
-> m (f [XEntryDeletionResult])

Acknowledges and conditionally deletes entries for a consumer group (https://redis.io/commands/xackdel).

O(1) for each entry ID processed.

Since Redis 8.2.0

xrange Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> ByteString	start
-> ByteString	end
-> Maybe Integer	COUNT
-> m (f [StreamsRecord])

xrevRange Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> ByteString	end
-> ByteString	start
-> Maybe Integer	COUNT
-> m (f [StreamsRecord])

xlen Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> m (f Integer)

data XPendingSummaryResponse Source #

Constructors

XPendingSummaryResponse
Fields numPendingMessages :: Integer smallestPendingMessageId :: ByteString largestPendingMessageId :: ByteString numPendingMessagesByconsumer :: [(ByteString, Integer)]

Instances

Instances details

Show XPendingSummaryResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XPendingSummaryResponse -> ShowS # show :: XPendingSummaryResponse -> String # showList :: [XPendingSummaryResponse] -> ShowS #
Eq XPendingSummaryResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XPendingSummaryResponse -> XPendingSummaryResponse -> Bool # (/=) :: XPendingSummaryResponse -> XPendingSummaryResponse -> Bool #
RedisResult XPendingSummaryResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XPendingSummaryResponse Source #

xpendingSummary Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Stream consumer group.
-> m (f XPendingSummaryResponse)

O(N) N - number of message beign returned.

Get information about pending messages (https:/redis.iocommands/xpending).

Since Redis 5.0.

data XPendingDetailRecord Source #

Details about message returned by the xpendingDetails

Constructors

XPendingDetailRecord
Fields messageId :: ByteString consumer :: ByteString millisSinceLastDelivered :: Integer numTimesDelivered :: Integer

Instances

Instances details

Show XPendingDetailRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XPendingDetailRecord -> ShowS # show :: XPendingDetailRecord -> String # showList :: [XPendingDetailRecord] -> ShowS #
Eq XPendingDetailRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XPendingDetailRecord -> XPendingDetailRecord -> Bool # (/=) :: XPendingDetailRecord -> XPendingDetailRecord -> Bool #
RedisResult XPendingDetailRecord Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XPendingDetailRecord Source #

data XPendingDetailOpts Source #

Additional parameters of the xpending call family

Constructors

XPendingDetailOpts
Fields xPendingDetailConsumer :: Maybe ByteString Fetch the messages having a specific owner. xPendingDetailIdle :: Maybe Integer Filter pending stream entries by their idle-time, ms Since Redis 6.2: Just values will fail

defaultXPendingDetailOpts :: XPendingDetailOpts Source #

Default XPendingOpts values.

Prefer this method over use of the constructor in order to preserve backwards compatibility.

xpendingDetail Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Consumer group name.
-> ByteString	ID of the first interesting message.
-> ByteString	ID of the last intersting message.
-> Integer	Limits the numbere of messages returned from the call.
-> XPendingDetailOpts
-> m (f [XPendingDetailRecord])

O(N) N - number of messages returned.

Get detailed information about pending messages (https:/redis.iocommands/xpending).

data XClaimOpts Source #

Constructors

XClaimOpts
Fields xclaimIdle :: Maybe Integer xclaimTime :: Maybe Integer xclaimRetryCount :: Maybe Integer xclaimForce :: Bool

Instances

Instances details

Show XClaimOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XClaimOpts -> ShowS # show :: XClaimOpts -> String # showList :: [XClaimOpts] -> ShowS #
Eq XClaimOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XClaimOpts -> XClaimOpts -> Bool # (/=) :: XClaimOpts -> XClaimOpts -> Bool #

defaultXClaimOpts :: XClaimOpts Source #

xclaimRequest Source #

Arguments

:: ByteString	stream
-> ByteString	group
-> ByteString	consumer
-> Integer	min idle time
-> XClaimOpts	optional arguments
-> [ByteString]	message IDs
-> [ByteString]

Format a request for XCLAIM.

xclaim Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> ByteString	group
-> ByteString	consumer
-> Integer	min idle time
-> XClaimOpts	optional arguments
-> [ByteString]	message IDs
-> m (f [StreamsRecord])

xclaimJustIds Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> ByteString	group
-> ByteString	consumer
-> Integer	min idle time
-> XClaimOpts	optional arguments
-> [ByteString]	message IDs
-> m (f [ByteString])

data GeoUnit Source #

Constructors

GeoMeters
GeoKilometers
GeoFeet
GeoMiles

Instances

Instances details

Show GeoUnit Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoUnit -> ShowS # show :: GeoUnit -> String # showList :: [GeoUnit] -> ShowS #
Eq GeoUnit Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoUnit -> GeoUnit -> Bool # (/=) :: GeoUnit -> GeoUnit -> Bool #
RedisArg GeoUnit Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: GeoUnit -> ByteString Source #

data GeoOrder Source #

Constructors

GeoAsc
GeoDesc

Instances

Instances details

Show GeoOrder Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoOrder -> ShowS # show :: GeoOrder -> String # showList :: [GeoOrder] -> ShowS #
Eq GeoOrder Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoOrder -> GeoOrder -> Bool # (/=) :: GeoOrder -> GeoOrder -> Bool #
RedisArg GeoOrder Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: GeoOrder -> ByteString Source #

data GeoCoordinates Source #

Constructors

GeoCoordinates
Fields geoLongitude :: Double geoLatitude :: Double

Instances

Instances details

Show GeoCoordinates Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoCoordinates -> ShowS # show :: GeoCoordinates -> String # showList :: [GeoCoordinates] -> ShowS #
Eq GeoCoordinates Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoCoordinates -> GeoCoordinates -> Bool # (/=) :: GeoCoordinates -> GeoCoordinates -> Bool #
RedisResult GeoCoordinates Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply GeoCoordinates Source #

data GeoLocation Source #

Constructors

GeoLocation
Fields geoLocationMember :: ByteString geoLocationDist :: Maybe Double geoLocationHash :: Maybe Integer geoLocationCoordinates :: Maybe GeoCoordinates

Instances

Instances details

Show GeoLocation Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoLocation -> ShowS # show :: GeoLocation -> String # showList :: [GeoLocation] -> ShowS #
Eq GeoLocation Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoLocation -> GeoLocation -> Bool # (/=) :: GeoLocation -> GeoLocation -> Bool #
RedisResult GeoLocation Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply GeoLocation Source #

data GeoSearchFrom Source #

Constructors

GeoSearchFromMember ByteString
GeoSearchFromLonLat Double Double

Instances

Instances details

Show GeoSearchFrom Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoSearchFrom -> ShowS # show :: GeoSearchFrom -> String # showList :: [GeoSearchFrom] -> ShowS #
Eq GeoSearchFrom Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoSearchFrom -> GeoSearchFrom -> Bool # (/=) :: GeoSearchFrom -> GeoSearchFrom -> Bool #

data GeoSearchBy Source #

Constructors

GeoSearchByRadius Double GeoUnit
GeoSearchByBox Double Double GeoUnit

Instances

Instances details

Show GeoSearchBy Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoSearchBy -> ShowS # show :: GeoSearchBy -> String # showList :: [GeoSearchBy] -> ShowS #
Eq GeoSearchBy Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoSearchBy -> GeoSearchBy -> Bool # (/=) :: GeoSearchBy -> GeoSearchBy -> Bool #

data GeoSearchOpts Source #

Constructors

GeoSearchOpts
Fields geoSearchWithCoord :: Bool geoSearchWithDist :: Bool geoSearchWithHash :: Bool geoSearchCount :: Maybe Integer geoSearchCountAny :: Bool geoSearchOrder :: Maybe GeoOrder

Instances

Instances details

Show GeoSearchOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoSearchOpts -> ShowS # show :: GeoSearchOpts -> String # showList :: [GeoSearchOpts] -> ShowS #
Eq GeoSearchOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoSearchOpts -> GeoSearchOpts -> Bool # (/=) :: GeoSearchOpts -> GeoSearchOpts -> Bool #

defaultGeoSearchOpts :: GeoSearchOpts Source #

data GeoSearchStoreOpts Source #

Constructors

GeoSearchStoreOpts
Fields geoSearchStoreCount :: Maybe Integer geoSearchStoreCountAny :: Bool geoSearchStoreOrder :: Maybe GeoOrder geoSearchStoreStoredist :: Bool

Instances

Instances details

Show GeoSearchStoreOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoSearchStoreOpts -> ShowS # show :: GeoSearchStoreOpts -> String # showList :: [GeoSearchStoreOpts] -> ShowS #
Eq GeoSearchStoreOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoSearchStoreOpts -> GeoSearchStoreOpts -> Bool # (/=) :: GeoSearchStoreOpts -> GeoSearchStoreOpts -> Bool #

defaultGeoSearchStoreOpts :: GeoSearchStoreOpts Source #

data GeoAddOpts Source #

Adds one or more members to a geospatial index (https://redis.io/commands/geoadd). The Redis command GEOADD is split up into geoadd and geoAddOpts. Since Redis 3.2.0

Constructors

GeoAddOpts
Fields geoAddCondition :: Maybe Condition geoAddChange :: Bool Modify the return value from the number of new elements added, to the number of elements changed. Since Redis 6.2.0

Instances

Instances details

Show GeoAddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> GeoAddOpts -> ShowS # show :: GeoAddOpts -> String # showList :: [GeoAddOpts] -> ShowS #
Eq GeoAddOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: GeoAddOpts -> GeoAddOpts -> Bool # (/=) :: GeoAddOpts -> GeoAddOpts -> Bool #

defaultGeoAddOpts :: GeoAddOpts Source #

Redis default GeoAddOpts. Equivalent to omitting all optional parameters.

geoadd :: RedisCtx m f => ByteString -> [(Double, Double, ByteString)] -> m (f Integer) Source #

Adds one or more members to a geospatial index (https://redis.io/commands/geoadd). The Redis command GEOADD is split up into geoadd and geoAddOpts.

Note: there is no geodel command because you can use zrem to remove elements. The Geo index structure is just a sorted set.

Since Redis 3.2.0

Redis tags: write, geo, slow

geoaddOpts :: RedisCtx m f => ByteString -> [(Double, Double, ByteString)] -> GeoAddOpts -> m (f Integer) Source #

Adds one or more members to a geospatial index (https://redis.io/commands/geoadd). The Redis command GEOADD is split up into geoadd and geoAddOpts.

Since Redis 6.2.0

geodist :: RedisCtx m f => ByteString -> ByteString -> ByteString -> Maybe GeoUnit -> m (f (Maybe Double)) Source #

Returns the distance between two members of a geospatial index (https://redis.io/commands/geodist). Since Redis 3.2.0

Redis tags: read, geo, slow

geopos :: RedisCtx m f => ByteString -> [ByteString] -> m (f [Maybe GeoCoordinates]) Source #

Returns the longitude and latitude of members from a geospatial index (https://redis.io/commands/geopos). Since Redis 3.2.0

ACL categories: read, geo, @slow.

geoSearch :: RedisCtx m f => ByteString -> GeoSearchFrom -> GeoSearchBy -> GeoSearchOpts -> m (f [GeoLocation]) Source #

Queries a geospatial index for members inside an area of a box or a circle (https://redis.io/commands/geosearch). Since Redis 6.2.0

O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape

ACL: read, geo, @slow

Since: Redis 6.2.0

geoSearchStore :: RedisCtx m f => ByteString -> ByteString -> GeoSearchFrom -> GeoSearchBy -> GeoSearchStoreOpts -> m (f Integer) Source #

Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result (https://redis.io/commands/geosearchstore). Since Redis 6.2.0

geoSearchFromArgs :: GeoSearchFrom -> [ByteString] Source #

geoSearchByArgs :: GeoSearchBy -> [ByteString] Source #

geoSearchOptsArgs :: GeoSearchOpts -> [ByteString] Source #

geoSearchStoreOptsArgs :: GeoSearchStoreOpts -> [ByteString] Source #

data XInfoConsumersResponse Source #

Data structure that is returned as a result of xinfoConsumers

Constructors

XInfoConsumersResponse

Fields

xinfoConsumerName :: ByteString
The name of the consumer.
xinfoConsumerNumPendingMessages :: Integer
The number of entries in the PEL (pending elemeent list): pending messages for the consumer, which are messages that were delivered but are yet to be acknowledged
xinfoConsumerIdleTime :: Integer
The number of milliseconds that have passed since the consumer's last attempted interaction (Examples: xreadGroup, xclam, xautoclaim)
xinfoConsumerInactive :: Maybe Integer
The number of milliseconds that have passed since the consumer's last successful interaction (Examples: xreadGroup that actually read some entries into the PEL, xclaim/xautoclaim that actually claimed some entries)
since Redis 7.0: always Nothing@ for previous versions.

Instances

Instances details

Show XInfoConsumersResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XInfoConsumersResponse -> ShowS # show :: XInfoConsumersResponse -> String # showList :: [XInfoConsumersResponse] -> ShowS #
Eq XInfoConsumersResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XInfoConsumersResponse -> XInfoConsumersResponse -> Bool # (/=) :: XInfoConsumersResponse -> XInfoConsumersResponse -> Bool #
RedisResult XInfoConsumersResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XInfoConsumersResponse Source #

xinfoConsumers Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> ByteString	Group name.
-> m (f [XInfoConsumersResponse])

O(1) Returns information about the list of the consumers beloging to the consumer group.

Available since Redis 5.0.0

Wrapper over XINFO CONSUMERS <stream name> <group name>

data XInfoGroupsResponse Source #

Result of the xinfoGroups call.

Constructors

XInfoGroupsResponse

Fields

xinfoGroupsGroupName :: ByteString
Name of the consumer group.
xinfoGroupsNumConsumers :: Integer
The number of consumers in the group.
xinfoGroupsNumPendingMessages :: Integer
The length of the group's pending entries list (PEL), which are messages that were delivered but are yet to be acknowledged.
xinfoGroupsLastDeliveredMessageId :: ByteString
The ID of the last entry delivered to the group's consumers.
xinfoGroupsEntriesRead :: Maybe Integer
The logical "read counter" of the last entry delivered to group's consumers.
Since Redis 7.0: always Nothing on the previous versions.
xinfoGroupsLag :: Maybe Integer
the number of entries in the stream that are still waiting to be delivered to the group's consumers, or a Nothing when that number can't be determined.
Since Redis 7.0: always Nothing on the previous versions.

Instances

Instances details

Show XInfoGroupsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XInfoGroupsResponse -> ShowS # show :: XInfoGroupsResponse -> String # showList :: [XInfoGroupsResponse] -> ShowS #
Eq XInfoGroupsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XInfoGroupsResponse -> XInfoGroupsResponse -> Bool # (/=) :: XInfoGroupsResponse -> XInfoGroupsResponse -> Bool #
RedisResult XInfoGroupsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XInfoGroupsResponse Source #

xinfoGroups Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> m (f [XInfoGroupsResponse])

O(1) Returns information about the groups.

Available since: Redis 5.0.0

Wrapper around XINFO GROUPS <stream name> call.

data XInfoStreamResponse Source #

Constructors

XInfoStreamResponse
Fields xinfoStreamLength :: Integer The number of entries in the stream. xinfoStreamRadixTreeKeys :: Integer The number of keys in the underlying radix data structure. xinfoStreamRadixTreeNodes :: Integer The number of nodes in the underlying radix data structure. xinfoMaxDeletedEntryId :: Maybe ByteString The maximal entry ID that was deleted from the stream Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoEntriesAdded :: Maybe Integer The count of all entries added to the stream during its lifetime Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoRecordedFirstEntryId :: Maybe ByteString ID of first recorded entry. Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoStreamNumGroups :: Integer The number of consumer groups defined for the stream. xinfoStreamLastEntryId :: ByteString ID of the last entry in the stream. xinfoStreamFirstEntry :: StreamsRecord ID and field-value tuples of the first entry in the stream. xinfoStreamLastEntry :: StreamsRecord ID and field-value tuples of the last entry in the stream.
XInfoStreamEmptyResponse
Fields xinfoStreamLength :: Integer The number of entries in the stream. xinfoStreamRadixTreeKeys :: Integer The number of keys in the underlying radix data structure. xinfoStreamRadixTreeNodes :: Integer The number of nodes in the underlying radix data structure. xinfoMaxDeletedEntryId :: Maybe ByteString The maximal entry ID that was deleted from the stream Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoEntriesAdded :: Maybe Integer The count of all entries added to the stream during its lifetime Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoRecordedFirstEntryId :: Maybe ByteString ID of first recorded entry. Since Redis 7.0: always returns `Nothing` on the previous versions. xinfoStreamNumGroups :: Integer The number of consumer groups defined for the stream. xinfoStreamLastEntryId :: ByteString ID of the last entry in the stream.

Instances

Instances details

Show XInfoStreamResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> XInfoStreamResponse -> ShowS # show :: XInfoStreamResponse -> String # showList :: [XInfoStreamResponse] -> ShowS #
Eq XInfoStreamResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: XInfoStreamResponse -> XInfoStreamResponse -> Bool # (/=) :: XInfoStreamResponse -> XInfoStreamResponse -> Bool #
RedisResult XInfoStreamResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply XInfoStreamResponse Source #

xinfoStream Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> m (f XInfoStreamResponse)

Get info about a stream. The Redis command XINFO is split into xinfoConsumers, xinfoGroups, and xinfoStream. Since Redis 5.0.0

xdel Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> NonEmpty ByteString	message IDs
-> m (f Integer)

Delete messages from a stream. Since Redis 5.0.0

xdelex Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> NonEmpty ByteString	Entry IDs.
-> m (f [XEntryDeletionResult])

Conditionally deletes entries from a stream (https://redis.io/commands/xdelex).

O(1) for each entry ID processed.

Since Redis 8.2.0

xdelexOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream name.
-> NonEmpty ByteString	Entry IDs.
-> XEntryDeletionOpts	Additional options.
-> m (f [XEntryDeletionResult])

Conditionally deletes entries from a stream (https://redis.io/commands/xdelex).

O(1) for each entry ID processed.

Since Redis 8.2.0

xcfgset Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the stream key. The stream must already exist.
-> XCfgSetOpts	Configuration parameters. At least one of `xCfgSetIdmpDuration` or `xCfgSetIdmpMaxsize` must be specified. Calling `XCFGSET` clears all existing producer IDMP maps for the stream.
-> m (f Status)

Sets the IDMP configuration parameters for a stream (https://redis.io/commands/xcfgset).

O(1)

Since Redis 8.6.0

xidmprecord Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream key.
-> ByteString	Producer ID.
-> ByteString	Idempotency ID.
-> ByteString	Existing stream entry ID.
-> m (f Status)

Sets IDMP metadata on an existing stream message (https://redis.io/commands/xidmprecord).

This is an internal command used during AOF loading.

O(1)

Since Redis 8.6.2

xnack Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream key.
-> ByteString	Consumer group name.
-> XNackMode	Release strategy.
-> NonEmpty ByteString	Stream entry IDs.
-> m (f Integer)

Releases claimed messages back to the group's PEL without acknowledging them (https://redis.io/commands/xnack).

O(1) for each message ID processed.

Since Redis 8.8.0

xnackOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Stream key.
-> ByteString	Consumer group name.
-> XNackMode	Release strategy.
-> NonEmpty ByteString	Stream entry IDs.
-> XNackOpts	Additional options.
-> m (f Integer)

Releases claimed messages back to the group's PEL without acknowledging them (https://redis.io/commands/xnack).

O(1) for each message ID processed.

Since Redis 8.8.0

xtrim Source #

Arguments

:: RedisCtx m f
=> ByteString	stream
-> TrimOpts
-> m (f Integer)

Set the upper bound for number of messages in a stream. Since Redis 5.0.0

inf :: RealFloat a => a Source #

Constructor for inf Redis argument values

data AuthOpts Source #

Additional parameters for the auth command.

Constructors

AuthOpts
Fields authOptsUsername :: Maybe ByteString Username. Since Redis 6.0: fails on earlier

Instances

Instances details

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

defaultAuthOpts :: AuthOpts Source #

Default options for AuthOpts

>>> defaultAuthOpts
AuthOpts {authOptsUsername = Nothing}

auth Source #

Arguments

:: RedisCtx m f
=> ByteString	Password.
-> m (f Status)

O(N) where N is the number of passwords defined for the user.

Authenticates client to the server.

authOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Password.
-> AuthOpts	Additional options.
-> m (f Status)

O(N) where N is the number of passwords defined for the user.

Authenticates client to the server.

This method allows passing additional options.

select Source #

Arguments

:: RedisCtx m f
=> Integer	index
-> m (f Status)

Change the selected database for the current connection (http://redis.io/commands/select). Since Redis 1.0.0

ping :: RedisCtx m f => m (f Status) Source #

Ping the server (http://redis.io/commands/ping). Since Redis 1.0.0

data ClusterInfoResponse Source #

Constructors

ClusterInfoResponse

Fields

clusterInfoResponseState :: ClusterInfoResponseState
clusterInfoResponseSlotsAssigned :: Integer
clusterInfoResponseSlotsOK :: Integer
clusterInfoResponseSlotsPfail :: Integer
clusterInfoResponseSlotsFail :: Integer
clusterInfoResponseKnownNodes :: Integer
clusterInfoResponseSize :: Integer
clusterInfoResponseCurrentEpoch :: Integer
clusterInfoResponseMyEpoch :: Integer
clusterInfoResponseStatsMessagesSent :: Integer
clusterInfoResponseStatsMessagesReceived :: Integer
clusterInfoResponseTotalLinksBufferLimitExceeded :: Integer
clusterInfoResponseStatsMessagesPingSent :: Maybe Integer
clusterInfoResponseStatsMessagesPingReceived :: Maybe Integer
clusterInfoResponseStatsMessagesPongSent :: Maybe Integer
clusterInfoResponseStatsMessagesPongReceived :: Maybe Integer
clusterInfoResponseStatsMessagesMeetSent :: Maybe Integer
clusterInfoResponseStatsMessagesMeetReceived :: Maybe Integer
clusterInfoResponseStatsMessagesFailSent :: Maybe Integer
clusterInfoResponseStatsMessagesFailReceived :: Maybe Integer
clusterInfoResponseStatsMessagesPublishSent :: Maybe Integer
clusterInfoResponseStatsMessagesPublishReceived :: Maybe Integer
clusterInfoResponseStatsMessagesAuthReqSent :: Maybe Integer
clusterInfoResponseStatsMessagesAuthReqReceived :: Maybe Integer
clusterInfoResponseStatsMessagesAuthAckSent :: Maybe Integer
clusterInfoResponseStatsMessagesAuthAckReceived :: Maybe Integer
clusterInfoResponseStatsMessagesUpdateSent :: Maybe Integer
clusterInfoResponseStatsMessagesUpdateReceived :: Maybe Integer
clusterInfoResponseStatsMessagesMfstartSent :: Maybe Integer
clusterInfoResponseStatsMessagesMfstartReceived :: Maybe Integer
clusterInfoResponseStatsMessagesModuleSent :: Maybe Integer
clusterInfoResponseStatsMessagesModuleReceived :: Maybe Integer
clusterInfoResponseStatsMessagesPublishshardSent :: Maybe Integer
clusterInfoResponseStatsMessagesPublishshardReceived :: Maybe Integer

Instances

Instances details

Show ClusterInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterInfoResponse -> ShowS # show :: ClusterInfoResponse -> String # showList :: [ClusterInfoResponse] -> ShowS #
Eq ClusterInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterInfoResponse -> ClusterInfoResponse -> Bool # (/=) :: ClusterInfoResponse -> ClusterInfoResponse -> Bool #
RedisResult ClusterInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterInfoResponse Source #

data ClusterInfoResponseState Source #

Constructors

OK
Down

Instances

Instances details

Show ClusterInfoResponseState Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterInfoResponseState -> ShowS # show :: ClusterInfoResponseState -> String # showList :: [ClusterInfoResponseState] -> ShowS #
Eq ClusterInfoResponseState Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterInfoResponseState -> ClusterInfoResponseState -> Bool # (/=) :: ClusterInfoResponseState -> ClusterInfoResponseState -> Bool #

defClusterInfoResponse :: ClusterInfoResponse Source #

parseClusterInfoResponse :: [[ByteString]] -> ClusterInfoResponse -> Maybe ClusterInfoResponse Source #

clusterInfo :: RedisCtx m f => m (f ClusterInfoResponse) Source #

clusterMyshardid :: RedisCtx m f => m (f ByteString) Source #

Returns the shard ID of a node (https://redis.io/commands/cluster-myshardid).

O(1)

Since Redis 7.2.0

data ClusterNodesResponse Source #

Constructors

ClusterNodesResponse
Fields clusterNodesResponseEntries :: [ClusterNodesResponseEntry]

Instances

Instances details

Show ClusterNodesResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterNodesResponse -> ShowS # show :: ClusterNodesResponse -> String # showList :: [ClusterNodesResponse] -> ShowS #
Eq ClusterNodesResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterNodesResponse -> ClusterNodesResponse -> Bool # (/=) :: ClusterNodesResponse -> ClusterNodesResponse -> Bool #
RedisResult ClusterNodesResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterNodesResponse Source #

data ClusterNodesResponseEntry Source #

Instances

Instances details

Show ClusterNodesResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterNodesResponseEntry -> ShowS # show :: ClusterNodesResponseEntry -> String # showList :: [ClusterNodesResponseEntry] -> ShowS #
Eq ClusterNodesResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterNodesResponseEntry -> ClusterNodesResponseEntry -> Bool # (/=) :: ClusterNodesResponseEntry -> ClusterNodesResponseEntry -> Bool #

data ClusterNodesResponseSlotSpec Source #

Constructors

ClusterNodesResponseSingleSlot Integer
ClusterNodesResponseSlotRange Integer Integer
ClusterNodesResponseSlotImporting Integer ByteString
ClusterNodesResponseSlotMigrating Integer ByteString

Instances

Instances details

Show ClusterNodesResponseSlotSpec Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterNodesResponseSlotSpec -> ShowS # show :: ClusterNodesResponseSlotSpec -> String # showList :: [ClusterNodesResponseSlotSpec] -> ShowS #
Eq ClusterNodesResponseSlotSpec Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterNodesResponseSlotSpec -> ClusterNodesResponseSlotSpec -> Bool # (/=) :: ClusterNodesResponseSlotSpec -> ClusterNodesResponseSlotSpec -> Bool #

clusterNodes :: RedisCtx m f => m (f ClusterNodesResponse) Source #

data ClusterSlotsResponse Source #

Constructors

ClusterSlotsResponse
Fields clusterSlotsResponseEntries :: [ClusterSlotsResponseEntry]

Instances

Instances details

Show ClusterSlotsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotsResponse -> ShowS # show :: ClusterSlotsResponse -> String # showList :: [ClusterSlotsResponse] -> ShowS #
RedisResult ClusterSlotsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterSlotsResponse Source #

data ClusterSlotsNode Source #

Constructors

ClusterSlotsNode
Fields clusterSlotsNodeIP :: ByteString clusterSlotsNodePort :: Int clusterSlotsNodeID :: ByteString

Instances

Instances details

Show ClusterSlotsNode Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotsNode -> ShowS # show :: ClusterSlotsNode -> String # showList :: [ClusterSlotsNode] -> ShowS #
RedisResult ClusterSlotsNode Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterSlotsNode Source #

data ClusterSlotsResponseEntry Source #

Constructors

ClusterSlotsResponseEntry
Fields clusterSlotsResponseEntryStartSlot :: Int clusterSlotsResponseEntryEndSlot :: Int clusterSlotsResponseEntryMaster :: ClusterSlotsNode clusterSlotsResponseEntryReplicas :: [ClusterSlotsNode]

Instances

Instances details

Show ClusterSlotsResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotsResponseEntry -> ShowS # show :: ClusterSlotsResponseEntry -> String # showList :: [ClusterSlotsResponseEntry] -> ShowS #
RedisResult ClusterSlotsResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterSlotsResponseEntry Source #

clusterSlots :: RedisCtx m f => m (f ClusterSlotsResponse) Source #

data ClusterSlotStatsMetric Source #

Constructors

ClusterSlotStatsKeyCount
ClusterSlotStatsCpuUsec
ClusterSlotStatsMemoryBytes
ClusterSlotStatsNetworkBytesIn
ClusterSlotStatsNetworkBytesOut

Instances

Instances details

Show ClusterSlotStatsMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotStatsMetric -> ShowS # show :: ClusterSlotStatsMetric -> String # showList :: [ClusterSlotStatsMetric] -> ShowS #
Eq ClusterSlotStatsMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterSlotStatsMetric -> ClusterSlotStatsMetric -> Bool # (/=) :: ClusterSlotStatsMetric -> ClusterSlotStatsMetric -> Bool #
RedisArg ClusterSlotStatsMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: ClusterSlotStatsMetric -> ByteString Source #

data ClusterSlotStatsOrderByOpts Source #

Constructors

ClusterSlotStatsOrderByOpts
Fields clusterSlotStatsOrderByLimit :: Maybe Integer clusterSlotStatsOrderByDirection :: SortOrder

Instances

Instances details

Show ClusterSlotStatsOrderByOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotStatsOrderByOpts -> ShowS # show :: ClusterSlotStatsOrderByOpts -> String # showList :: [ClusterSlotStatsOrderByOpts] -> ShowS #
Eq ClusterSlotStatsOrderByOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterSlotStatsOrderByOpts -> ClusterSlotStatsOrderByOpts -> Bool # (/=) :: ClusterSlotStatsOrderByOpts -> ClusterSlotStatsOrderByOpts -> Bool #

defaultClusterSlotStatsOrderByOpts :: ClusterSlotStatsOrderByOpts Source #

data ClusterSlotStatsQuery Source #

Constructors

ClusterSlotStatsSlotsRange Integer Integer
ClusterSlotStatsOrderBy ClusterSlotStatsMetric ClusterSlotStatsOrderByOpts

Instances

Instances details

Show ClusterSlotStatsQuery Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotStatsQuery -> ShowS # show :: ClusterSlotStatsQuery -> String # showList :: [ClusterSlotStatsQuery] -> ShowS #
Eq ClusterSlotStatsQuery Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterSlotStatsQuery -> ClusterSlotStatsQuery -> Bool # (/=) :: ClusterSlotStatsQuery -> ClusterSlotStatsQuery -> Bool #

data ClusterSlotStatsResponse Source #

Constructors

ClusterSlotStatsResponse
Fields clusterSlotStatsResponseEntries :: [ClusterSlotStatsResponseEntry]

Instances

Instances details

Show ClusterSlotStatsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotStatsResponse -> ShowS # show :: ClusterSlotStatsResponse -> String # showList :: [ClusterSlotStatsResponse] -> ShowS #
Eq ClusterSlotStatsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterSlotStatsResponse -> ClusterSlotStatsResponse -> Bool # (/=) :: ClusterSlotStatsResponse -> ClusterSlotStatsResponse -> Bool #
RedisResult ClusterSlotStatsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterSlotStatsResponse Source #

data ClusterSlotStatsResponseEntry Source #

Constructors

ClusterSlotStatsResponseEntry
Fields clusterSlotStatsResponseEntrySlot :: Integer clusterSlotStatsResponseEntryKeyCount :: Maybe Integer clusterSlotStatsResponseEntryCpuUsec :: Maybe Integer clusterSlotStatsResponseEntryMemoryBytes :: Maybe Integer clusterSlotStatsResponseEntryNetworkBytesIn :: Maybe Integer clusterSlotStatsResponseEntryNetworkBytesOut :: Maybe Integer

Instances

Instances details

Show ClusterSlotStatsResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterSlotStatsResponseEntry -> ShowS # show :: ClusterSlotStatsResponseEntry -> String # showList :: [ClusterSlotStatsResponseEntry] -> ShowS #
Eq ClusterSlotStatsResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterSlotStatsResponseEntry -> ClusterSlotStatsResponseEntry -> Bool # (/=) :: ClusterSlotStatsResponseEntry -> ClusterSlotStatsResponseEntry -> Bool #
RedisResult ClusterSlotStatsResponseEntry Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterSlotStatsResponseEntry Source #

clusterSlotStats :: RedisCtx m f => ClusterSlotStatsQuery -> m (f ClusterSlotStatsResponse) Source #

clusterSlotStatsSlotsRange :: RedisCtx m f => Integer -> Integer -> m (f ClusterSlotStatsResponse) Source #

clusterSlotStatsOrderBy :: RedisCtx m f => ClusterSlotStatsMetric -> m (f ClusterSlotStatsResponse) Source #

clusterSlotStatsOrderByOpts :: RedisCtx m f => ClusterSlotStatsMetric -> ClusterSlotStatsOrderByOpts -> m (f ClusterSlotStatsResponse) Source #

clusterSlotStatsQueryArgs :: ClusterSlotStatsQuery -> [ByteString] Source #

clusterSetSlotImporting :: RedisCtx m f => Integer -> ByteString -> m (f Status) Source #

clusterSetSlotMigrating :: RedisCtx m f => Integer -> ByteString -> m (f Status) Source #

clusterSetSlotStable :: RedisCtx m f => Integer -> m (f Status) Source #

clusterSetSlotNode :: RedisCtx m f => Integer -> ByteString -> m (f Status) Source #

clusterGetKeysInSlot :: RedisCtx m f => Integer -> Integer -> m (f [ByteString]) Source #

data ClusterMigrationSlotRange Source #

Constructors

ClusterMigrationSlotRange
Fields clusterMigrationSlotRangeStart :: Integer clusterMigrationSlotRangeEnd :: Integer

Instances

Instances details

Show ClusterMigrationSlotRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterMigrationSlotRange -> ShowS # show :: ClusterMigrationSlotRange -> String # showList :: [ClusterMigrationSlotRange] -> ShowS #
Eq ClusterMigrationSlotRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterMigrationSlotRange -> ClusterMigrationSlotRange -> Bool # (/=) :: ClusterMigrationSlotRange -> ClusterMigrationSlotRange -> Bool #

data ClusterMigrationTask Source #

Instances

Instances details

Show ClusterMigrationTask Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterMigrationTask -> ShowS # show :: ClusterMigrationTask -> String # showList :: [ClusterMigrationTask] -> ShowS #
Eq ClusterMigrationTask Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterMigrationTask -> ClusterMigrationTask -> Bool # (/=) :: ClusterMigrationTask -> ClusterMigrationTask -> Bool #
RedisResult ClusterMigrationTask Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterMigrationTask Source #

newtype ClusterMigrationStatusResponse Source #

Constructors

ClusterMigrationStatusResponse
Fields clusterMigrationStatusTasks :: [ClusterMigrationTask]

Instances

Instances details

Show ClusterMigrationStatusResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ClusterMigrationStatusResponse -> ShowS # show :: ClusterMigrationStatusResponse -> String # showList :: [ClusterMigrationStatusResponse] -> ShowS #
Eq ClusterMigrationStatusResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ClusterMigrationStatusResponse -> ClusterMigrationStatusResponse -> Bool # (/=) :: ClusterMigrationStatusResponse -> ClusterMigrationStatusResponse -> Bool #
RedisResult ClusterMigrationStatusResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ClusterMigrationStatusResponse Source #

clusterMigrationImport Source #

Arguments

:: RedisCtx m f

=> NonEmpty (Integer, Integer)

Slot ranges to import.

Execute this subcommand on the destination master. It accepts multiple slot ranges and returns a task ID that can later be used to monitor the migration.

-> m (f ByteString)

Starts an atomic slot migration import task on the current node (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

clusterMigrationCancelId Source #

Arguments

:: RedisCtx m f
=> ByteString	Task identifier.
-> m (f Integer)

Cancels an ongoing migration task by task ID (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

clusterMigrationCancelAll :: RedisCtx m f => m (f Integer) Source #

Cancels all ongoing migration tasks (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

clusterMigrationStatus :: RedisCtx m f => m (f ClusterMigrationStatusResponse) Source #

Returns the status of current and completed atomic slot migration tasks (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

clusterMigrationStatusAll :: RedisCtx m f => m (f ClusterMigrationStatusResponse) Source #

Returns the status of all current and completed atomic slot migration tasks (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

clusterMigrationStatusId Source #

Arguments

:: RedisCtx m f
=> ByteString	Task identifier.
-> m (f ClusterMigrationStatusResponse)

Returns the status of a specific atomic slot migration task (https://redis.io/commands/cluster-migration).

O(N) where N is the total number of slots between the specified start and end slot arguments.

Since Redis 8.4.0

command :: RedisCtx m f => m (f [CommandInfo]) Source #

commandList :: RedisCtx m f => m (f [ByteString]) Source #

Returns a list of command names (https://redis.io/commands/command-list).

O(N) where N is the total number of Redis commands.

Since Redis 7.0.0

data CommandListFilter Source #

Constructors

CommandListFilterByModule ByteString
CommandListFilterByAclCat ByteString
CommandListFilterByPattern ByteString

Instances

Instances details

Show CommandListFilter Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> CommandListFilter -> ShowS # show :: CommandListFilter -> String # showList :: [CommandListFilter] -> ShowS #
Eq CommandListFilter Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: CommandListFilter -> CommandListFilter -> Bool # (/=) :: CommandListFilter -> CommandListFilter -> Bool #

commandListOpts Source #

Arguments

:: RedisCtx m f

=> Maybe CommandListFilter

Optional filtering mode.

CommandListFilterByModule keeps only commands that belong to the given module. CommandListFilterByAclCat keeps only commands from the given ACL category. CommandListFilterByPattern keeps only commands whose names match the specified glob-style pattern.

-> m (f [ByteString])

Returns a list of command names (https://redis.io/commands/command-list).

O(N) where N is the total number of Redis commands.

Since Redis 7.0.0

data IncrexExpiration Source #

Constructors

IncrexSeconds Integer
IncrexMilliseconds Integer
IncrexUnixSeconds Integer
IncrexUnixMilliseconds Integer
IncrexPersist

Instances

Instances details

Show IncrexExpiration Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> IncrexExpiration -> ShowS # show :: IncrexExpiration -> String # showList :: [IncrexExpiration] -> ShowS #
Eq IncrexExpiration Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: IncrexExpiration -> IncrexExpiration -> Bool # (/=) :: IncrexExpiration -> IncrexExpiration -> Bool #

data IncrexOpts a Source #

Constructors

IncrexOpts
Fields increxLowerBound :: Maybe a increxUpperBound :: Maybe a increxSaturate :: Bool increxExpiration :: Maybe IncrexExpiration increxExpirationIfNotExists :: Bool

Instances

Instances details

Show a => Show (IncrexOpts a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> IncrexOpts a -> ShowS # show :: IncrexOpts a -> String # showList :: [IncrexOpts a] -> ShowS #
Eq a => Eq (IncrexOpts a) Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: IncrexOpts a -> IncrexOpts a -> Bool # (/=) :: IncrexOpts a -> IncrexOpts a -> Bool #

defaultIncrexOpts :: IncrexOpts a Source #

Redis default IncrexOpts. Equivalent to omitting all optional parameters.

increx Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key to increment.
-> m (f (Integer, Integer))

Increments the numeric value of a key by one and optionally updates its expiration (https://redis.io/commands/increx).

O(1)

Since Redis 8.8.0

increxOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key to increment.
-> IncrexOpts Integer	Bound and expiration options. `LBOUND` and `UBOUND` constrain the result. `SATURATE` clips out-of-bounds values instead of rejecting the increment. `EX``PX``EXAT``PXAT``PERSIST` control the key expiration. `ENX` only sets the expiration when the key currently has no TTL.
-> m (f (Integer, Integer))

Increments the numeric value of a key by one and optionally updates its expiration (https://redis.io/commands/increx).

O(1)

Since Redis 8.8.0

increxBy Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key to increment.
-> Integer	The integer increment to apply.
-> IncrexOpts Integer	Bound and expiration options.
-> m (f (Integer, Integer))

Increments the integer value of a key by a specific amount and optionally updates its expiration (https://redis.io/commands/increx).

O(1)

Since Redis 8.8.0

increxByFloat Source #

Arguments

:: RedisCtx m f
=> ByteString	The name of the key to increment.
-> Double	The floating-point increment to apply.
-> IncrexOpts Double	Bound and expiration options.
-> m (f (Double, Double))

Increments the floating-point value of a key by a specific amount and optionally updates its expiration (https://redis.io/commands/increx).

O(1)

Since Redis 8.8.0

increxCommonArgs :: RedisArg a => IncrexOpts a -> [ByteString] Source #

data ARGrepPredicate Source #

Constructors

ARGrepExact ByteString
ARGrepMatch ByteString
ARGrepGlob ByteString
ARGrepRegex ByteString

Instances

Instances details

Show ARGrepPredicate Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARGrepPredicate -> ShowS # show :: ARGrepPredicate -> String # showList :: [ARGrepPredicate] -> ShowS #
Eq ARGrepPredicate Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARGrepPredicate -> ARGrepPredicate -> Bool # (/=) :: ARGrepPredicate -> ARGrepPredicate -> Bool #

data ARGrepCombine Source #

Constructors

ARGrepAnd
ARGrepOr

Instances

Instances details

Show ARGrepCombine Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARGrepCombine -> ShowS # show :: ARGrepCombine -> String # showList :: [ARGrepCombine] -> ShowS #
Eq ARGrepCombine Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARGrepCombine -> ARGrepCombine -> Bool # (/=) :: ARGrepCombine -> ARGrepCombine -> Bool #

data ARGrepOpts Source #

Constructors

ARGrepOpts
Fields arGrepCombine :: Maybe ARGrepCombine arGrepLimit :: Maybe Integer arGrepNoCase :: Bool

Instances

Instances details

Show ARGrepOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARGrepOpts -> ShowS # show :: ARGrepOpts -> String # showList :: [ARGrepOpts] -> ShowS #
Eq ARGrepOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARGrepOpts -> ARGrepOpts -> Bool # (/=) :: ARGrepOpts -> ARGrepOpts -> Bool #

defaultARGrepOpts :: ARGrepOpts Source #

Redis default ARGrepOpts. Equivalent to omitting all optional parameters.

data ARLastItemsOpts Source #

Constructors

ARLastItemsOpts
Fields arLastItemsReverse :: Bool

Instances

Instances details

Show ARLastItemsOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARLastItemsOpts -> ShowS # show :: ARLastItemsOpts -> String # showList :: [ARLastItemsOpts] -> ShowS #
Eq ARLastItemsOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARLastItemsOpts -> ARLastItemsOpts -> Bool # (/=) :: ARLastItemsOpts -> ARLastItemsOpts -> Bool #

defaultARLastItemsOpts :: ARLastItemsOpts Source #

Redis default ARLastItemsOpts. Equivalent to omitting all optional parameters.

data ARScanOpts Source #

Constructors

ARScanOpts
Fields arScanLimit :: Maybe Integer

Instances

Instances details

Show ARScanOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARScanOpts -> ShowS # show :: ARScanOpts -> String # showList :: [ARScanOpts] -> ShowS #
Eq ARScanOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARScanOpts -> ARScanOpts -> Bool # (/=) :: ARScanOpts -> ARScanOpts -> Bool #

defaultARScanOpts :: ARScanOpts Source #

Redis default ARScanOpts. Equivalent to omitting all optional parameters.

newtype ARIndexValuePairsResponse Source #

Constructors

ARIndexValuePairsResponse
Fields arIndexValuePairs :: [(Integer, ByteString)]

Instances

Instances details

Show ARIndexValuePairsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARIndexValuePairsResponse -> ShowS # show :: ARIndexValuePairsResponse -> String # showList :: [ARIndexValuePairsResponse] -> ShowS #
Eq ARIndexValuePairsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARIndexValuePairsResponse -> ARIndexValuePairsResponse -> Bool # (/=) :: ARIndexValuePairsResponse -> ARIndexValuePairsResponse -> Bool #
RedisResult ARIndexValuePairsResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ARIndexValuePairsResponse Source #

data ARInfoResponse Source #

Constructors

ARInfoResponse
Fields arInfoCount :: Integer arInfoLength :: Integer arInfoNextInsertIndex :: Integer arInfoSlices :: Integer arInfoDirectorySize :: Integer arInfoSuperDirEntries :: Integer arInfoSliceSize :: Integer arInfoDenseSlices :: Maybe Integer arInfoSparseSlices :: Maybe Integer arInfoAvgDenseSize :: Maybe Double arInfoAvgDenseFill :: Maybe Double arInfoAvgSparseSize :: Maybe Double

Instances

Instances details

Show ARInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> ARInfoResponse -> ShowS # show :: ARInfoResponse -> String # showList :: [ARInfoResponse] -> ShowS #
Eq ARInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: ARInfoResponse -> ARInfoResponse -> Bool # (/=) :: ARInfoResponse -> ARInfoResponse -> Bool #
RedisResult ARInfoResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply ARInfoResponse Source #

data AROpValue Source #

Constructors

AROpSum
AROpMin
AROpMax

Instances

Instances details

Show AROpValue Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> AROpValue -> ShowS # show :: AROpValue -> String # showList :: [AROpValue] -> ShowS #
Eq AROpValue Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: AROpValue -> AROpValue -> Bool # (/=) :: AROpValue -> AROpValue -> Bool #

data AROpCount Source #

Constructors

AROpAnd
AROpOr
AROpXor
AROpMatch ByteString
AROpUsed

Instances

Instances details

Show AROpCount Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> AROpCount -> ShowS # show :: AROpCount -> String # showList :: [AROpCount] -> ShowS #
Eq AROpCount Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: AROpCount -> AROpCount -> Bool # (/=) :: AROpCount -> AROpCount -> Bool #

argrepPredicateArgs :: ARGrepPredicate -> [ByteString] Source #

argrepOptsArgs :: ARGrepOpts -> [ByteString] Source #

aropValueArg :: AROpValue -> ByteString Source #

aropCountArgs :: AROpCount -> [ByteString] Source #

arcount Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> m (f Integer)

Returns the number of non-empty elements in an array (https://redis.io/commands/arcount).

O(1)

Since Redis 8.8.0

ardel Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> NonEmpty Integer	One or more zero-based indices to delete.
-> m (f Integer)

Deletes elements at the specified indices in an array (https://redis.io/commands/ardel).

O(N) where N is the number of indices to delete.

Since Redis 8.8.0

argetrange Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> Integer	End index, inclusive.
-> m (f [Maybe ByteString])

Gets values in a range of indices (https://redis.io/commands/argetrange).

O(N) where N is the range length.

Since Redis 8.8.0

argrep Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> ByteString	Start index or `-` for the first array index.
-> ByteString	End index or `+` for the last array index.
-> NonEmpty ARGrepPredicate	One or more predicates to apply.
-> m (f [Integer])

Searches array elements in a range using textual predicates (https://redis.io/commands/argrep).

O(P * C) where P is the number of visited positions and C is the cost of evaluating predicates.

Since Redis 8.8.0

argrepOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> ByteString	Start index or `-` for the first array index.
-> ByteString	End index or `+` for the last array index.
-> NonEmpty ARGrepPredicate	One or more predicates to apply.
-> ARGrepOpts	Additional predicate options.
-> m (f [Integer])

Searches array elements in a range using textual predicates (https://redis.io/commands/argrep).

O(P * C) where P is the number of visited positions and C is the cost of evaluating predicates.

Since Redis 8.8.0

argrepWithValues Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> ByteString	Start index or `-` for the first array index.
-> ByteString	End index or `+` for the last array index.
-> NonEmpty ARGrepPredicate	One or more predicates to apply.
-> m (f ARIndexValuePairsResponse)

Searches array elements in a range and returns matching index-value pairs (https://redis.io/commands/argrep).

O(P * C) where P is the number of visited positions and C is the cost of evaluating predicates.

Since Redis 8.8.0

argrepWithValuesOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> ByteString	Start index or `-` for the first array index.
-> ByteString	End index or `+` for the last array index.
-> NonEmpty ARGrepPredicate	One or more predicates to apply.
-> ARGrepOpts	Additional predicate options.
-> m (f ARIndexValuePairsResponse)

Searches array elements in a range and returns matching index-value pairs (https://redis.io/commands/argrep).

O(P * C) where P is the number of visited positions and C is the cost of evaluating predicates.

Since Redis 8.8.0

arinfo Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> m (f ARInfoResponse)

Returns metadata about an array (https://redis.io/commands/arinfo).

O(1), or O(N) with FULL where N is the number of slices.

Since Redis 8.8.0

arinfoFull Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> m (f ARInfoResponse)

Returns extended metadata about an array (https://redis.io/commands/arinfo).

O(N) where N is the number of slices.

Since Redis 8.8.0

arinsert Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> NonEmpty ByteString	Values to insert at the current insert cursor.
-> m (f Integer)

Inserts one or more values at consecutive indices (https://redis.io/commands/arinsert).

O(N) where N is the number of values.

Since Redis 8.8.0

arlastitems Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Maximum number of most recently inserted elements to return.
-> m (f [Maybe ByteString])

Returns the most recently inserted elements (https://redis.io/commands/arlastitems).

O(N) where N is the count.

Since Redis 8.8.0

arlastitemsOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Maximum number of most recently inserted elements to return.
-> ARLastItemsOpts	Additional options.
-> m (f [Maybe ByteString])

Returns the most recently inserted elements (https://redis.io/commands/arlastitems).

O(N) where N is the count.

Since Redis 8.8.0

arlen Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> m (f Integer)

Returns the length of an array (max index + 1) (https://redis.io/commands/arlen).

O(1)

Since Redis 8.8.0

armget Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> NonEmpty Integer	One or more zero-based indices.
-> m (f [Maybe ByteString])

Gets values at multiple indices in an array (https://redis.io/commands/armget).

O(N) where N is the number of indices.

Since Redis 8.8.0

arnext Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> m (f (Maybe Integer))

Returns the next index that ARINSERT would use (https://redis.io/commands/arnext).

O(1)

Since Redis 8.8.0

aropValue Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> Integer	End index.
-> AROpValue	Aggregate operation.
-> m (f (Maybe ByteString))

Performs aggregate operations on array elements in a range and returns a string result (https://redis.io/commands/arop).

O(P) where P is the number of visited positions in touched slices.

Since Redis 8.8.0

aropCount Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> Integer	End index.
-> AROpCount	Aggregate operation.
-> m (f (Maybe Integer))

Performs aggregate operations on array elements in a range and returns an integer result (https://redis.io/commands/arop).

O(P) where P is the number of visited positions in touched slices.

Since Redis 8.8.0

arring Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Ring buffer size.
-> NonEmpty ByteString	Values to insert.
-> m (f Integer)

Inserts values into a ring buffer of specified size, wrapping and truncating as needed (https://redis.io/commands/arring).

O(M) normally, or O(N+M) on ring resize.

Since Redis 8.8.0

arscan Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> Integer	End index.
-> m (f ARIndexValuePairsResponse)

Iterates existing elements in a range, returning index-value pairs (https://redis.io/commands/arscan).

O(P) where P is the number of visited positions in touched slices.

Since Redis 8.8.0

arscanOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> Integer	End index.
-> ARScanOpts	Additional options.
-> m (f ARIndexValuePairsResponse)

Iterates existing elements in a range, returning index-value pairs (https://redis.io/commands/arscan).

O(P) where P is the number of visited positions in touched slices.

Since Redis 8.8.0

arseek Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	The new insert cursor position.
-> m (f Bool)

Sets the ARINSERT ARRING cursor to a specific index (<https:redis.iocommands/arseek>).

O(1)

Since Redis 8.8.0

arset Source #

Arguments

:: RedisCtx m f
=> ByteString	Array key.
-> Integer	Start index.
-> NonEmpty ByteString	One or more values to store at consecutive indices.
-> m (f Integer)

Sets one or more contiguous values starting at an index in an array (https://redis.io/commands/arset).

O(N) where N is the number of values.

Since Redis 8.8.0

data HotkeysMetric Source #

Constructors

HotkeysMetricCPU
HotkeysMetricNET

Instances

Instances details

Show HotkeysMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HotkeysMetric -> ShowS # show :: HotkeysMetric -> String # showList :: [HotkeysMetric] -> ShowS #
Eq HotkeysMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HotkeysMetric -> HotkeysMetric -> Bool # (/=) :: HotkeysMetric -> HotkeysMetric -> Bool #
RedisArg HotkeysMetric Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: HotkeysMetric -> ByteString Source #

data HotkeysStartOpts Source #

Constructors

HotkeysStartOpts

Fields

hotkeysStartTopKCount :: Maybe Integer
The value of K for the top-K hotkeys tracking.
hotkeysStartDurationSeconds :: Maybe Integer
The number of seconds to keep tracking before it stops automatically.
hotkeysStartSampleRatio :: Maybe Integer
The probabilistic sampling ratio. Each key is sampled with probability 1/ratio.
hotkeysStartSlots :: Maybe (NonEmpty Integer)
The hash slots to track in cluster mode.

Instances

Instances details

Show HotkeysStartOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HotkeysStartOpts -> ShowS # show :: HotkeysStartOpts -> String # showList :: [HotkeysStartOpts] -> ShowS #
Eq HotkeysStartOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HotkeysStartOpts -> HotkeysStartOpts -> Bool # (/=) :: HotkeysStartOpts -> HotkeysStartOpts -> Bool #

defaultHotkeysStartOpts :: HotkeysStartOpts Source #

Redis default HotkeysStartOpts. Equivalent to omitting all optional parameters.

data HotkeysSlotRange Source #

Constructors

HotkeysSlotRange
Fields hotkeysSlotRangeStart :: Integer hotkeysSlotRangeEnd :: Integer

Instances

Instances details

Show HotkeysSlotRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HotkeysSlotRange -> ShowS # show :: HotkeysSlotRange -> String # showList :: [HotkeysSlotRange] -> ShowS #
Eq HotkeysSlotRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HotkeysSlotRange -> HotkeysSlotRange -> Bool # (/=) :: HotkeysSlotRange -> HotkeysSlotRange -> Bool #
RedisResult HotkeysSlotRange Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply HotkeysSlotRange Source #

data HotkeysGetResponse Source #

Instances

Instances details

Show HotkeysGetResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods showsPrec :: Int -> HotkeysGetResponse -> ShowS # show :: HotkeysGetResponse -> String # showList :: [HotkeysGetResponse] -> ShowS #
Eq HotkeysGetResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods (==) :: HotkeysGetResponse -> HotkeysGetResponse -> Bool # (/=) :: HotkeysGetResponse -> HotkeysGetResponse -> Bool #
RedisResult HotkeysGetResponse Source #
Instance details Defined in Database.Redis.ManualCommands Methods decode :: Reply -> Either Reply HotkeysGetResponse Source #

hotkeysStart Source #

Arguments

:: RedisCtx m f

=> NonEmpty HotkeysMetric

The metrics to track.

The command automatically derives the `METRICS count` argument from the number of provided metrics. At least one metric must be specified.

-> m (f Status)

Starts hotkeys tracking (https://redis.io/commands/hotkeys-start).

O(1)

Since Redis 8.6.0

hotkeysStartOpts Source #

Arguments

:: RedisCtx m f
=> NonEmpty HotkeysMetric	The metrics to track.
-> HotkeysStartOpts	Additional tracking options.
-> m (f Status)

Starts hotkeys tracking (https://redis.io/commands/hotkeys-start).

O(1)

Since Redis 8.6.0

hotkeysGet :: RedisCtx m f => m (f HotkeysGetResponse) Source #

Returns tracking results and metadata from the current or most recent hotkeys tracking session (https://redis.io/commands/hotkeys-get).

O(K) where K is the number of hotkeys returned.

Since Redis 8.6.0

hotkeysStop :: RedisCtx m f => m (f Status) Source #

Stops hotkeys tracking (https://redis.io/commands/hotkeys-stop).

O(1)

Since Redis 8.6.0

hotkeysReset :: RedisCtx m f => m (f Status) Source #

Release the resources used for hotkey tracking (https://redis.io/commands/hotkeys-reset).

O(1)

Since Redis 8.6.0

data ExpireOpts Source #

Constructors

ExpireOptsTime Condition
ExpireOptsValue SizeCondition

Instances

Instances details

RedisArg ExpireOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: ExpireOpts -> ByteString Source #

pexpireatOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	millisecondsTimestamp
-> ExpireOpts
-> m (f Bool)

Set the expiration for a key as a UNIX timestamp specified in milliseconds (http://redis.io/commands/pexpireat). Since Redis 7.0

expireOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	seconds
-> ExpireOpts
-> m (f Bool)

expireatOpts Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	timestamp
-> ExpireOpts
-> m (f Bool)

Set the expiration for a key as a UNIX timestamp (http://redis.io/commands/expireat). Since Redis 1.2.0

data FlushOpts Source #

Constructors

FlushOptsSync
FlushOptsAsync

Instances

Instances details

RedisArg FlushOpts Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: FlushOpts -> ByteString Source #

flushdbOpts :: RedisCtx m f => FlushOpts -> m (f Status) Source #

Remove all keys from the current database (http://redis.io/commands/flushdb). Since Redis 6.2

flushallOpts :: RedisCtx m f => FlushOpts -> m (f Status) Source #

Remove all keys from the current database (http://redis.io/commands/flushdb). Since Redis 6.2

data BitposType Source #

Constructors

Byte
Bit

Instances

Instances details

RedisArg BitposType Source #
Instance details Defined in Database.Redis.ManualCommands Methods encode :: BitposType -> ByteString Source #

data BitposOpts Source #

Constructors

BitposOptsStart Integer
BitposOptsStartEnd Integer Integer (Maybe BitposType)

bitposOpts :: RedisCtx m f => ByteString -> Integer -> BitposOpts -> m (f Integer) Source #

substr Source #

Arguments

:: RedisCtx m f
=> ByteString	key
-> Integer	start
-> Integer	end
-> m (f ByteString)

Get a substring of the string stored at a key (http://redis.io/commands/substr).

Deprecated in Redis. Use getrange instead.

Since Redis 1.0.0