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
4 changes: 1 addition & 3 deletions content/commands/bitcount.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,7 @@ web site simply calling the `BITCOUNT` command against the bitmap.

A similar pattern where user IDs are used instead of days is described
in the article called "[Fast easy realtime metrics using Redis
bitmaps][hbgc212fermurb]".

[hbgc212fermurb]: http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps
bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps)".

### Performance considerations

Expand Down
4 changes: 1 addition & 3 deletions content/commands/bitop.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,7 @@ Different bitmaps can be combined in order to obtain a target bitmap where
the population counting operation is performed.

See the article called "[Fast easy realtime metrics using Redis
bitmaps][hbgc212fermurb]" for an interesting use cases.

[hbgc212fermurb]: http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps
bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps)" for an interesting use cases.

### Performance considerations

Expand Down
4 changes: 1 addition & 3 deletions content/commands/brpop.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,10 @@ 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.

See the [BLPOP documentation][cb] for the exact semantics, since `BRPOP` is
See the [BLPOP documentation]({{< relref "/commands/blpop" >}}) for the exact semantics, since `BRPOP` is
identical to [`BLPOP`]({{< relref "/commands/blpop" >}}) with the only difference being that it pops elements from
the tail of a list instead of popping from the head.

[cb]: /commands/blpop

## Required arguments

<details open><summary><code>key [key ...]</code></summary>
Expand Down
4 changes: 1 addition & 3 deletions content/commands/bzpopmax.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,10 @@ non-empty, with the given keys being checked in the order that they are given.
The `timeout` argument is interpreted as a double value specifying the maximum
number of seconds to block. A timeout of zero can be used to block indefinitely.

See the [BZPOPMIN documentation][cb] for the exact semantics, since `BZPOPMAX`
See the [BZPOPMIN documentation]({{< relref "/commands/bzpopmin" >}}) for the exact semantics, since `BZPOPMAX`
is identical to [`BZPOPMIN`]({{< relref "/commands/bzpopmin" >}}) with the only difference being that it pops members
with the highest scores instead of popping the ones with the lowest scores.

[cb]: /commands/bzpopmin

## Required arguments

<details open><summary><code>key [key ...]</code></summary>
Expand Down
4 changes: 1 addition & 3 deletions content/commands/bzpopmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,10 @@ non-empty, with the given keys being checked in the order that they are given.
The `timeout` argument is interpreted as a double value specifying the maximum
number of seconds to block. A timeout of zero can be used to block indefinitely.

See the [BLPOP documentation][cl] for the exact semantics, since `BZPOPMIN` is
See the [BLPOP documentation]({{< relref "/commands/blpop" >}}) for the exact semantics, since `BZPOPMIN` is
identical to [`BLPOP`]({{< relref "/commands/blpop" >}}) with the only difference being the data structure being
popped from.

[cl]: /commands/blpop

## Required arguments

<details open><summary><code>key [key ...]</code></summary>
Expand Down
4 changes: 1 addition & 3 deletions content/commands/command-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,7 @@ The following keys may be included in the mapped reply:
1. The Redis version that the entry applies to.
2. The description of the change.
* **arguments:** an array of maps that describe the command's arguments.
Please refer to the [Redis command arguments][td] page for more information.

[td]: /develop/reference/command-arguments
Please refer to the [Redis command arguments]({{< relref "/develop/reference/command-arguments" >}}) page for more information.

## Optional arguments

Expand Down
25 changes: 10 additions & 15 deletions content/commands/command.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ The exact number of elements in the array depends on the server's version.
1. First key
1. Last key
1. Step
1. [ACL categories][ta] (as of Redis 6.0)
1. [Tips][tb] (as of Redis 7.0)
1. [Key specifications][td] (as of Redis 7.0)
1. [ACL categories]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) (as of Redis 6.0)
1. [Tips]({{< relref "/develop/reference/command-tips.md" >}}) (as of Redis 7.0)
1. [Key specifications]({{< relref "/develop/reference/key-specs.md" >}}) (as of Redis 7.0)
1. Subcommands (as of Redis 7.0)

