summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index c5bb7f2..2eb6127 100644
--- a/README.md
+++ b/README.md
@@ -45,11 +45,12 @@ ConnectionPools manage a set of Connection instances. redis-py ships with two
types of Connections. The default, Connection, is a normal TCP socket based
connection. The UnixDomainSocketConnection allows for clients running on the
same device as the server to connect via a unix domain socket. To use a
-UnixDomainSocketConnection connection, simply pass the path argument, which is
-a string to the unix domain socket file. Additionally, make sure the unixsocket
-parameter is defined in your redis.conf file. It's commented out by default.
+UnixDomainSocketConnection connection, simply pass the unix_socket_path
+argument, which is a string to the unix domain socket file. Additionally, make
+sure the unixsocket parameter is defined in your redis.conf file. It's
+commented out by default.
- >>> r = redis.Redis(path='/tmp/redis.sock')
+ >>> r = redis.Redis(unix_socket_path='/tmp/redis.sock')
You can create your own Connection subclasses as well. This may be useful if
you want to control the socket behavior within an async framework. To