Skip to content

Add RESP2 to RESP3 replies migration guide #2513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add RESP2 to RESP3 replies migration guide #2513

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dfacb6b
Add RESP2 to RESP3 replies migration guide
uglide Aug 11, 2023
a63876d
Fix formatting issues
uglide Aug 11, 2023
74f856e
Update link title
uglide Aug 11, 2023
3f80bcd
Add missing commands
uglide Sep 1, 2023
e68960e
Apply suggestions from code review
uglide Dec 19, 2023
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
119 changes: 119 additions & 0 deletions docs/reference/resp2-to-resp3-replies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
title: "RESP2 to RESP3 replies migration guide"
linkTitle: "RESP2 to RESP3 replies migration guide"
weight: 4
description: RESP2 to RESP3 replies reference for clients developers
aliases:
- /topics/resp2-to-resp3-replies/
---

In the journey from RESP2 to [RESP3](https://redis.io/docs/reference/protocol-spec/), one of the primary motivations was
to streamline the developer experience by simplifying response parsing. Over time, it became evident that developers
frequently performed specific data transformations on RESP2 replies. Addressing these transformations directly at the
protocol level not only reduces the overhead for developers but also ensures a more consistent and efficient data
handling process. This documentation provides a reference for developers to migrate their clients from RESP2 to RESP3.

### Command Replies Comparison
- If you see any missing commands, please [open an issue](https://github.com/redis/redis-doc/issues/new?title=RESP2-to-RESP3%20command%20is%20missing)
- `null` was "promoted" from a subtype of `BlobString` and `Array` to its own type, these changes are not included in this list.
- The types are described using [“TypeScript like” syntax](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)


### Cluster Management
| **Command** | **RESP2 Reply** | **RESP3 Reply** |
|----------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| CLUSTER SLOTS | Array<\[number, number, ...\[BlobString, number, BlobString, Array]]> | Array<\[number, number, ...\[BlobString, number, BlobString, Map\<BlobString, BlobString>]]> |
| CLUSTER SHARDS | Array | Map |

### Connection management
| **Command** | **RESP2 Reply** | **RESP3 Reply** |
|---------------------------|-----------------|-----------------|
| CLIENT INFO | BlobString | VerbatimString |
| CLIENT LIST | BlobString | VerbatimString |


### Generic
| | | |
|-------------|-----------------|------------------------|
| **Command** | **RESP2 Reply** | **RESP3 Reply** |
| RANDOMKEY | BlobString | null &#124; BlobString |

### Geo
| Command | RESP2 Reply | RESP3 Reply |
|-----------------------------|--------------------|----------------|
| GEORADIUS WITHCOORD | \[..., BlobString] | \[..., Double] |
| GEORADIUSBYMEMBER WITHCOORD | \[..., BlobString] | \[..., Double] |
| GEOSEARCH WITHCOORD | \[..., BlobString] | \[..., Double] |


### Hash
| | | |
|----------------------|--------------------|----------------------------------|
| **Command** | **RESP2 Reply** | **RESP3 Reply** |
| **Hash** | | |
| HGETALL | Array | Map |
| HRANDFIELD WITHVALUE | Array\<BlobString> | Array<\[BlobString, BlobString]> |

### Scripting and Functions
| Command | RESP2 Reply | RESP3 Reply |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| FUNCTION LIST | Array<\[‘library\_name’, BlobString, ‘engine’, BlobString, ‘functions’, Array<\[‘name’, BlobString, ‘description’, BlobString &#124; null, ‘flags’, Array\<BlobString>]>]> | Array<\[{ library\_name: BlobString, engine: BlobString, functions: Array<{ name: BlobString, description: BlobString &#124; null, flags: Set\<BlobString> }> }]> |
| FUNCTION LIST WITHCODE | Array<\[‘library\_name’, BlobString, ‘engine’, BlobString, ‘functions’, Array<\[‘name’, BlobString, ‘description’, BlobString &#124; null, ‘flags’, Array\<BlobString>]>, ‘library\_code’, BlobString]> | Array<\[{ library\_name: BlobString, engine: BlobString, functions: Array<{ name: BlobString, description: BlobString &#124; null, flags: Set\<BlobString> }>, library\_code: BlobString }]> |


### Server Management
| Command** | RESP2 Reply | RESP3 Reply |
|--------------|------------------------------------------------------------------------------------------------------|----------------------------------------------|
| MODULE LIST | Array<\[BlobString<‘name’>, BlobString, BlobString<‘version’>, number]> | Array<{ name: BlobString, version: number }> |
| MEMORY STATS | Array | Map |
| ACL LOG | \[..., ‘age-seconds’, BlobString, …] | { …, ‘age-seconds’: Double } |
| ACL GETUSER | Array | Map |
| COMMAND | Array<\[BlobString,number,Set\<BlobString>,number,number,number,Set\<BlobString>,Set\<BlobString>,]> | |

### Sentinel
| Command | RESP2 Reply | RESP3 Reply |
|---------------------|-------------|-------------|
| SENTINEL CONFIG GET | Array | Map |

### String
| Command | RESP2 Reply | RESP3 Reply |
|---------|-------------|-------------|
| LCS IDX | Array | Map |

### Set
| Command | RESP2 Reply | RESP3 Reply |
|----------------------------------------------------------------------|-------------|-------------|
| SINTER <br/>SPOP COUNT<br/>SMEMBERS<br/>SRANDMEMBER COUNT<br/>SUNION | Array | Set |

### Sorted Set
| Command | RESP2 Reply | RESP3 Reply |
|--------------------------|-------------------------------------------------------------|---------------------------------------------------------|
| ZADD INCR | BlobString | Double |
| ZDIFF WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double]> |
| ZINCRBY | BlobString | Double |
| ZINTER WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double]> |
| ZMPOP | null &#124; \[BlobString, Array<\[BlobString, BlobString]>] | null &#124; \[BlobString, Array<\[BlobString, Double]>] |
| ZMSCORE | Array\<null &#124; BlobString> | Array\<null &#124; Double> |
| ZRANDMEMBER WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double]> |
| ZSCORE | BlobString | Double |
| ZUNION WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double]> |
| ZRANK WITHSCORE | \[number, BlobString] | \[number, Double] |
| ZREVRANK WITHSCORE | \[number, BlobString] | \[number, Double] |
| ZRANGE WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double] |
| ZRANGEBYSCORE WITHSCORES | Array\<BlobString> | Array<\[BlobString, Double] |
| ZMPOP | \[BlobString, Array<\[BlobString, BlobString]>] | \[BlobString, Array<\[BlobString, Double]>] |
| BZPOPMAX | null &#124; \[BlobString, BlobString, BlobString] | null &#124; \[BlobString, BlobString, Double] |
| BZPOPMIN | null &#124; \[BlobString, BlobString, BlobString] | null &#124; \[BlobString, BlobString, Double] |
| ZPOPMIN | null &#124; \[BlobString, BlobString] | null &#124; \[BlobString, Double] |
| ZPOPMIN COUNT | null &#124; Array\<BlobString\> | null &#124; Array<\[BlobString, Double]> |
| ZPOPMAX | null &#124; \[BlobString, BlobString] | null &#124; \[BlobString, Double] |
| ZPOPMAX COUNT | null &#124; Array\<BlobString\> | null &#124; Array<\[BlobString, Double]> |

### Stream
| Command | RESP2 Reply | RESP3 Reply |
|-----------------|-----------------------------------------------------------------------|-------------------------------------------------------------------|
| XINFO CONSUMERS | Array | Map |
| XINFO GROUPS | Array | Map |
| XINFO STREAM | Array | Map |
| XREAD | Array<\[BlobString, \[BlobString, Array<\[BlobString, BlobString]>]]> | Map\<BlobString, \[BlobString, Array<\[BlobString, BlobString]>]> |
| XREADGROUP | Array<\[BlobString, \[BlobString, Array<\[BlobString, BlobString]>]]> | Map\<BlobString, \[BlobString, Array<\[BlobString, BlobString]>]> |