From 7bbef7e05aa35fc77837a315ba7364e6777aff9f Mon Sep 17 00:00:00 2001 From: lowercase00 <21188280+lowercase00@users.noreply.github.com> Date: Sat, 25 Feb 2023 21:53:25 -0300 Subject: [PATCH] docs: add warning of `decode_responses` (#1833) --- docs/docs/connections.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/connections.md b/docs/docs/connections.md index 8e563d9e..87aba212 100644 --- a/docs/docs/connections.md +++ b/docs/docs/connections.md @@ -162,3 +162,17 @@ q = Queue(connection=conn) Setting a `socket_timeout` with a lower value than the `default_worker_ttl` will cause a `TimeoutError` since it will interrupt the worker while it gets new jobs from the queue. + + +### Encoding / Decoding + +The encoding and decoding of Redis objects occur in multiple locations within the codebase, +which means that the `decode_responses=True` argument of the Redis connection is not currently supported. + +```python +from redis import Redis +from rq import Queue + +conn = Redis(..., decode_responses=True) # This is not supported +q = Queue(connection=conn) +```