HashClient¶
Bases: Connection, Geo, Hash, HyperLogLog, Key, List, Publish, Scripting, Set, SSet, String, Transaction
Synchronous Redis Client Hashing across multiple buckets.
Determines connection socket for a command by calculating the keyspace slot from the shard_key and mapping it to one of the configured server buckets.
Source code in pyredis/client/hash.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | |
bulk
property
¶
Flag indicating if bulk mode is active.
closed
property
¶
Flag indicating if the client connections are closed.
__init__(buckets, database=None, password=None, encoding=None, conn_timeout=2, read_timeout=2, username=None)
¶
Initialize the HashClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
buckets
|
List of (host, port) tuples representing the server buckets. |
required | |
database
|
Optional Redis database index. |
None
|
|
password
|
Optional password for Redis authentication. |
None
|
|
encoding
|
Optional string encoding for decoding responses. |
None
|
|
conn_timeout
|
Connection timeout in seconds. |
2
|
|
read_timeout
|
Read timeout in seconds. |
2
|
|
username
|
Optional username for Redis ACL authentication. |
None
|
Source code in pyredis/client/hash.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
append(*args)
¶
Source code in pyredis/commands/string.py
10 11 12 13 14 15 16 17 18 | |
bitcount(*args)
¶
Source code in pyredis/commands/string.py
20 21 22 23 24 25 26 27 28 | |
bitfield(*args)
¶
Source code in pyredis/commands/string.py
30 31 32 33 34 35 36 37 38 | |
bitop(*args)
¶
Source code in pyredis/commands/string.py
40 41 42 43 44 45 46 47 48 | |
bitpos(*args)
¶
Source code in pyredis/commands/string.py
50 51 52 53 54 55 56 57 58 | |
blpop(*args)
¶
Source code in pyredis/commands/list.py
10 11 12 13 14 15 16 17 18 | |
brpop(*args)
¶
Source code in pyredis/commands/list.py
20 21 22 23 24 25 26 27 28 | |
brpoplpush(*args)
¶
Source code in pyredis/commands/list.py
30 31 32 33 34 35 36 37 38 | |
bulk_start(bulk_size=5000, keep_results=True)
¶
Start bulk command pipelining mode.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bulk_size
|
Maximum commands to queue before reading responses. |
5000
|
|
keep_results
|
Flag indicating if responses should be returned. |
True
|
Source code in pyredis/client/hash.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | |
bulk_stop()
¶
Stop bulk mode and retrieve results.
Returns:
| Type | Description |
|---|---|
|
List of execution results if keep_results was set. |
Source code in pyredis/client/hash.py
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
close()
¶
Close all connections to the server buckets.
Source code in pyredis/client/hash.py
169 170 171 172 173 | |
decr(*args)
¶
Source code in pyredis/commands/string.py
60 61 62 63 64 65 66 67 68 | |
decrby(*args)
¶
Source code in pyredis/commands/string.py
70 71 72 73 74 75 76 77 78 | |
delete(*args)
¶
Source code in pyredis/commands/key.py
10 11 12 13 14 15 16 17 18 | |
discard(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/transaction.py
10 11 12 13 14 15 16 17 18 19 | |
dump(*args)
¶
Source code in pyredis/commands/key.py
20 21 22 23 24 25 26 27 28 | |
echo(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/connection.py
10 11 12 13 14 15 16 17 18 19 | |
eval(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
10 11 12 13 14 15 16 17 18 19 | |
evalsha(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
21 22 23 24 25 26 27 28 29 30 | |
exec(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/transaction.py
21 22 23 24 25 26 27 28 29 30 | |
execute(*args, shard_key=None, sock=None)
¶
Execute a command on the appropriate bucket.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*args
|
Command name and arguments. |
()
|
|
shard_key
|
Key used to calculate the slot and route the command. |
None
|
|
sock
|
Optional explicit socket name/bucket to route to. |
None
|
Returns:
| Type | Description |
|---|---|
|
The Redis command response, or None if in bulk mode. |
Source code in pyredis/client/hash.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | |
exists(*args)
¶
Source code in pyredis/commands/key.py
30 31 32 33 34 35 36 37 38 | |
expire(*args)
¶
Source code in pyredis/commands/key.py
40 41 42 43 44 45 46 47 48 | |
expireat(*args)
¶
Source code in pyredis/commands/key.py
50 51 52 53 54 55 | |
geoadd(*args)
¶
Source code in pyredis/commands/geo.py
10 11 12 13 14 15 16 17 18 | |
geodist(*args)
¶
Source code in pyredis/commands/geo.py
20 21 22 23 24 25 26 27 28 | |
geohash(*args)
¶
Source code in pyredis/commands/geo.py
30 31 32 33 34 35 36 37 38 | |
geopos(*args)
¶
Source code in pyredis/commands/geo.py
50 51 52 53 54 55 56 57 58 | |
georadius(*args)
¶
Source code in pyredis/commands/geo.py
40 41 42 43 44 45 46 47 48 | |
georadiusbymember(*args)
¶
Source code in pyredis/commands/geo.py
60 61 62 63 64 65 66 67 68 | |
get(*args)
¶
Source code in pyredis/commands/string.py
80 81 82 83 84 85 86 87 88 | |
getbit(*args)
¶
Source code in pyredis/commands/string.py
90 91 92 93 94 95 96 97 98 | |
getrange(*args)
¶
Source code in pyredis/commands/string.py
100 101 102 103 104 105 106 107 108 | |
getset(*args)
¶
Source code in pyredis/commands/string.py
110 111 112 113 114 115 116 117 118 | |
hdel(*args)
¶
Source code in pyredis/commands/hash.py
10 11 12 13 14 15 16 17 18 | |
hexists(*args)
¶
Source code in pyredis/commands/hash.py
20 21 22 23 24 25 26 27 28 | |
hget(*args)
¶
Source code in pyredis/commands/hash.py
30 31 32 33 34 35 36 37 38 | |
hgetall(*args)
¶
Source code in pyredis/commands/hash.py
40 41 42 43 44 45 46 47 48 | |
hincrby(*args)
¶
Source code in pyredis/commands/hash.py
50 51 52 53 54 55 56 57 58 | |
hincrbyfloat(*args)
¶
Source code in pyredis/commands/hash.py
60 61 62 63 64 65 66 67 68 | |
hkeys(*args)
¶
Source code in pyredis/commands/hash.py
70 71 72 73 74 75 76 77 78 | |
hlen(*args)
¶
Source code in pyredis/commands/hash.py
80 81 82 83 84 85 86 87 88 | |
hmget(*args)
¶
Source code in pyredis/commands/hash.py
90 91 92 93 94 95 96 97 98 | |
hmset(*args)
¶
Source code in pyredis/commands/hash.py
100 101 102 103 104 105 106 107 108 | |
hscan(*args)
¶
Source code in pyredis/commands/hash.py
150 151 152 153 154 155 156 157 158 | |
hset(*args)
¶
Source code in pyredis/commands/hash.py
110 111 112 113 114 115 116 117 118 | |
hsetnx(*args)
¶
Source code in pyredis/commands/hash.py
120 121 122 123 124 125 126 127 128 | |
hstrlen(*args)
¶
Source code in pyredis/commands/hash.py
130 131 132 133 134 135 136 137 138 | |
hvals(*args)
¶
Source code in pyredis/commands/hash.py
140 141 142 143 144 145 146 147 148 | |
incr(*args)
¶
Source code in pyredis/commands/string.py
120 121 122 123 124 125 126 127 128 | |
incrby(*args)
¶
Source code in pyredis/commands/string.py
130 131 132 133 134 135 136 137 138 | |
incrbyfloat(*args)
¶
Source code in pyredis/commands/string.py
140 141 142 143 144 145 146 147 148 | |
keys(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/key.py
57 58 59 60 61 62 63 64 65 66 | |
lindex(*args)
¶
Source code in pyredis/commands/list.py
40 41 42 43 44 45 46 47 48 | |
linsert(*args)
¶
Source code in pyredis/commands/list.py
50 51 52 53 54 55 56 57 58 | |
llen(*args)
¶
Source code in pyredis/commands/list.py
60 61 62 63 64 65 66 67 68 | |
lpop(*args)
¶
Source code in pyredis/commands/list.py
70 71 72 73 74 75 76 77 78 | |
lpush(*args)
¶
Source code in pyredis/commands/list.py
80 81 82 83 84 85 86 87 88 | |
lpushx(*args)
¶
Source code in pyredis/commands/list.py
90 91 92 93 94 95 96 97 98 | |
lrange(*args)
¶
Source code in pyredis/commands/list.py
100 101 102 103 104 105 106 107 108 | |
lrem(*args)
¶
Source code in pyredis/commands/list.py
110 111 112 113 114 115 116 117 118 | |
lset(*args)
¶
Source code in pyredis/commands/list.py
120 121 122 123 124 125 126 127 128 | |
ltrim(*args)
¶
Source code in pyredis/commands/list.py
130 131 132 133 134 135 136 137 138 | |
mget(*args)
¶
Source code in pyredis/commands/string.py
150 151 152 153 154 155 156 157 158 | |
migrate(*args)
¶
Source code in pyredis/commands/key.py
68 69 70 71 72 73 | |
move(*args)
¶
Source code in pyredis/commands/key.py
75 76 77 78 79 80 81 82 83 | |
mset(*args)
¶
Source code in pyredis/commands/string.py
160 161 162 163 164 165 166 167 168 | |
msetnx(*args)
¶
Source code in pyredis/commands/string.py
170 171 172 173 174 175 176 177 178 | |
multi(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/transaction.py
32 33 34 35 36 37 38 39 40 41 | |
object(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/key.py
85 86 87 88 89 90 91 92 93 94 | |
persist(*args)
¶
Source code in pyredis/commands/key.py
96 97 98 99 100 101 102 103 104 | |
pexpire(*args)
¶
Source code in pyredis/commands/key.py
106 107 108 109 110 111 112 113 114 | |
pexpireat(*args)
¶
Source code in pyredis/commands/key.py
116 117 118 119 120 121 122 123 124 | |
pfadd(*args)
¶
Source code in pyredis/commands/hyperloglog.py
10 11 12 13 14 15 16 17 18 | |
pfcount(*args)
¶
Source code in pyredis/commands/hyperloglog.py
20 21 22 23 24 25 26 27 28 | |
pfmerge(*args)
¶
Source code in pyredis/commands/hyperloglog.py
30 31 32 33 34 35 36 37 38 | |
ping(shard_key=None, sock=None)
¶
Source code in pyredis/commands/connection.py
21 22 23 24 25 26 27 28 | |
psetex(*args)
¶
Source code in pyredis/commands/string.py
180 181 182 183 184 185 186 187 188 | |
pttl(*args)
¶
Source code in pyredis/commands/key.py
126 127 128 129 130 131 132 133 134 | |
publish(*args)
¶
Source code in pyredis/commands/publish.py
10 11 12 13 14 15 | |
randomkey(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/key.py
136 137 138 139 140 141 142 143 144 145 | |
rename(*args)
¶
Source code in pyredis/commands/key.py
147 148 149 150 151 152 153 154 155 | |
renamenx(*args)
¶
Source code in pyredis/commands/key.py
157 158 159 160 161 162 163 164 165 | |
restore(*args)
¶
Source code in pyredis/commands/key.py
167 168 169 170 171 172 173 174 175 | |
rpop(*args)
¶
Source code in pyredis/commands/list.py
140 141 142 143 144 145 146 147 148 | |
rpoplpush(*args)
¶
Source code in pyredis/commands/list.py
150 151 152 153 154 155 156 157 158 | |
rpush(*args)
¶
Source code in pyredis/commands/list.py
160 161 162 163 164 165 166 167 168 | |
rpushx(*args)
¶
Source code in pyredis/commands/list.py
170 171 172 173 174 175 176 177 178 | |
sadd(*args)
¶
Source code in pyredis/commands/set.py
10 11 12 13 14 15 16 17 18 | |
scan(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/key.py
177 178 179 180 181 182 183 184 185 186 | |
scard(*args)
¶
Source code in pyredis/commands/set.py
20 21 22 23 24 25 26 27 28 | |
script_debug(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
32 33 34 35 36 37 38 39 40 41 | |
script_exists(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
43 44 45 46 47 48 49 50 51 52 | |
script_flush(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
54 55 56 57 58 59 60 61 62 63 | |
script_kill(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
65 66 67 68 69 70 71 72 73 74 | |
script_load(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/scripting.py
76 77 78 79 80 81 82 83 84 85 | |
sdiff(*args)
¶
Source code in pyredis/commands/set.py
30 31 32 33 34 35 36 37 38 | |
sdiffstore(*args)
¶
Source code in pyredis/commands/set.py
40 41 42 43 44 45 46 47 48 | |
set(*args)
¶
Source code in pyredis/commands/string.py
190 191 192 193 194 195 196 197 198 | |
setbit(*args)
¶
Source code in pyredis/commands/string.py
200 201 202 203 204 205 206 207 208 | |
setex(*args)
¶
Source code in pyredis/commands/string.py
210 211 212 213 214 215 216 217 218 | |
setnx(*args)
¶
Source code in pyredis/commands/string.py
220 221 222 223 224 225 226 227 228 | |
setrange(*args)
¶
Source code in pyredis/commands/string.py
230 231 232 233 234 235 236 237 238 | |
sinter(*args)
¶
Source code in pyredis/commands/set.py
50 51 52 53 54 55 56 57 58 | |
sinterstore(*args)
¶
Source code in pyredis/commands/set.py
60 61 62 63 64 65 66 67 68 | |
sismember(*args)
¶
Source code in pyredis/commands/set.py
70 71 72 73 74 75 76 77 78 | |
smembers(*args)
¶
Source code in pyredis/commands/set.py
80 81 82 83 84 85 86 87 88 | |
smove(*args)
¶
Source code in pyredis/commands/set.py
90 91 92 93 94 95 96 97 98 | |
sort(*args)
¶
Source code in pyredis/commands/key.py
188 189 190 191 192 193 194 195 196 | |
spop(*args)
¶
Source code in pyredis/commands/set.py
100 101 102 103 104 105 106 107 108 | |
srandmember(*args)
¶
Source code in pyredis/commands/set.py
110 111 112 113 114 115 116 117 118 | |
srem(*args)
¶
Source code in pyredis/commands/set.py
120 121 122 123 124 125 126 127 128 | |
sscan(*args)
¶
Source code in pyredis/commands/set.py
150 151 152 153 154 155 156 157 158 | |
strlen(*args)
¶
Source code in pyredis/commands/string.py
240 241 242 243 244 245 246 247 248 | |
sunion(*args)
¶
Source code in pyredis/commands/set.py
130 131 132 133 134 135 136 137 138 | |
sunoinstore(*args)
¶
Source code in pyredis/commands/set.py
140 141 142 143 144 145 146 147 148 | |
ttl(*args)
¶
Source code in pyredis/commands/key.py
198 199 200 201 202 203 204 205 206 | |
type(*args)
¶
Source code in pyredis/commands/key.py
208 209 210 211 212 213 214 215 216 | |
unwatch(*args, shard_key=None, sock=None)
¶
Source code in pyredis/commands/transaction.py
43 44 45 46 47 48 49 50 51 52 | |
wait(*args)
¶
Source code in pyredis/commands/key.py
218 219 220 221 222 223 224 225 226 | |
watch(*args)
¶
Source code in pyredis/commands/transaction.py
54 55 56 57 58 59 60 61 62 | |
zadd(*args)
¶
Source code in pyredis/commands/sset.py
10 11 12 13 14 15 16 17 18 | |
zcard(*args)
¶
Source code in pyredis/commands/sset.py
20 21 22 23 24 25 26 27 28 | |
zcount(*args)
¶
Source code in pyredis/commands/sset.py
30 31 32 33 34 35 36 37 38 | |
zincrby(*args)
¶
Source code in pyredis/commands/sset.py
40 41 42 43 44 45 46 47 48 | |
zinterstore(*args)
¶
Source code in pyredis/commands/sset.py
50 51 52 53 54 55 56 57 58 | |
zlexcount(*args)
¶
Source code in pyredis/commands/sset.py
60 61 62 63 64 65 66 67 68 | |
zrange(*args)
¶
Source code in pyredis/commands/sset.py
70 71 72 73 74 75 76 77 78 | |
zrangebylex(*args)
¶
Source code in pyredis/commands/sset.py
80 81 82 83 84 85 86 87 88 | |
zrangebyscore(*args)
¶
Source code in pyredis/commands/sset.py
90 91 92 93 94 95 96 97 98 | |
zrank(*args)
¶
Source code in pyredis/commands/sset.py
100 101 102 103 104 105 106 107 108 | |
zrem(*args)
¶
Source code in pyredis/commands/sset.py
110 111 112 113 114 115 116 117 118 | |
zremrangebylex(*args)
¶
Source code in pyredis/commands/sset.py
120 121 122 123 124 125 126 127 128 | |
zremrangebyrank(*args)
¶
Source code in pyredis/commands/sset.py
130 131 132 133 134 135 136 137 138 | |
zremrangebyscrore(*args)
¶
Source code in pyredis/commands/sset.py
140 141 142 143 144 145 146 147 148 | |
zrevrange(*args)
¶
Source code in pyredis/commands/sset.py
150 151 152 153 154 155 156 157 158 | |
zrevrangebylex(*args)
¶
Source code in pyredis/commands/sset.py
160 161 162 163 164 165 166 167 168 | |
zrevrangebyscore(*args)
¶
Source code in pyredis/commands/sset.py
170 171 172 173 174 175 176 177 178 | |
zrevrank(*args)
¶
Source code in pyredis/commands/sset.py
180 181 182 183 184 185 186 187 188 | |
zscan(*args)
¶
Source code in pyredis/commands/sset.py
210 211 212 213 214 215 216 217 218 | |
zscore(*args)
¶
Source code in pyredis/commands/sset.py
190 191 192 193 194 195 196 197 198 | |
zunionstore(*args)
¶
Source code in pyredis/commands/sset.py
200 201 202 203 204 205 206 207 208 | |