summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Hofer <1058012+hofrob@users.noreply.github.com>2022-11-07 08:20:54 +0100
committerGitHub <noreply@github.com>2022-11-07 09:20:54 +0200
commitab922dbf3c7544fab4fe6247e1f3d57958ffd767 (patch)
treee49c462ac0512f806c17c58f3738cca5c2d51f5d
parent16270e4bb5fcaebe8a8992fc2b2ccbd9d57b8c3e (diff)
downloadredis-py-ab922dbf3c7544fab4fe6247e1f3d57958ffd767.tar.gz
fix docs for password protected socket access (#2378)
Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
-rw-r--r--CHANGES1
-rw-r--r--redis/asyncio/client.py2
-rw-r--r--redis/asyncio/connection.py2
-rwxr-xr-xredis/client.py2
-rw-r--r--redis/cluster.py2
-rwxr-xr-xredis/connection.py2
6 files changed, 6 insertions, 5 deletions
diff --git a/CHANGES b/CHANGES
index f5c267b..80423cc 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,4 @@
+ * Documentation fix: password protected socket connection (#2374)
* Allow `timeout=None` in `PubSub.get_message()` to wait forever
* add `nowait` flag to `asyncio.Connection.disconnect()`
* Update README.md links
diff --git a/redis/asyncio/client.py b/redis/asyncio/client.py
index 0e40ed7..6e66faa 100644
--- a/redis/asyncio/client.py
+++ b/redis/asyncio/client.py
@@ -106,7 +106,7 @@ class Redis(
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
- unix://[[username]:[password]]@/path/to/socket.sock?db=0
+ unix://[username@]/path/to/socket.sock?db=0[&password=password]
Three URL schemes are supported:
diff --git a/redis/asyncio/connection.py b/redis/asyncio/connection.py
index b64bd12..1288bb6 100644
--- a/redis/asyncio/connection.py
+++ b/redis/asyncio/connection.py
@@ -1194,7 +1194,7 @@ class ConnectionPool:
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
- unix://[[username]:[password]]@/path/to/socket.sock?db=0
+ unix://[username@]/path/to/socket.sock?db=0[&password=password]
Three URL schemes are supported:
diff --git a/redis/client.py b/redis/client.py
index 75a0dac..c1fe9cb 100755
--- a/redis/client.py
+++ b/redis/client.py
@@ -863,7 +863,7 @@ class Redis(AbstractRedis, RedisModuleCommands, CoreCommands, SentinelCommands):
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
- unix://[[username]:[password]]@/path/to/socket.sock?db=0
+ unix://[username@]/path/to/socket.sock?db=0[&password=password]
Three URL schemes are supported:
diff --git a/redis/cluster.py b/redis/cluster.py
index cee578b..cb3b2a6 100644
--- a/redis/cluster.py
+++ b/redis/cluster.py
@@ -388,7 +388,7 @@ class RedisCluster(AbstractRedisCluster, RedisClusterCommands):
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
- unix://[[username]:[password]]@/path/to/socket.sock?db=0
+ unix://[username@]/path/to/socket.sock?db=0[&password=password]
Three URL schemes are supported:
diff --git a/redis/connection.py b/redis/connection.py
index 2e33e31..fecb06b 100755
--- a/redis/connection.py
+++ b/redis/connection.py
@@ -1221,7 +1221,7 @@ class ConnectionPool:
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
- unix://[[username]:[password]]@/path/to/socket.sock?db=0
+ unix://[username@]/path/to/socket.sock?db=0[&password=password]
Three URL schemes are supported: