Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions content/commands/bitop.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ summary: Performs bitwise operations on multiple strings, and stores the result.
syntax_fmt: BITOP <AND | OR | XOR | NOT | DIFF | DIFF1 | ANDOR | ONE> destkey key [key ...]
title: BITOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Perform a bitwise operation between multiple keys (containing string values) and
store the result in the destination key.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/blmove.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ summary: Pops an element from a list, pushes it to another list and returns it.
syntax_fmt: BLMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT> timeout
title: BLMOVE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BLMOVE` is the blocking variant of [`LMOVE`]({{< relref "/commands/lmove" >}}).
When `source` contains elements, this command behaves exactly like [`LMOVE`]({{< relref "/commands/lmove" >}}).
When used inside a [`MULTI`]({{< relref "/commands/multi" >}})/[`EXEC`]({{< relref "/commands/exec" >}}) block or a Lua script, this command behaves exactly like [`LMOVE`]({{< relref "/commands/lmove" >}}).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/blmpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ summary: Pops the first element from one of multiple lists. Blocks until an elem
syntax_fmt: "BLMPOP timeout numkeys key [key ...] <LEFT | RIGHT> [COUNT\_count]"
title: BLMPOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BLMPOP` is the blocking variant of [`LMPOP`]({{< relref "/commands/lmpop" >}}).

When any of the lists contains elements, this command behaves exactly like [`LMPOP`]({{< relref "/commands/lmpop" >}}).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/blpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ summary: Removes and returns the first element in a list. Blocks until an elemen
syntax_fmt: BLPOP key [key ...] timeout
title: BLPOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BLPOP` is a blocking list pop primitive.
It is the blocking version of [`LPOP`]({{< relref "/commands/lpop" >}}) because it blocks the connection when there
are no elements to pop from any of the given lists.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/brpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ summary: Removes and returns the last element in a list. Blocks until an element
syntax_fmt: BRPOP key [key ...] timeout
title: BRPOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BRPOP` is a blocking list pop primitive.
It is the blocking version of [`RPOP`]({{< relref "/commands/rpop" >}}) because it blocks the connection when there
are no elements to pop from any of the given lists.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/brpoplpush.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ summary: Pops an element from a list, pushes it to another list and returns it.
syntax_fmt: BRPOPLPUSH source destination timeout
title: BRPOPLPUSH
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BRPOPLPUSH` is the blocking variant of [`RPOPLPUSH`]({{< relref "/commands/rpoplpush" >}}).
When `source` contains elements, this command behaves exactly like [`RPOPLPUSH`]({{< relref "/commands/rpoplpush" >}}).
When used inside a [`MULTI`]({{< relref "/commands/multi" >}})/[`EXEC`]({{< relref "/commands/exec" >}}) block or a Lua script, this command behaves exactly like [`RPOPLPUSH`]({{< relref "/commands/rpoplpush" >}}).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/bzmpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ summary: Removes and returns a member by score from one or more sorted sets. Blo
syntax_fmt: "BZMPOP timeout numkeys key [key ...] <MIN | MAX> [COUNT\_count]"
title: BZMPOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BZMPOP` is the blocking variant of [`ZMPOP`]({{< relref "/commands/zmpop" >}}).

