fix docs for password protected socket access (#2378)

Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
redis · Nov 7, 2022 · ab922db · ab922db
1 parent 16270e4
commit ab922db
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 5 deletions.
diff --git 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
@@ -106,7 +106,7 @@ def from_url(cls, url: str, **kwargs):
 
             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
@@ -1194,7 +1194,7 @@ def from_url(cls: Type[_CP], url: str, **kwargs) -> _CP:
 
             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
@@ -863,7 +863,7 @@ def from_url(cls, url, **kwargs):
 
             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
@@ -388,7 +388,7 @@ def from_url(cls, url, **kwargs):
 
             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
@@ -1221,7 +1221,7 @@ def from_url(cls, url, **kwargs):
 
             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: