Skip to main content

Data Structures

Hash​

HDEL​

Syntax​

    HDEL key field [field ...]

Removes the specified fields from the hash stored at key. Specified fields that do not exist within this hash are ignored. If key does not exist, it is treated as an empty hash and this command returns 0.

HEXISTS​

Syntax​

    HEXISTS key field

Returns if field is an existing field in the hash stored at key.

HGET​

Syntax​

    HGET key field

Returns the value associated with field in the hash stored at key.

HGETALL​

Syntax​

    HGETALL key

Returns all fields and values of the hash stored at key. In the returned value, every field name is followed by its value, so the length of the reply is twice the size of the hash.

HINCRBY​

Syntax​

    HINCRBY key field increment

Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed. The range of values supported by HINCRBY is limited to 64 bit signed integers.

HINCRBYFLOAT​

Syntax​

    HINCRBYFLOAT key field increment

Increment the specified field of a hash stored at key, and representing a floating point number, by the specified increment. If the increment value is negative, the result is to have the hash field value decremented instead of incremented. If the field does not exist, it is set to 0 before performing the operation. An error is returned if one of the following conditions occur:

  • The field contains a value of the wrong type (not a string).
  • The current field content or the specified increment are not parsable as a double precision floating point number.

HKEYS​

Syntax​

    HKEYS key

Returns all field names in the hash stored at key.

HLEN​

Syntax​

    HLEN key

Returns the number of fields contained in the hash stored at key.

HMGET​

Syntax​

    HMGET key field [field ...]

Ret urns the values associated with the specified fields in the hash stored at key.

For every field that does not exist in the hash, a nil value is returned. Because non-existing keys are treated as empty hashes, running HMGET against a non-existing key will return a list of nil values.

HMSET​

Syntax​

    HMSET key field value [field value ...]

Deprecated in favor of HSET with multiple field-value pairs.

Sets the specified fields to their respective values in the hash stored at key. This command overwrites any specified fields already existing in the hash. If key does not exist, a new key holding a hash is created.

HRANDFIELD​

Syntax​

    HRANDFIELD key [count [WITHVALUES]]

When called with just the key argument, return a random field from the hash value stored at key.

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.

The optional WITHVALUES modifier changes the reply so it includes the respective values of the randomly selected hash fields.

HSCAN​

Syntax​

    HSCAN key cursor [MATCH pattern] [COUNT count] [NOVALUES]

Iterates over the fields and values of a hash stored at a given key. Same as SSCAN and ZSCAN commands, HSCAN is used in order to incrementally iterate over the elements of the hash set*.

The match parameter allows to apply a filter to elements after they have been retrieved from the collection. The count option sets a limit to the maximum number of items returned from the server to this command. This limit is also set in conjunction with the object-scan-count-limit of the global server settings.

You can use the NOVALUES option to make Redis return only the keys in the hash table without their corresponding values

HSET​

Syntax​

    HSET key field value

Sets the specified fields to their respective values in the hash stored at key. This command overwrites the values of specified fields that exist in the hash. If key does not exist, a new key holding a hash is created.

HSETNX​

Syntax​

    HSETNX key field value

Sets field in the hash stored at key to value, only if field does not yet exist. If key does not exist, a new key holding a hash is created. If field already exists, this operation has no effect.

HSTRLEN​

Syntax​

    HSTRLEN key field

Returns the string length of the value associated with field in the hash stored at key. If the key or the field do not exist, 0 is returned.

HVALS​

Syntax​

    HVALS key

Returns all values in the hash stored at key.

List​

BLMOVE​

Syntax​

    BLMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT> timeout

BLMOVE is the blocking variant of LMOVE. When source contains elements, this command behaves exactly like LMOVE. When used inside a MULTI/EXEC block, this command behaves exactly like LMOVE. When source is empty, Garnet will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.

BLPOP​

Syntax​

    BLPOP key [key ...] timeout

BLPOP is a blocking list pop primitive. It is the blocking version of LPOP because it blocks the connection when there are no elements to pop from any of the given lists. An element is popped from the head of the first list that is non-empty, with the given keys being checked in the order that they are given.

BRPOP​

Syntax​

    BRPOP key [key ...] timeout

BRPOP is a blocking list pop primitive. It is the blocking version of RPOP because it blocks the connection when there are no elements to pop from any of the given lists. An element is popped from the tail of the first list that is non-empty, with the given keys being checked in the order that they are given.

LINDEX​

Syntax​

    LINDEX key index

Removes the element at index index in the list stored at key. The index is zero-based. Negative indices can be used to designate elements starting at the tail of the list.

LINSERT​

Syntax​

    LINSERT key BEFORE|AFTER pivot element

Inserts element in the list stored at key either before or after the reference value pivot. When key does not exist, it is considered an empty list and no operation is performed.

LLEN​

Syntax​

    LLEN key

Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.

LMOVE​

Syntax​

    LMOVE source destination LEFT|RIGHT LEFT|RIGHT

Atomically returns and removes the first/last element (head/tail depending on the wherefrom argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.

This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.

LMPOP​

Syntax​

    LMPOP numkeys key [key ...] <LEFT | RIGHT> [COUNT count]

Pops one or more elements from the first non-empty list key from the list of provided key names.

LPOP​

Syntax​

    LPOP key [count]

Removes and returns the first elements of the list stored at key.

By default, the command pops a single element from the beginning of the list. When provided with the optional count argument, the reply will consist of up to count elements, depending on the list's length.

LPOS​

Syntax​

    LPOS key element [RANK rank] [COUNT num-matches] [MAXLEN len]

The command returns the index of matching elements inside a Redis list. By default, when no options are given, it will scan the list from head to tail, looking for the first match of "element". If the element is found, its index (the zero-based position in the list) is returned. Otherwise, if no match is found, nil is returned.

Resp Reply​

Any of the following:

  • Null reply: if there is no matching element.
  • Integer reply: an integer representing the matching element.
  • Array reply: If the COUNT option is given, an array of integers representing the matching elements (or an empty array if there are no matches).

LPUSH​

Syntax​

    LPUSH key [element] [element ...]

Insert all the specified values at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.

LPUSHX​

Syntax​

    LPUSHX key [element] [element ...]

Inserts specified values at the head of the list stored at key, only if key already exists and holds a list. In contrary to LPUSH, no operation will be performed when key does not yet exist.

LRANGE​

Syntax​

    LRANGE key start stop

Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.

LREM​

Syntax​

    LREM key count element

Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways:

  • count > 0: Remove elements equal to element moving from head to tail.

  • count < 0: Remove elements equal to element moving from tail to head.

  • count = 0: Remove all elements equal to element.

LSET​

Syntax​

    LSET key index element

Sets the list element at index to element. For more information on the index argument, see LINDEX.

An error is returned for out of range indexes.

LTRIM​

Syntax​

    LTRIM key start stop

Trim an existing list so that it will contain only the specified range of elements specified. Both start and stop are zero-based indexes, where 0 is the first element of the list (the head), 1 the next element and so on.

RPOP​

Syntax​

    RPOP key [count]

Removes and returns the last elements of the list stored at key.

By default, the command pops a single element from the end of the list. When provided with the optional count argument, the reply will consist of up to count elements, depending on the list's length.

RPOPLPUSH​

Syntax​

    RPOPLPUSH source destination

Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.

It can be replaced by LMOVE with the RIGHT and LEFT arguments when migrating or writing new code.

RPUSH​

Syntax​

    RPUSH key element [element]

Insert all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.

RPUSHX​

Syntax​

    RPUSHX key element [element]

Inserts specified values at the tail of the list stored at key, only if key already exists and holds a list. In contrary to RPUSH, no operation will be performed when key does not yet exist.

Set​

SADD​

Syntax​

    SADD key member [member]

Adds the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.

SCARD​

Syntax​

    SCARD key

Returns the set cardinality (number of elements) of the set stored at key.

SMEMBERS​

Syntax​

    SMEMBERS key

Returns all the members of the set value stored at key.

SMOVE​

Syntax​

    SMOVE source destination member

Move member from the set at source to the set at destination. This operation is atomic. In every given moment the element will appear to be a member of source or destination for other clients.

SPOP​

Syntax​

    SPOP key [count]

Removes and returns one or more random members from the set value stored at key.

SISMEMBER​

Syntax​

    SISMEMBER key member

Returns if member is a member of the set stored at key.

SMISMEMBER​

Syntax​

    SMISMEMBER key member [member ...]

Returns whether each member is a member of the set stored at key.

Resp Reply​

Array reply: a list representing the membership of the given elements, in the same order as they are requested.

SRANDMEMBER​

Syntax​

    SRANDMEMBER key [count]

When called with just the key argument, return a random element from the set value stored at key.

If the provided count argument is positive, return an array of distinct elements. The array's length is either count or the set's cardinality (SCARD), whichever is lower.

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

SREM​

Syntax​

    SREM key member [member]

Removes the specified members from the set stored at key. Specified members that are not a member of this set are ignored.

If key does not exist, it is treated as an empty set and this command returns 0.

SSCAN​

Syntax​

    SSCAN key cursor [MATCH pattern] [COUNT count]

Iterates elements of Sets types. Same as HSCAN and ZSCAN commands, SSCAN is used in order to incrementally iterate over the elements of the set stored at key.

The match parameter allows to apply a filter to elements after they have been retrieved from the collection. The count option sets a limit to the maximum number of items returned from the server to this command. This limit is also set in conjunction with the object-scan-count-limit of the global server settings.

SUNION​

Syntax​

    SUNION key [key ...]

Returns the members of the set resulting from the union of all the given sets. Keys that do not exist are considered to be empty sets.

SUNIONSTORE​

Syntax​

    SUNIONSTORE destination key [key ...]

This command is equal to SUNION, but instead of returning the resulting set, it is stored in destination.

If destination already exists, it is overwritten.

SINTER​

Syntax​

    SINTER key [key ...]

Returns the members of the set resulting from the intersection of all the given sets. Keys that do not exist are considered to be empty sets.

SINTERSTORE​

Syntax​

    SINTERSTORE destination key [key ...]

This command is equal to SINTER, but instead of returning the resulting set, it is stored in destination.

If destination already exists, it is overwritten.

SDIFF​

Syntax​

    SDIFF key [key ...]

Returns the members of the set resulting from the difference between the first set and all the successive sets.

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

SDIFFSTORE​

Syntax​

    SDIFFSTORE destination key [key ...]

This command is equal to SDIFF, but instead of returning the resulting set, it is stored in destination.

If destination already exists, it is overwritten.

Sorted Set​

ZADD​

Syntax​

    ZADD key score member [score member ...]

Adds all the specified members with the specified scores to the sorted set stored at key. It is possible to specify multiple score / member pairs. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.

If key does not exist, a new sorted set with the specified members as sole members is created, like if the sorted set was empty.

The score values should be the string representation of a double precision floating point number.

ZCARD​

Syntax​

    ZCARD key

Returns the sorted set cardinality (number of elements) of the sorted set stored at key.

ZCOUNT​

Syntax​

    ZCOUNT key min max

Returns the number of elements in the sorted set at key with a score between min and max.

The min and max arguments have the same semantic as described for ZRANGEBYSCORE.

ZDIFF​

Syntax​

    ZDIFF numkeys key [key ...] [WITHSCORES]

Returns the difference between the first and all successive input sorted sets keys. The total number of input keys is specified by numkeys.

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

ZDIFFSTORE​

Syntax​

    ZDIFFSTORE destination numkeys key [key ...]

Computes the difference between the first and all successive input sorted sets and stores the result in destination. The total number of input keys is specified by numkeys.

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

Resp Reply​

Integer reply: the number of members in the resulting sorted set at destination.

ZINCRBY​

Syntax​

    ZINCRBY key increment member

Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0). If key does not exist, a new sorted set with the specified member as its sole member is created.