When any of the sorted sets contains elements, this command behaves exactly like [`ZMPOP`]({{< relref "/commands/zmpop" >}}).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/bzpopmax.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ summary: Removes and returns the member with the highest score from one or more
syntax_fmt: BZPOPMAX key [key ...] timeout
title: BZPOPMAX
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BZPOPMAX` is the blocking variant of the sorted set [`ZPOPMAX`]({{< relref "/commands/zpopmax" >}}) primitive.

It is the blocking version because it blocks the connection when there are no
Expand Down
5 changes: 5 additions & 0 deletions content/commands/bzpopmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ summary: Removes and returns the member with the lowest score from one or more s
syntax_fmt: BZPOPMIN key [key ...] timeout
title: BZPOPMIN
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


`BZPOPMIN` is the blocking variant of the sorted set [`ZPOPMIN`]({{< relref "/commands/zpopmin" >}}) primitive.

It is the blocking version because it blocks the connection when there are no
Expand Down
5 changes: 5 additions & 0 deletions content/commands/cms.merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ syntax_fmt: "CMS.MERGE destination numKeys source [source ...] [WEIGHTS weight\n
\ [weight ...]]"
title: CMS.MERGE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Merges several sketches into one sketch. All sketches must have identical width and depth. Weights can be used to multiply certain sketches. Default weight is 1.

### Parameters:
Expand Down
5 changes: 5 additions & 0 deletions content/commands/copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ summary: Copies the value of a key to a new key.
syntax_fmt: "COPY source destination [DB\_destination-db] [REPLACE]"
title: COPY
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


This command copies the value stored at the `source` key to the `destination`
key.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/dbsize.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ summary: Returns the number of keys in the database.
syntax_fmt: DBSIZE
title: DBSIZE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Return the number of keys in the currently-selected database.

## Redis Enterprise and Redis Cloud compatibility
Expand Down
5 changes: 5 additions & 0 deletions content/commands/del.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ summary: Deletes one or more keys.
syntax_fmt: DEL key [key ...]
title: DEL
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Removes the specified keys.
A key is ignored if it does not exist.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ summary: Executes a server-side Lua script.
syntax_fmt: EVAL script numkeys [key [key ...]] [arg [arg ...]]
title: EVAL
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Invoke the execution of a server-side Lua script.

The first argument is the script's source code.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/evalsha.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ summary: Executes a server-side Lua script by SHA1 digest.
syntax_fmt: EVALSHA sha1 numkeys [key [key ...]] [arg [arg ...]]
title: EVALSHA
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Evaluate a script from the server's cache by its SHA1 digest.

The server caches scripts by using the [`SCRIPT LOAD`]({{< relref "/commands/script-load" >}}) command.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ summary: Executes all commands in a transaction.
syntax_fmt: EXEC
title: EXEC
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Executes all previously queued commands in a [transaction][tt] and restores the
connection state to normal.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/exists.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ summary: Determines whether one or more keys exist.
syntax_fmt: EXISTS key [key ...]
title: EXISTS
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Returns if `key` exists.

The user should be aware that if the same existing key is mentioned in the arguments multiple times, it will be counted multiple times. So if `somekey` exists, `EXISTS somekey somekey` will return 2.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/flushall.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ summary: Removes all keys from all databases.
syntax_fmt: FLUSHALL [ASYNC | SYNC]
title: FLUSHALL
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Delete all the keys of all the existing databases, not just the currently selected one.
This command never fails.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/flushdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ summary: Remove all keys from the current database.
syntax_fmt: FLUSHDB [ASYNC | SYNC]
title: FLUSHDB
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Delete all the keys of the currently selected DB.
This command never fails.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/georadius.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,11 @@ syntax_fmt: "GEORADIUS key longitude latitude radius <M | KM | FT | MI>\n [WITH
key]"
title: GEORADIUS
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Return the members of a sorted set populated with geospatial information using [`GEOADD`]({{< relref "/commands/geoadd" >}}), which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

This manual page also covers the [`GEORADIUS_RO`]({{< relref "/commands/georadius_ro" >}}) and [`GEORADIUSBYMEMBER_RO`]({{< relref "/commands/georadiusbymember_ro" >}}) variants (see the section below for more information).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/georadiusbymember.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,11 @@ syntax_fmt: "GEORADIUSBYMEMBER key member radius <M | KM | FT | MI> [WITHCOORD]\
key]"
title: GEORADIUSBYMEMBER
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


This command is exactly like [`GEORADIUS`]({{< relref "/commands/georadius" >}}) with the sole difference that instead
of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/geosearchstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@ syntax_fmt: "GEOSEARCHSTORE destination source <FROMMEMBER\_member |\n FROMLONL
\ <M | KM | FT | MI>> [ASC | DESC] [COUNT\_count\n [ANY]] [STOREDIST]"
title: GEOSEARCHSTORE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


This command is like [`GEOSEARCH`]({{< relref "/commands/geosearch" >}}), but stores the result in destination key.

This command replaces the now deprecated [`GEORADIUS`]({{< relref "/commands/georadius" >}}) and [`GEORADIUSBYMEMBER`]({{< relref "/commands/georadiusbymember" >}}).
Expand Down
5 changes: 5 additions & 0 deletions content/commands/json.mget.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ summary: Returns the values at a path from one or more keys
syntax_fmt: JSON.MGET key [key ...] path
title: JSON.MGET
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Return the values at `path` from multiple `key` arguments

{{% warning %}}
Expand Down
5 changes: 5 additions & 0 deletions content/commands/json.mset.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ summary: Sets or updates the JSON value of one or more keys
syntax_fmt: JSON.MSET key path value [key path value ...]
title: JSON.MSET
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Set or update one or more JSON values according to the specified `key`-`path`-`value` triplets

`JSON.MSET` is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to see that some of the keys were updated while others are unchanged.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ summary: Returns all key names that match a pattern.
syntax_fmt: KEYS pattern
title: KEYS
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Returns all keys matching `pattern`.

While the time complexity for this operation is O(N), the constant times are
Expand Down
5 changes: 5 additions & 0 deletions content/commands/lmove.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ summary: Returns an element after popping it from one list and pushing it to ano
syntax_fmt: LMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT>
title: LMOVE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


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`
Expand Down
5 changes: 5 additions & 0 deletions content/commands/lmpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ summary: Returns multiple elements from a list after removing them. Deletes the
syntax_fmt: "LMPOP numkeys key [key ...] <LEFT | RIGHT> [COUNT\_count]"
title: LMPOP
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


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

`LMPOP` and [`BLMPOP`]({{< relref "/commands/blmpop" >}}) are similar to the following, more limited, commands:
Expand Down
4 changes: 4 additions & 0 deletions content/commands/mget.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ summary: Atomically returns the string values of one or more keys.
syntax_fmt: MGET key [key ...]
title: MGET
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}

Returns the values of all specified keys.
For every key that does not hold a string value or does not exist, the special
value `nil` is returned.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/mset.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ summary: Atomically creates or modifies the string values of one or more keys.
syntax_fmt: MSET key value [key value ...]
title: MSET
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Sets the given keys to their respective values.
`MSET` replaces existing values with new values, just as regular [`SET`]({{< relref "/commands/set" >}}).
See [`MSETNX`]({{< relref "/commands/msetnx" >}}) if you don't want to overwrite existing values.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/msetnx.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ summary: Atomically modifies the string values of one or more keys only when all
syntax_fmt: MSETNX key value [key value ...]
title: MSETNX
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Sets the given keys to their respective values.
`MSETNX` will not perform any operation at all even if just a single key already
exists.
Expand Down
5 changes: 5 additions & 0 deletions content/commands/multi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ summary: Starts a transaction.
syntax_fmt: MULTI
title: MULTI
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Marks the start of a [transaction][tt] block.
Subsequent commands will be queued for atomic execution using [`EXEC`]({{< relref "/commands/exec" >}}).

Expand Down
5 changes: 5 additions & 0 deletions content/commands/pfcount.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ this command are semantically different and have different performances.

HyperLogLog representation
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}



Redis HyperLogLogs are represented using a double representation: the *sparse* representation suitable for HLLs counting a small number of elements (resulting in a small number of registers set to non-zero value), and a *dense* representation suitable for higher cardinalities. Redis automatically switches from the sparse to the dense representation when needed.

Expand Down
5 changes: 5 additions & 0 deletions content/commands/pfmerge.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ summary: Merges one or more HyperLogLog values into a single key.
syntax_fmt: PFMERGE destkey [sourcekey [sourcekey ...]]
title: PFMERGE
---
{{< note >}}
This command's behavior varies in clustered Redis environments. See the [multi-key operations]({{< relref "/develop/using-commands/multi-key-operations" >}}) page for more information.
{{< /note >}}


Merge multiple HyperLogLog values into a unique value that will approximate
the cardinality of the union of the observed Sets of the source HyperLogLog
structures.
Expand Down
Loading
Loading