Skip to content

Commit

Permalink
update errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ofekshenawa committed Sep 3, 2024
1 parent 7b56618 commit 376a37f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ rdb := redis.NewClient(&redis.Options{
```

#### Unstable RESP3 Structures for RediSearch Commands
When connecting with Redis using RESP3 protocol, it's important to note that some response structures aren't final yet. This is the case for more complex structures in FT.SEARCH, FT.AGGREGATE, FT.Info, FT.SpellCheck and FT.SynDump. We recommend using RESP2 when using these commands, but we plan to stabilize the RESP3-based APIs in the coming versions. You can find more guidance in the upcoming release notes.
When integrating Redis with application functionalities using RESP3, it's important to note that some response structures aren't final yet. This is especially true for more complex structures like search and query results. We recommend using RESP2 when using the search and query capabilities, but we plan to stabilize the RESP3-based API-s in the coming versions. You can find more guidance in the upcoming release notes.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ func (c *baseClient) assertUnstableCommand(cmd Cmder) bool {
if c.opt.UnstableResp3SearchModule {
return true
} else {
panic("Some RESP3 results for Redis Query Engine responses may change. Refer to the readme for guidance")
panic("RESP3 responses for this command are disabled because they may still change. Please set the flag UnstableResp3SearchModule . See the [README](https://github.com/redis/go-redis/blob/master/README.md) and the release notes for guidance.")
}
default:
return false
Expand Down

0 comments on commit 376a37f

Please sign in to comment.