An error is returned when key exists but does not hold a sorted set.

The score value should be the string representation of a numeric value, and accepts double precision floating point numbers. It is possible to provide a negative value to decrement the score.

ZLEXCOUNT​

Syntax​

    ZLEXCOUNT key min max

When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns the number of elements in the sorted set at key with a value between min and max.

The min and max arguments have the same meaning as described for ZRANGEBYLEX.

ZMSCORE​

Syntax​

    ZMSCORE key member [member ...]

Returns the scores associated with the specified members in the sorted set stored at key.

For every member that does not exist in the sorted set, a nil value is returned.

Returns one of the following:

Nil reply: if the member does not exist in the sorted set.
Array reply: a list of string member scores as double-precision floating point numbers.

ZPOPMAX​

Syntax​

    ZPOPMAX key [count]

Removes and returns up to count members with the highest scores in the sorted set stored at key.

When left unspecified, the default value for count is 1. Specifying a count value that is higher than the sorted set's cardinality will not produce an error. When returning multiple elements, the one with the highest score will be the first, followed by the elements with lower scores.

ZPOPMIN​

Syntax​

    ZPOPMIN key [count]

Removes and returns up to count members with the lowest scores in the sorted set stored at key.

When left unspecified, the default value for count is 1. Specifying a count value that is higher than the sorted set's cardinality will not produce an error. When returning multiple elements, the one with the lowest score will be the first, followed by the elements with greater scores.

ZRANDMEMBER​

Syntax​

    ZRANDMEMBER key [count [WITHSCORES]]

When called with just the key argument, return a random element from the sorted set value stored at key.

If the provided count argument is positive, return an array of distinct elements. The array's length is either count or the sorted set's cardinality ZCARD, whichever is lower.

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

The optional WITHSCORES modifier changes the reply so it includes the respective scores of the randomly selected elements from the sorted set.

ZRANGE​

Syntax​

    ZRANGE key start stop [BYSCORE|BYLEX] [REV] [LIMIT offset count] [WITHSCORES]

Returns the specified range of elements in the sorted set stored at key.

ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order.

ZRANGEBYLEX​

Syntax​

    ZRANGEBYLEX key min max [LIMIT offset count]

When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.

If the elements in the sorted set have different scores, the returned elements are unspecified.

It can be replaced by ZRANGE with the BYLEX argument when migrating from older versions.

ZRANGEBYSCORE​

Syntax​

    ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count]

Returns all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max). The elements are considered to be ordered from low to high scores.

The elements having the same score are returned in lexicographical order.

It can be replaced by ZRANGE with the BYSCORE argument when migrating or writing new code.

ZRANK​

Syntax​

    ZRANK key member [WITHSCORE]

Returns the rank of member in the sorted set stored at key, with the scores ordered from low to high. The rank (or index) is 0-based, which means that the member with the lowest score has rank 0.

The optional WITHSCORE argument supplements the command's reply with the score of the element returned.

Use ZREVRANK to get the rank of an element with the scores ordered from high to low.

ZREM​

Syntax​

    ZREM key member [member ...]

Removes the specified members from the sorted set stored at key. Non existing members are ignored.

ZREMRANGEBYLEX​

Syntax​

    ZREMRANGEBYLEX key min max

When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command removes all elements in the sorted set stored at key between the lexicographical range specified by min and max.

The meaning of min and max are the same of the ZRANGEBYLEX command. Similarly, this command actually removes the same elements that ZRANGEBYLEX would return if called with the same min and max arguments.

ZREMRANGEBYSCORE​

Syntax​

    ZREMRANGEBYSCORE key min max

Removes all elements in the sorted set stored at key with a score between min and max (inclusive).

ZREMRANGEBYRANK​

Syntax​

    ZREMRANGEBYRANK key start stop

Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second highest score and so forth.

ZREMRANGEBYSCORE​

Syntax​

    ZREMRANGEBYSCORE key min max

Removes all elements in the sorted set stored at key with a score between min and max (inclusive).

ZREVRANGE​

Syntax​

    ZREVRANGE key start stop [WITHSCORES]

Returns the specified range of elements in the sorted set stored at key. The elements are considered to be ordered from the highest to the lowest score. Descending lexicographical order is used for elements with equal score.

Apart from the reversed ordering, ZREVRANGE is similar to ZRANGE.

ZREVRANGEBYSCORE​

Syntax​

    ZREVRANGEBYSCORE key max min [WITHSCORES] [LIMIT offset count]

Returns all the elements in the sorted set at key with a score between max and min (including elements with score equal to max or min).

ZREVRANK​

Syntax​

    ZREVRANK key member [WITHSCORE]

Returns the rank of member in the sorted set stored at key, with the scores ordered from high to low. The rank (or index) is 0-based, which means that the member with the highest score has rank 0.

The optional WITHSCORE argument supplements the command's reply with the score of the element returned.

Use ZRANK to get the rank of an element with the scores ordered from low to high.

ZSCAN​

Syntax​

    ZSCAN key cursor [MATCH pattern] [COUNT count]