## Name
Expand Down Expand Up @@ -96,7 +96,7 @@ Command flags are an array. It can contain the following simple strings (status
This flag is used for monitoring latency with the [`LATENCY`]({{< relref "/commands/latency" >}}) command.
* **loading:** the command is allowed while the database is loading.
* **movablekeys:** the _first key_, _last key_, and _step_ values don't determine all key positions.
Clients need to use [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) or [key specifications][td] in this case.
Clients need to use [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) or [key specifications]({{< relref "/develop/reference/key-specs.md" >}}) in this case.
See below for more details.
* **no_auth:** executing the command doesn't require authentication.
* **no_async_loading:** the command is denied during asynchronous loading (that is when a replica uses disk-less `SWAPDB SYNC`, and allows access to the old dataset).
Expand All @@ -105,12 +105,12 @@ Command flags are an array. It can contain the following simple strings (status
* **noscript:** the command can't be called from [scripts]({{< relref "/develop/programmability/eval-intro" >}}) or [functions]({{< relref "/develop/programmability/functions-intro" >}}).
* **pubsub:** the command is related to [Redis Pub/Sub]({{< relref "/develop/pubsub" >}}).
* **random**: the command returns random results, which is a concern with verbatim script replication.
As of Redis 7.0, this flag is a [command tip][tb].
As of Redis 7.0, this flag is a [command tip]({{< relref "/develop/reference/command-tips.md" >}}).
* **readonly:** the command doesn't modify data.
* **sort_for_script:** the command's output is sorted when called from a script.
* **skip_monitor:** the command is not shown in [`MONITOR`]({{< relref "/commands/monitor" >}})'s output.
* **skip_slowlog:** the command is not shown in [`SLOWLOG`]({{< relref "/commands/slowlog" >}})'s output.
As of Redis 7.0, this flag is a [command tip][tb].
As of Redis 7.0, this flag is a [command tip]({{< relref "/develop/reference/command-tips.md" >}}).
* **stale:** the command is allowed while a replica has stale data.
* **write:** the command may modify data.

Expand Down Expand Up @@ -146,7 +146,7 @@ You can use the [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}})
As of Redis 7.0, clients can use the [key specifications](#key-specifications) to identify the positions of key names.
The only commands that require using [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) are [`SORT`]({{< relref "/commands/sort" >}}) and [`MIGRATE`]({{< relref "/commands/migrate" >}}) for clients that parse keys' specifications.

For more information, please refer to the [key specifications page][tr].
For more information, please refer to the [key specifications page]({{< relref "/develop/reference/key-specs.md" >}}).

## First key

Expand Down Expand Up @@ -200,33 +200,28 @@ Unlike [`MGET`]({{< relref "/commands/mget" >}}), which uses a step value of _1_
## ACL categories

This is an array of simple strings that are the ACL categories to which the command belongs.
Please refer to the [Access Control List][ta] page for more information.
Please refer to the [Access Control List]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) page for more information.

## Command tips

Helpful information about the command.
To be used by clients/proxies.

Please check the [Command tips][tb] page for more information.
Please check the [Command tips]({{< relref "/develop/reference/command-tips.md" >}}) page for more information.

## Key specifications

This is an array consisting of the command's key specifications.
Each element in the array is a map describing a method for locating keys in the command's arguments.

For more information please check the [key specifications page][td].
For more information please check the [key specifications page]({{< relref "/develop/reference/key-specs.md" >}}).

## Subcommands

This is an array containing all of the command's subcommands, if any.
Some Redis commands have subcommands (e.g., the `REWRITE` subcommand of [`CONFIG`]({{< relref "/commands/config" >}})).
Each element in the array represents one subcommand and follows the same specifications as those of `COMMAND`'s reply.

[ta]: /operate/oss_and_stack/management/security/acl
[tb]: /develop/reference/command-tips.md
[td]: /develop/reference/key-specs.md
[tr]: /develop/reference/key-specs.md

## Examples

The following is `COMMAND`'s output for the [`GET`]({{< relref "/commands/get" >}}) command:
Expand Down
4 changes: 1 addition & 3 deletions content/commands/discard.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@ summary: Discards a transaction.
syntax_fmt: DISCARD
title: DISCARD
---
Flushes all previously queued commands in a [transaction][tt] and restores the
Flushes all previously queued commands in a [transaction]({{< relref "/develop/using-commands/transactions" >}}) and restores the
connection state to normal.

[tt]: /develop/interact/transactions

If [`WATCH`]({{< relref "/commands/watch" >}}) was used, `DISCARD` unwatches all keys watched by the connection.

## Redis Software and Redis Cloud compatibility
Expand Down
8 changes: 2 additions & 6 deletions content/commands/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,11 @@ This command's behavior varies in clustered Redis environments. See the [multi-k
{{< /note >}}


Executes all previously queued commands in a [transaction][tt] and restores the
Executes all previously queued commands in a [transaction]({{< relref "/develop/using-commands/transactions" >}}) and restores the
connection state to normal.

[tt]: /develop/interact/transactions

When using [`WATCH`]({{< relref "/commands/watch" >}}), `EXEC` will execute commands only if the watched keys were
not modified, allowing for a [check-and-set mechanism][ttc].

[ttc]: /develop/interact/transactions#cas
not modified, allowing for a [check-and-set mechanism]({{< relref "/develop/using-commands/transactions#cas" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
5 changes: 1 addition & 4 deletions content/commands/expire.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,9 @@ inherit all the characteristics of `Key_B`.

Note that calling `EXPIRE`/[`PEXPIRE`]({{< relref "/commands/pexpire" >}}) with a non-positive timeout or
[`EXPIREAT`]({{< relref "/commands/expireat" >}})/[`PEXPIREAT`]({{< relref "/commands/pexpireat" >}}) with a time in the past will result in the key being
[deleted][del] rather than expired (accordingly, the emitted [key event][ntf]
[deleted]({{< relref "/commands/del" >}}) rather than expired (accordingly, the emitted [key event]({{< relref "/develop/pubsub/keyspace-notifications" >}})
will be `del`, not `expired`).

[del]: /commands/del
[ntf]: /develop/use/keyspace-notifications

## Required arguments

<details open><summary><code>key</code></summary>
Expand Down
4 changes: 1 addition & 3 deletions content/commands/expireat.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,9 @@ title: EXPIREAT
---
`EXPIREAT` has the same effect and semantic as [`EXPIRE`]({{< relref "/commands/expire" >}}), but instead of
specifying the number of seconds representing the TTL (time to live), it takes
an absolute [Unix timestamp][hewowu] (seconds since January 1, 1970). A
an absolute [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time) (seconds since January 1, 1970). A
timestamp in the past will delete the key immediately.

[hewowu]: http://en.wikipedia.org/wiki/Unix_time

Please for the specific semantics of the command refer to the documentation of
[`EXPIRE`]({{< relref "/commands/expire" >}}).

Expand Down
4 changes: 1 addition & 3 deletions content/commands/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Here is the meaning of all fields in the **memory** section:

* `used_memory`: Total number of bytes allocated by Redis using its
allocator (either standard **libc**, **jemalloc**, or an alternative
allocator such as [**tcmalloc**][hcgcpgp])
allocator such as [**tcmalloc**](http://code.google.com/p/google-perftools/))
* `used_memory_human`: Human readable representation of previous value
* `used_memory_rss`: Number of bytes that Redis allocated as seen by the
operating system (a.k.a resident set size). This is the number reported by
Expand Down Expand Up @@ -648,8 +648,6 @@ It won't be included when `INFO` or `INFO ALL` are called, and it is returned on
* `allocator_resident_lua`: Total bytes resident (RSS) in the allocator specifically for Lua. This includes pages that can be released to the OS (by `MEMORY PURGE`, or just waiting).
* `allocator_frag_bytes_lua`: Delta between `allocator_active_lua` and `allocator_allocated_lua`.

[hcgcpgp]: http://code.google.com/p/google-perftools/

**A note about the word slave used in this man page**: Starting with Redis 5, if not for backward compatibility, the Redis project no longer uses the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated.

**Modules generated sections**: Starting with Redis 6, modules can inject their information into the `INFO` command. These are excluded by default even when the `all` argument is provided (it will include a list of loaded modules but not their generated info fields). To get these you must use either the `modules` argument or `everything`.
Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-doctor.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,7 @@ I have a few advices for you:

**Note:** the doctor has erratic psychological behaviors, so we recommend interacting with it carefully.

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,7 @@ first graphed event happened 15 seconds ago.
The graph is normalized in the min-max scale so that the zero (the underscore
in the lower row) is the minimum, and a # in the higher row is the maximum.

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ title: LATENCY HELP
The `LATENCY HELP` command returns a helpful text describing the different
subcommands.

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,7 @@ The latency event to return the history for.
2) (integer) 1001
```

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ OK
4) (integer) 1001
```

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/latency-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ Valid values for `event` are:
* `fork`
* `rdb-unlink-temp-file`

For more information refer to the [Latency Monitoring Framework page][lm].

[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md
For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}).

## Optional arguments

Expand Down
4 changes: 1 addition & 3 deletions content/commands/multi.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,9 @@ This command's behavior varies in clustered Redis environments. See the [multi-k
{{< /note >}}


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

[tt]: /develop/interact/transactions

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
Expand Down
4 changes: 1 addition & 3 deletions content/commands/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,7 @@ If `ttl` is 0 the key is created without any expire, otherwise the specified
expire time (in milliseconds) is set.

If the `ABSTTL` modifier was used, `ttl` should represent an absolute
[Unix timestamp][hewowu] (in milliseconds) in which the key will expire.

[hewowu]: http://en.wikipedia.org/wiki/Unix_time
[Unix timestamp](http://en.wikipedia.org/wiki/Unix_time) (in milliseconds) in which the key will expire.

For eviction purposes, you may use the `IDLETIME` or `FREQ` modifiers. See
[`OBJECT`]({{< relref "/commands/object" >}}) for more information.
Expand Down
4 changes: 1 addition & 3 deletions content/commands/setbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ the entire bitmap.

Bitmaps are not an actual data type, but a set of bit-oriented operations
defined on the String type (for more information refer to the
[Bitmaps section of the Data Types Introduction page][ti]). This means that
[Bitmaps section of the Data Types Introduction page]({{< relref "/develop/data-types#bitmaps" >}})). This means that
bitmaps can be used with string commands, and most importantly with [`SET`]({{< relref "/commands/set" >}}) and
[`GET`]({{< relref "/commands/get" >}}).

Expand Down Expand Up @@ -147,8 +147,6 @@ native programming language. Symmetrically, it is also possible to set an entire
bitmap by performing the bits-to-bytes encoding in the client and calling [`SET`]({{< relref "/commands/set" >}})
with the resultant string.

[ti]: /develop/data-types-intro#bitmaps

### Pattern: setting multiple bits

`SETBIT` excels at setting single bits, and can be called several times when
Expand Down
8 changes: 2 additions & 6 deletions content/commands/sort.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,19 +123,15 @@ syntax_fmt: "SORT key [BY\_pattern] [LIMIT\_offset count] [GET\_pattern [GET pat
\ ...]] [ASC | DESC] [ALPHA] [STORE\_destination]"
title: SORT
---
Returns or stores the elements contained in the [list][tdtl], [set][tdts] or
[sorted set][tdtss] at `key`.
Returns or stores the elements contained in the [list]({{< relref "/develop/data-types#lists" >}}), [set]({{< relref "/develop/data-types#set" >}}) or
[sorted set]({{< relref "/develop/data-types#sorted-sets" >}}) at `key`.

There is also the [`SORT_RO`]({{< relref "/commands/sort_ro" >}}) read-only variant of this command.

By default, sorting is numeric and elements are compared by their value
interpreted as double precision floating point number.
This is `SORT` in its simplest form:

[tdtl]: /develop/data-types#lists
[tdts]: /develop/data-types#set
[tdtss]: /develop/data-types#sorted-sets

```
SORT mylist
```
Expand Down
4 changes: 1 addition & 3 deletions content/commands/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ stream from the master. It has been replaced in newer versions of Redis by
[`PSYNC`]({{< relref "/commands/psync" >}}).

For more information about replication in Redis please check the
[replication page][tr].

[tr]: /operate/oss_and_stack/management/replication
[replication page]({{< relref "/operate/oss_and_stack/management/replication" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
4 changes: 1 addition & 3 deletions content/commands/unwatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ summary: Forgets about watched keys of a transaction.
syntax_fmt: UNWATCH
title: UNWATCH
---
Flushes all the previously watched keys for a [transaction][tt].

[tt]: /develop/interact/transactions
Flushes all the previously watched keys for a [transaction]({{< relref "/develop/using-commands/transactions" >}}).

If you call [`EXEC`]({{< relref "/commands/exec" >}}) or [`DISCARD`]({{< relref "/commands/discard" >}}), there's no need to manually call `UNWATCH`.

Expand Down
4 changes: 1 addition & 3 deletions content/commands/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ This command's behavior varies in clustered Redis environments. See the [multi-k


Marks the given keys to be watched for conditional execution of a
[transaction][tt].

[tt]: /develop/interact/transactions
[transaction]({{< relref "/develop/using-commands/transactions" >}}).

## Redis Software and Redis Cloud compatibility

Expand Down
Loading
Loading