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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions assets/css/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -1970,6 +1970,18 @@ img.img-inline, td img[src*="#no-click"] {
visibility: visible !important;
}

/* Compatibility badges on command cards. Each badge links to the page's
compatibility section; the tooltip reuses the deprecated-tooltip styles. */
.compat-badges {
display: flex;
flex-wrap: wrap;
gap: 0.375rem;
}

.compat-badge {
@apply inline-flex items-center gap-1 px-2 py-0.5 text-xs font-semibold leading-5 text-redis-ink-900 bg-white border border-redis-pen-300 rounded-full hover:border-redis-ink-900 focus-visible:border-redis-ink-900;
}

.command-title-deprecated {
display: flex !important;
align-items: center !important;
Expand Down
4 changes: 3 additions & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ gitHubRepo = "https://github.com/redis/docs"
# the redirect tombstones published at a moved page's old URL. A parser
# switching on page_type now meets a value it has not seen, and those
# records carry a `moved_to` field, so this is a shape change (DOC-6951).
aiSchemaVersion = 2
# 3 -- adds `compatibility` to command page records: Redis Software and Redis
# Cloud support per variant, from the page's frontmatter (DOC-7160).
aiSchemaVersion = 3

# Display and sort order for client examples
clientsExamples = ["Python", "Node.js", "ioredis", "Java-Sync", "Lettuce-Sync", "Java-Async", "Java-Reactive", "Go", "C", "C#-Sync (NRedisStack)", "C#-Async (NRedisStack)", "C#-Sync (SE.Redis)", "C#-Async (SE.Redis)", "RedisVL", "PHP", "Ruby", "Rust-Sync", "Rust-Async"]
Expand Down
9 changes: 5 additions & 4 deletions content/ai-agent-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ Two consequences worth knowing if you diff the feed against the sitemap:
### Schema version

Every record carries a `schema_version` integer, and the same value appears in the
`json metadata` block of the Markdown output. It is currently **2**.
`json metadata` block of the Markdown output. It is currently **3**.

It increments only when the **shape** of a record changes: a field added, removed or
renamed, or a new value entering the [role vocabulary](#section-roles). It does **not**
change when page content changes, and it does not change when the value inside a field
changes without the field itself changing. Use `content_hash` to detect content changes;
use `schema_version` to detect when your parser might need attention.

Version 2 added the `aliases` field to page records, and a new `page_type` value,
Version 3 added the `compatibility` field to command page records. Version 2 added the `aliases` field to page records, and a new `page_type` value,
`moved`, for the [redirect records](#pages-that-have-moved) served at a moved page's
old URL. Version 1 was the initial shape: `sections`, `examples`, `content_hash`,
`page_type`, `id` and `since`.
Expand All @@ -110,7 +110,7 @@ Appending `/index.json` to a moved page's URL returns a record with

```json
{
"schema_version": 2,
"schema_version": 3,
"id": "develop/ai/agent-memory",
"title": "Moved",
"url": "https://redis.io/docs/latest/develop/ai/agent-memory/",
Expand All @@ -134,7 +134,7 @@ the page it resolves to:

```json
{
"schema_version": 2,
"schema_version": 3,
"base_url": "https://redis.io/docs/latest/",
"generated": "2026-08-07T15:00:00Z",
"count": 1061,
Expand Down Expand Up @@ -192,6 +192,7 @@ Each document contains:
| `url` | string | Canonical URL |
| `summary` | string | Short description |
| `since` | string | Redis version the command was introduced in. Present on command pages only. |
| `compatibility` | object | Redis Software and Redis Cloud support for the command. Keyed by product (`software`, `cloud`), then by variant (`general`, `standard`, `pro`, `essentials`, `active_active`, `flex`). Each value is a status (`supported`, `limited`, `workaround`, `unsupported`) or an object with `status` and `note`. A missing variant means the support isn't documented. An optional `notes` array applies to the whole command. Present on command pages only. |
| `page_type` | string | `"content"` (has prose) or `"index"` (navigation only) |
| `content_hash` | string | SHA256 hash for cache invalidation (content pages only) |
| `sections` | array | Content split by headings with semantic roles |
Expand Down
48 changes: 48 additions & 0 deletions content/commands/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Commands
linkTitle: Commands
description: Redis command reference, filterable by group and by Redis Software and Redis Cloud compatibility.
hidden: true
aliases:
- /operate/rs/references/compatibility/commands/cluster/
- /operate/rs/references/compatibility/commands/connection/
- /operate/rs/references/compatibility/commands/data-types/
- /operate/rs/references/compatibility/commands/generic/
- /operate/rs/references/compatibility/commands/pub-sub/
- /operate/rs/references/compatibility/commands/scripting/
- /operate/rs/references/compatibility/commands/server/
- /operate/rs/references/compatibility/commands/transactions/
- /operate/oss_and_stack/stack-with-enterprise/bloom/commands/
- /operate/oss_and_stack/stack-with-enterprise/json/commands/
- /operate/oss_and_stack/stack-with-enterprise/search/commands/
- /operate/oss_and_stack/stack-with-enterprise/timeseries/commands/
# The filtered view each alias above lands on. Hugo aliases can't carry a query
# string, so layouts/alias.html reads this list and redirects with the query;
# readers without JavaScript land on the unfiltered list. Every alias needs an
# entry here or the build warns; an empty query lands on the unfiltered list.
alias_query:
- from: /operate/rs/references/compatibility/commands/cluster
query: group=cluster
- from: /operate/rs/references/compatibility/commands/connection
query: group=connection
- from: /operate/rs/references/compatibility/commands/data-types
query: group=array,bitmap,geo,hash,hyperloglog,list,set,sorted-set,stream,string,vector_set
- from: /operate/rs/references/compatibility/commands/generic
query: group=generic
- from: /operate/rs/references/compatibility/commands/pub-sub
query: group=pubsub
- from: /operate/rs/references/compatibility/commands/scripting
query: group=scripting
- from: /operate/rs/references/compatibility/commands/server
query: group=server
- from: /operate/rs/references/compatibility/commands/transactions
query: group=transactions
- from: /operate/oss_and_stack/stack-with-enterprise/bloom/commands
query: group=bf,cf,cms,topk,tdigest
- from: /operate/oss_and_stack/stack-with-enterprise/json/commands
query: group=json
- from: /operate/oss_and_stack/stack-with-enterprise/search/commands
query: group=search,suggestion
- from: /operate/oss_and_stack/stack-with-enterprise/timeseries/commands
query: group=timeseries
---
13 changes: 10 additions & 3 deletions content/commands/acl-cat.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: supported
active_active: supported
cloud:
standard: supported
active_active: supported
notes:
- Not supported for [scripts](/content/develop/programmability/_index.md).
complexity: O(1) since the categories and commands are a fixed set.
description: Lists the ACL categories, or the commands inside a category.
group: server
Expand Down Expand Up @@ -129,9 +138,7 @@ List only the commands in the given ACL category. If omitted, all categories are

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | Not supported for [scripts](/content/develop/programmability/_index.md). |
{{< command-compatibility >}}

## Return information

Expand Down
11 changes: 8 additions & 3 deletions content/commands/acl-deluser.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: unsupported
active_active: unsupported
cloud:
standard: unsupported
active_active: unsupported
complexity: O(1) amortized time considering the typical user.
description: Deletes ACL users, and terminates their connections.
group: server
Expand Down Expand Up @@ -61,9 +68,7 @@ One or more usernames to delete.

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | |
{{< command-compatibility >}}

## Return information

Expand Down
13 changes: 10 additions & 3 deletions content/commands/acl-dryrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: supported
active_active: supported
cloud:
standard: supported
active_active: supported
notes:
- Might reply with "unknown user" for LDAP users even if `AUTH` succeeds.
complexity: O(1).
description: Simulates the execution of a command by a user, without executing the
command.
Expand Down Expand Up @@ -81,9 +90,7 @@ The arguments to pass to the tested command.

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | Might reply with "unknown user" for LDAP users even if `AUTH` succeeds. |
{{< command-compatibility >}}

## Return information

Expand Down
11 changes: 8 additions & 3 deletions content/commands/acl-genpass.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: unsupported
active_active: unsupported
cloud:
standard: unsupported
active_active: unsupported
complexity: O(1)
description: Generates a pseudorandom, secure password that can be used to identify
ACL users.
Expand Down Expand Up @@ -84,9 +91,7 @@ The amount of entropy, in bits, for the generated password. Defaults to 256.

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | |
{{< command-compatibility >}}

## Return information

Expand Down
13 changes: 10 additions & 3 deletions content/commands/acl-getuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: supported
active_active: supported
cloud:
standard: supported
active_active: supported
notes:
- Not supported for [scripts](/content/develop/programmability/_index.md).
complexity: O(N). Where N is the number of password, command and pattern rules that
the user has.
description: Lists the ACL rules of a user.
Expand Down Expand Up @@ -91,9 +100,7 @@ Here's an example configuration for a user

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | Not supported for [scripts](/content/develop/programmability/_index.md). |
{{< command-compatibility >}}

## Return information

Expand Down
13 changes: 10 additions & 3 deletions content/commands/acl-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ categories:
command_flags:
- loading
- stale
compatibility:
software:
standard: supported
active_active: supported
cloud:
standard: supported
active_active: supported
notes:
- Not supported for [scripts](/content/develop/programmability/_index.md).
complexity: O(1)
description: Returns helpful text about the different subcommands.
group: server
Expand All @@ -30,9 +39,7 @@ The `ACL HELP` command returns a helpful text describing the different subcomman

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | Not supported for [scripts](/content/develop/programmability/_index.md). |
{{< command-compatibility >}}

## Return information

Expand Down
13 changes: 10 additions & 3 deletions content/commands/acl-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: supported
active_active: supported
cloud:
standard: supported
active_active: supported
notes:
- Not supported for [scripts](/content/develop/programmability/_index.md).
complexity: O(N). Where N is the number of configured users.
description: Dumps the effective rules in ACL file format.
group: server
Expand Down Expand Up @@ -49,9 +58,7 @@ configuration file if you wish (but make sure to check [`ACL SAVE`](/content/com

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | Not supported for [scripts](/content/develop/programmability/_index.md). |
{{< command-compatibility >}}

## Return information

Expand Down
11 changes: 8 additions & 3 deletions content/commands/acl-load.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: unsupported
active_active: unsupported
cloud:
standard: unsupported
active_active: unsupported
complexity: O(N). Where N is the number of configured users.
description: Reloads the rules from the configured ACL file.
group: server
Expand Down Expand Up @@ -54,9 +61,7 @@ Make sure you save a backup of your ACL file. This is the only way to preserve c

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | |
{{< command-compatibility >}}

## Return information

Expand Down
11 changes: 8 additions & 3 deletions content/commands/acl-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: unsupported
active_active: unsupported
cloud:
standard: unsupported
active_active: unsupported
complexity: O(N) with N being the number of entries shown.
description: Lists recent security events generated due to ACL rules.
group: server
Expand Down Expand Up @@ -110,9 +117,7 @@ Each log entry is composed of the following fields:

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | |
{{< command-compatibility >}}

## Return information

Expand Down
11 changes: 8 additions & 3 deletions content/commands/acl-save.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ command_flags:
- noscript
- loading
- stale
compatibility:
software:
standard: unsupported
active_active: unsupported
cloud:
standard: unsupported
active_active: unsupported
complexity: O(N). Where N is the number of configured users.
description: Saves the effective ACL rules in the configured ACL file.
group: server
Expand Down Expand Up @@ -48,9 +55,7 @@ option), this command will save the currently defined ACLs from the server memor

## Redis Software and Redis Cloud compatibility

| Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
|:----------------------|:-----------------|:------|
| <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | <span title="Not supported">&#x274c; Standard</span><br /><span title="Not supported"><nobr>&#x274c; Active-Active</nobr></span> | |
{{< command-compatibility >}}

## Return information

Expand Down
Loading
Loading