@@ -67,11 +67,11 @@ class RedisCluster(AbstractRedis, AbstractRedisCluster, AsyncRedisClusterCommand
67
67
Pass one of parameters:
68
68
69
69
- `url`
70
- - `host`
70
+ - `host` & `port`
71
71
- `startup_nodes`
72
72
73
- | Use :meth:`initialize` to find cluster nodes & create connections.
74
- | Use :meth:`close` to disconnect connections & close client.
73
+ | Use ``await`` :meth:`initialize` to find cluster nodes & create connections.
74
+ | Use ``await`` :meth:`close` to disconnect connections & close client.
75
75
76
76
Many commands support the target_nodes kwarg. It can be one of the
77
77
:attr:`NODE_FLAGS`:
@@ -82,10 +82,12 @@ class RedisCluster(AbstractRedis, AbstractRedisCluster, AsyncRedisClusterCommand
82
82
- :attr:`RANDOM`
83
83
- :attr:`DEFAULT_NODE`
84
84
85
+ Note: This client is not thread/process/fork safe.
86
+
85
87
:param host:
86
88
| Can be used to point to a startup node
87
89
:param port:
88
- | Port used if **host** or **url** is provided
90
+ | Port used if **host** is provided
89
91
:param startup_nodes:
90
92
| :class:`~.ClusterNode` to used as a startup node
91
93
:param cluster_error_retry_attempts:
@@ -117,7 +119,7 @@ class RedisCluster(AbstractRedis, AbstractRedisCluster, AsyncRedisClusterCommand
117
119
| See :meth:`.from_url`
118
120
:param kwargs:
119
121
| Extra arguments that will be passed to the
120
- :class:`~redis.asyncio.connection.Connection` instance when created
122
+ :class:`~redis.asyncio.connection.Connection` instances when created
121
123
122
124
:raises RedisClusterException:
123
125
if any arguments are invalid. Eg:
@@ -165,9 +167,9 @@ def from_url(cls, url: str, **kwargs) -> "RedisCluster":
165
167
All querystring options are cast to their appropriate Python types.
166
168
Boolean arguments can be specified with string values "True"/"False"
167
169
or "Yes"/"No". Values that cannot be properly cast cause a
168
- ``ValueError`` to be raised. Once parsed, the querystring arguments
169
- and keyword arguments are passed to the ``ConnectionPool``'s
170
- class initializer . In the case of conflicting arguments, querystring
170
+ ``ValueError`` to be raised. Once parsed, the querystring arguments and
171
+ keyword arguments are passed to :class:`~redis.asyncio.connection.Connection`
172
+ when created . In the case of conflicting arguments, querystring
171
173
arguments always win.
172
174
173
175
"""
0 commit comments