Constructors
Instances2Eq, Show
Eq JSONGetOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONShow JSONGetOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSON
Modulehedis-0.16.4Haskell2010
Database.Redis.ManualCommands.JSON
Synopsis
- data JSONGetOpts
- value defaultJSONGetOpts
- data JSONSetCondition
- data JSONSetFPHA
- data JSONSetOpts
- value defaultJSONSetOpts
- data JSONArrIndexOpts
- value defaultJSONArrIndexOpts
- value jsonGetOptsToArgs
- value jsonSetOptsToArgs
- value jsonArrIndexOptsToArgs
- value jsonArrappend
- value jsonArrindex
- value jsonArrindexOpts
- value jsonArrlen
- value jsonArrlenAt
- value jsonArrinsert
- value jsonArrpop
- value jsonArrpopAt
- value jsonArrpopAtIndex
- value jsonArrtrim
- value jsonClear
- value jsonClearAt
- value jsonDebug
- value jsonDebugMemory
- value jsonDebugMemoryAt
- value jsonDel
- value jsonDelAt
- value jsonForget
- value jsonForgetAt
- value jsonGet
- value jsonGetOpts
- value jsonMerge
- value jsonMget
- value jsonMset
- value jsonNumincrby
- value jsonNummultby
- value jsonObjkeys
- value jsonObjkeysAt
- value jsonObjlen
- value jsonObjlenAt
- value jsonResp
- value jsonRespAt
- value jsonSet
- value jsonSetOpts
- value jsonStrappend
- value jsonStrappendAt
- value jsonToggle
- value jsonType
- value jsonTypeAt
- Packagehedis-0.16.4
- Exports50
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceJSON.hs
Instances3Eq, Show, RedisArg
Eq JSONSetConditionDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONShow JSONSetConditionDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONRedisArg JSONSetConditionDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSON
Instances3Eq, Show, RedisArg
Eq JSONSetFPHADefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONShow JSONSetFPHADefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONRedisArg JSONSetFPHADefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSON
Constructors
Instances2Eq, Show
Eq JSONSetOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONShow JSONSetOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSON
Instances2Eq, Show
Eq JSONArrIndexOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSONShow JSONArrIndexOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.JSON
value
jsonArrappend :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> NonEmpty ByteStringSerialized JSON values to append.
-> m (f Reply)
Appends one or more JSON values into the array at path after the last element in it (https://redis.io/commands/json.arrappend).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonArrindex :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> ByteStringSerialized JSON scalar to search for.
-> m (f Reply)
Returns the index of the first occurrence of a JSON scalar value in the array at path (https://redis.io/commands/json.arrindex).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonArrindexOpts :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> ByteStringSerialized JSON scalar to search for.
-> JSONArrIndexOptsOptional search range.
-> m (f Reply)
Returns the index of the first occurrence of a JSON scalar value in the array at path (https://redis.io/commands/json.arrindex).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Returns the length of the array at the root path (https://redis.io/commands/json.arrlen).
O(1) where path is evaluated to a single value, O(N) where path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonArrlenAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> m (f Reply)
Returns the length of the array at path (https://redis.io/commands/json.arrlen).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) where path is evaluated to a single value, O(N) where path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonArrinsert :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> IntegerInsertion index.
-> NonEmpty ByteStringSerialized JSON values to insert.
-> m (f Reply)
Inserts the JSON scalar(s) value at the specified index in the array at path (https://redis.io/commands/json.arrinsert).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Removes and returns the element at the end of the array at the root path (https://redis.io/commands/json.arrpop).
O(1) when the popped item is the last element, otherwise O(N) where N is the size of the array
Since RedisJSON 1.0.0
value
jsonArrpopAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> m (f Reply)
Removes and returns the element at the end of the array at path (https://redis.io/commands/json.arrpop).
The reply shape depends on the path syntax and popped value type, so this wrapper returns the raw Reply.
O(1) when the popped item is the last element, otherwise O(N) where N is the size of the array
Since RedisJSON 1.0.0
value
jsonArrpopAtIndex :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> IntegerIndex to pop.
-> m (f Reply)
Removes and returns the element at the specified index in the array at path (https://redis.io/commands/json.arrpop).
The reply shape depends on the path syntax and popped value type, so this wrapper returns the raw Reply.
O(N) when the specified index is not the last element, otherwise O(1)
Since RedisJSON 1.0.0
value
jsonArrtrim :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the array.
-> IntegerStart index.
-> IntegerStop index.
-> m (f Reply)
Trims the array at path to contain only the specified inclusive range of indices from start to stop (https://redis.io/commands/json.arrtrim).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Clears all values from an array or an object and sets numeric values at the root path to 0 (https://redis.io/commands/json.clear).
O(N) when path is evaluated to a single value where N is the size of the values, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 2.0.0
value
jsonClearAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to clear.
-> m (f Integer)
Clears all values from an array or an object and sets numeric values at path to 0 (https://redis.io/commands/json.clear).
O(N) when path is evaluated to a single value where N is the size of the values, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 2.0.0
Executes the JSON debug container command (https://redis.io/commands/json.debug).
This is a container command for debugging related tasks.
N/A
Since RedisJSON 1.0.0
Reports the size in bytes of a key at the root path (https://redis.io/commands/json.debug-memory).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonDebugMemoryAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to inspect.
-> m (f Reply)
Reports the size in bytes of a key at path (https://redis.io/commands/json.debug-memory).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Deletes a value at the root path (https://redis.io/commands/json.del).
O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonDelAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to delete.
-> m (f Integer)
Deletes a value at path (https://redis.io/commands/json.del).
O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Deletes a value at the root path (https://redis.io/commands/json.forget).
O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonForgetAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to delete.
-> m (f Integer)
Deletes a value at path (https://redis.io/commands/json.forget).
O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Gets the value at the root path in JSON serialized form (https://redis.io/commands/json.get).
O(N) when path is evaluated to a single value where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonGetOpts :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> JSONGetOptsFormatting and path selection options.
-> m (f (Maybe ByteString))
Gets the value at one or more paths in JSON serialized form (https://redis.io/commands/json.get).
O(N) when path is evaluated to a single value where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonMerge :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to merge into.
-> ByteStringSerialized JSON value.
-> m (f Status)
Merges a given JSON value into matching paths (https://redis.io/commands/json.merge).
Consequently, JSON values at matching paths are updated, deleted, or expanded with new children.
O(M+N) when path is evaluated to a single value where M is the size of the original value and N is the size of the new value, O(M+N) when path is evaluated to multiple values where M is the size of the key and N is the size of the new value times the number of matches
Since RedisJSON 2.6.0
value
jsonMget :: RedisCtx m f=> NonEmpty ByteStringKeys holding JSON values.
-> ByteStringPath to fetch from each key.
-> m (f [Maybe ByteString])
Returns the values at a path from one or more keys (https://redis.io/commands/json.mget).
O(M*N) when path is evaluated to a single value where M is the number of keys and N is the size of the value, O(N1+N2+dots+Nm) when path is evaluated to multiple values
Since RedisJSON 1.0.0
value
jsonMset :: RedisCtx m f=> NonEmpty (ByteString, ByteString, ByteString)Key, path, serialized JSON value triplets.
-> m (f Status)
Sets or updates the JSON value of one or more keys (https://redis.io/commands/json.mset).
O(K*(M+N)) where K is the number of keys in the command
Since RedisJSON 2.6.0
value
jsonNumincrby :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the numeric value.
-> DoubleIncrement value.
-> m (f Reply)
Increments the numeric value at path by a value (https://redis.io/commands/json.numincrby).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonNummultby :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the numeric value.
-> DoubleMultiplier value.
-> m (f Reply)
Multiplies the numeric value at path by a value (https://redis.io/commands/json.nummultby).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Returns the key names of JSON objects at the root path (https://redis.io/commands/json.objkeys).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the number of keys in the object, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonObjkeysAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the object.
-> m (f Reply)
Returns the key names of JSON objects at path (https://redis.io/commands/json.objkeys).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the number of keys in the object, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Returns the number of keys in JSON objects at the root path (https://redis.io/commands/json.objlen).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonObjlenAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the object.
-> m (f Reply)
Returns the number of keys in JSON objects at path (https://redis.io/commands/json.objlen).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
Returns the JSON value at the root path in Redis Serialization Protocol (RESP) (https://redis.io/commands/json.resp).
The reply may be any RESP shape depending on the JSON value, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonRespAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to inspect.
-> m (f Reply)
Returns the JSON value at path in Redis Serialization Protocol (RESP) (https://redis.io/commands/json.resp).
The reply may be any RESP shape depending on the JSON value, so this wrapper returns the raw Reply.
O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
when path is evaluated to a single value where $M$ is the size of the original value and $N$ is the size of the new value, $O(M+N)$ when path is evaluated to multiple values where $M$ is the size of the key and $N$ is the size of the new value times the number of matches
Since RedisJSON 1.0.0
value
jsonSet :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to set.
-> ByteStringSerialized JSON value.
-> m (f (Maybe Status))
value
jsonSetOpts :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to set.
-> ByteStringSerialized JSON value.
-> JSONSetOptsConditional and FPHA options.
-> m (f (Maybe Status))
Sets or updates the JSON value at a path (https://redis.io/commands/json.set).
O(M+N) when path is evaluated to a single value where M is the size of the original value and N is the size of the new value, O(M+N) when path is evaluated to multiple values where M is the size of the key and N is the size of the new value times the number of matches
Since RedisJSON 1.0.0
value
jsonStrappend :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringString value to append.
-> m (f Reply)
Appends a string to JSON strings at the root path (https://redis.io/commands/json.strappend).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonStrappendAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the JSON string.
-> ByteStringString value to append.
-> m (f Reply)
Appends a string to JSON strings at path (https://redis.io/commands/json.strappend).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonToggle :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to the boolean value.
-> m (f Reply)
Toggles a boolean value (https://redis.io/commands/json.toggle).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 2.0.0
Returns the type of the JSON value at the root path (https://redis.io/commands/json.type).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0
value
jsonTypeAt :: RedisCtx m f=> ByteStringKey holding a JSON value.
-> ByteStringPath to inspect.
-> m (f Reply)
Returns the type of the JSON value at path (https://redis.io/commands/json.type).
The reply shape depends on the path syntax, so this wrapper returns the raw Reply.
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
Since RedisJSON 1.0.0