Iterates over the elements of a Sorted Set. Same as HSCAN and SSCAN commands, ZSCAN is used in order to incrementally iterate over the elements of the set stored at key.

The match parameter allows to apply a filter to elements after they have been retrieved from the collection. The count option sets a limit to the maximum number of items returned from the server to this command. This limit is also set in conjunction with the object-scan-count-limit of the global server settings.

ZSCORE​

Syntax​

    ZSCORE key member

Returns the score of member in the sorted set at key.

If member does not exist in the sorted set, or key does not exist, nil is returned.

Geospatial indices​

GEOADD​

Syntax​

    GEOADD key [NX | XX] [CH] longitude latitude member [longitude latitude member ... ]

Adds the specified geospatial items (longitude, latitude, name) to the specified key. Data is stored into the key as a sorted set, in a way that makes it possible to query the items with the GEOSEARCH command.

The command takes arguments in the standard format x,y so the longitude must be specified before the latitude. There are limits to the coordinates that can be indexed: areas very near to the poles are not indexable.

The exact limits, are the following:

  • Valid longitudes are from -180 to 180 degrees.
  • Valid latitudes are from -85.05112878 to 85.05112878 degrees.

The command will report an error when the user attempts to index coordinates outside the specified ranges.

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

GEOADD also provides the following options:

  • XX: Only update elements that already exist. Never add elements.
  • NX: Don't update already existing elements. Always add new elements.
  • CH: Modify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed).

Changed elements are new elements added and elements already existing for which the coordinates was updated. So elements specified in the command line having the same score as they had in the past are not counted. Note: normally, the return value of GEOADD only counts the number of new elements added.

Note: The XX and NX options are mutually exclusive.

GEODIST​

Syntax​

    GEODIST key member1 member2 [M|KM|FT|MI]

Return the distance between two members in the geospatial index represented by the sorted set.

Given a sorted set representing a geospatial index, populated using the GEOADD command, the command returns the distance between the two specified members in the specified unit.

If one or both the members are missing, the command returns NULL.

The unit must be one of the following, and defaults to meters:

  • m for meters.
  • km for kilometers.
  • mi for miles.
  • ft for feet.

The distance is computed assuming that the Earth is a perfect sphere, so errors up to 0.5% are possible in edge cases.

GEOHASH​

Syntax​

    GEOHASH key [member [member ...]]

Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

GEOPOS​

Syntax​

    GEOPOS key [member [member ...]]

Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

Given a sorted set representing a geospatial index, populated using the GEOADD command, it is often useful to obtain back the coordinates of specified members. When the geospatial index is populated via GEOADD the coordinates are converted into a 52 bit geohash, so the coordinates returned may not be exactly the ones used in order to add the elements, but small errors may be introduced.

The command can accept a variable number of arguments so it always returns an array of positions even when a single element is specified.

GEOSEARCH​

Syntax​

    GEOSEARCH key <FROMMEMBER member> <BYBOX width height <M|KM|FT|MI>> [ASC|DESC] [WITHCOORD WITHDIST WITHHASH]

Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified by a given shape.

The query's center point is provided by one of these mandatory options:

  • FROMMEMBER: Use the position of the given existing member in the sorted set.

The query's shape is provided by this option:

  • BYBOX: Search inside an axis-aligned rectangle, determined by height and width.

The command optionally returns additional information using the following options:

  • WITHDIST: Also return the distance of the returned items from the specified center point. The distance is returned in the same unit as specified for the radius or height and width arguments.
  • WITHCOORD: Also return the longitude and latitude of the matching items.
  • WITHHASH: Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.

Matching items are returned unsorted by default. To sort them, use one of the following two options:

  • ASC: Sort returned items from the nearest to the farthest, relative to the center point.

  • DESC: Sort returned items from the farthest to the nearest, relative to the center point.

Reply

An Array reply of matched members, where each sub-array represents a single item, (longitude,latitude).

GEOSEARCHSTORE​

Syntax​

GEOSEARCHSTORE destination source <FROMMEMBER member |
  FROMLONLAT longitude latitude> <BYRADIUS radius <m | km | ft | mi>
  | BYBOX width height <m | km | ft | mi>> [ASC | DESC] [COUNT count
  [ANY]] [STOREDIST]

This command is like GEOSEARCH, but stores the result in destination key.

Reply

Integer reply: the number of elements in the resulting set