pyredis Documentation

Transcription

1 pyredis Documentation Release Stephan Schultchen Jul 09, 2018

2

3 Contents 1 Introduction Installing Author License Contributing Usage Example Simple Client Usage Bulk Mode Using a Connection Pool Using a Cluster Connection Pool Using a Hash Connection Pool Using a Sentinel backed Connection Hash Pool Using a Sentinel backed Connection Pool Getting Pool by URL Getting PubSubClient by URL Publish Subscribe API Documentation Connection Client Pool Commands Indices and tables 37 i

4 ii

5 Contents: Contents 1

6 2 Contents

7 CHAPTER 1 Introduction Redis Client implementation for Python. The Client only supports Python 3 for the moment. If there is enough interest, i will make it work with Python 2. Currently implemented Features: Base Redis Client Publish Subscribe Client Sentinel Client Connection Pool Sentinel Backed Connection Pool Client & Pool for Redis Cluster Bulk Mode ( Not supported with Redis Cluster ) Client & Pool with Static Hash Cluster (Supports Bulk Mode) Sentinel Backed Client & Pool with Static Hash Cluster (Supports Bulk Mode) 1.1 Installing pyredis can be installed via pip as follows: pip install python_redis 1.2 Author Stephan Schultchen <stephan.schultchen@gmail.com> 3

8 1.3 License Unless stated otherwise on-file pyredis uses the MIT license, check LICENSE file. 1.4 Contributing If you d like to contribute, fork the project, make a patch and send a pull request. 4 Chapter 1. Introduction

9 CHAPTER 2 Usage Example 2.1 Simple Client Usage from pyredis import Client client = Client(host="localhost") client.ping() 2.2 Bulk Mode Bulk Mode can be used to import large amounts of data in a short time. With bulk mode enabled sending requests and fetching results is separated from each other. Which will save many network round trips, improving query performance. All executed commands will return None. There is a threshold, which defaults to 5000 requests, after which the results of the previous requests are fetched into a list. If you are not interested in the results, this can be disabled by calling bulk_start with the parameter keep_results=false. Fetching results, when the threshold is reached is a transparent operation. The client will only notice that the execution of the the request triggering the threshold will take a little longer. Calling bulk_stop() will fetch all remaining results, and return a list with fetched results. This list can also contain exceptions from failed commands. from pyredis import Client client = Client(host="localhost") client.bulk_start() client.set('key1', 'value1') client.set('key2', 'value2') (continues on next page) 5

10 client.set('key3', 'value3') client.bulk_stop() [b'ok', b'ok', b'ok'] (continued from previous page) from pyredis import HashClient client = Client(buckets=[('host1', 6379), ('host2', 6379), ('host3', 6379)]) client.bulk_start() client.set('key1', 'value1') client.set('key2', 'value2') client.set('key3', 'value3') client.bulk_stop() [b'ok', b'ok', b'ok'] 2.3 Using a Connection Pool from pyredis import Pool pool = Pool(host="localhost") client = pool.aquire() client.ping() b'pong' pool.release(client) 2.4 Using a Cluster Connection Pool from pyredis import ClusterPool pool = ClusterPool(seeds=[('seed1', 6379), ('seed2', 6379), ('seed3', 6379)]) client = pool.aquire() client.ping(shard_key='test') b'pong' pool.release(client) 2.5 Using a Hash Connection Pool from pyredis import HashPool pool = HashPool(buckets=[('host1', 6379), ('host2', 6379), ('host3', 6379)]) client = pool.aquire() client.ping(shard_key='test') b'pong' pool.release(client) 6 Chapter 2. Usage Example

11 2.6 Using a Sentinel backed Connection Hash Pool from pyredis import SentinelHashPool pool = SentinelPool(sentinels=[('sentinel1', 26379), ('sentinel2', 26379), ('sentinel3 ', 26379)], buckets=['bucket1', 'bucket2', 'bucket3*]) client = pool.aquire() client.ping() b'pong' pool.release(client) 2.7 Using a Sentinel backed Connection Pool from pyredis import SentinelPool pool = SentinelPool(sentinels=[('sentinel1', 26379), ('sentinel2', 26379), ('sentinel3 ', 26379)], name=pool_name) client = pool.aquire() client.ping() b'pong' pool.release(client) 2.8 Getting Pool by URL from pyredis import get_by_url pool1 = get_by_url('redis://localhost?password=topsecret') pool1 = get_by_url('redis://localhost:6379?db=0&password=topsecret') sentinel = get_by_url('sentinel://seed1:6379,seed2,seed3:4711?name=pool_name&db=0& password=topsecret') cluster = get_by_url('redis://seed1:6379,seed2:4711,seed3?db=0') 2.9 Getting PubSubClient by URL from pyredis import get_by_url # it is not save to share this client between threads pubsub = get_by_url('pubsub://localhost?password=topsecret') 2.10 Publish Subscribe from pyredis import Client, PubSubClient client = Client(host='localhost') subscribe = PubSubClient(host='localhost') subscribe.subscribe('/blub') (continues on next page) 2.6. Using a Sentinel backed Connection Hash Pool 7

12 subscribe.get() [b'subscribe', b'/blub', 1] (continued from previous page) client.publish('/blub', 'test') 1 subscribe.get() [b'message', b'/blub', b'test'] 8 Chapter 2. Usage Example

13 CHAPTER 3 API Documentation 3.1 Connection class pyredis.connection.connection(host=none, port=6379, unix_sock=none, database=0, password=none, encoding=none, conn_timeout=2, read_timeout=2, sentinel=false) Low level client for talking to a Redis Server. This class is should not be used directly to talk to a Redis server, unless you know what you are doing. In most cases it should be sufficient to use one of the Client classes, or one of the Connection Pools. host (str) Host IP or Name to connect, can only be set when unix_sock is None. port (int) Port to connect, only used when host is also set. unix_sock (str) Unix Socket to connect, can only be set when host is None. database (int) Select which db should be used for this connection password (str) Password used for authentication. If None, no authentication is done encoding (str) Convert result strings with this encoding. If None, no encoding is done. conn_timeout (float) Connect Timeout. read_timeout (float) Read Timeout. sentinel (bool) If True, authentication and database selection is skipped. close() Close Client Connection. This closes the underlying socket, and mark the connection as closed. Returns None 9

14 read(close_on_timeout=true, raise_on_result_err=true) Read result from the socket. close_on_timeout (book) Close the connection after a read timeout raise_on_result_err (bool) Raise exception on protocol errors write(*args) Write commands to socket. args (str, int, float) Accepts a variable number of arguments Returns None 3.2 Client Client class pyredis.client(**kwargs) Base Client for Talking to Redis. Inherits the following Command classes: commands.connection, commands.hash, commands.hyperloglog, commands.key, commands.list, commands.publish, commands.scripting, commands.set, commands.sset, commands.string, commands.transaction kwargs pyredis.client takes the same arguments as pyredis.connection.connection. bulk True if bulk mode is enabled. Returns bool bulk_start(bulk_size=5000, keep_results=true) Enable bulk mode Put the client into bulk mode. Instead of executing a command & waiting for the reply, all commands are send to Redis without fetching the result. The results get fetched whenever $bulk_size commands have been executed, which will also resets the counter, or of bulk_stop() is called. 10 Chapter 3. API Documentation

15 bulk_size (int) Number of commands to execute, before fetching results. keep_results (bool) If True, keep the results. The Results will be returned when calling bulk_stop. Returns None bulk_stop() Stop bulk mode. All outstanding results from previous commands get fetched. If bulk_start was called with keep_results=true, return a list with all results from the executed commands in order. The list of results can also contain Exceptions, hat you should check for. close() Close client. Returns None, list Returns None closed Check if client is closed. Returns bool execute(*args) Execute arbitrary redis command. args (list, int, float) ClusterClient class pyredis.clusterclient(seeds=none, database=0, password=none, encoding=none, slave_ok=false, conn_timeout=2, read_timeout=2, cluster_map=none) Base Client for Talking to Redis Cluster. Inherits the following Commmand classes: commands.connection, commands.hash, commands.hyperloglog, commands.key, commands.list, commands.scripting, commands.set, commands.sset, commands.string, commands.transaction 3.2. Client 11

16 seeds (list) Accepts a list of seed nodes in this form: [( seed1, 6379), ( seed2, 6379), ( seed3, 6379)] slave_ok (bool) Set to True if this Client should use slave nodes. database (int) Select which db should be used for this connection password (str) Password used for authentication. If None, no authentication is done encoding (str) Convert result strings with this encoding. If None, no encoding is done. conn_timeout (float) Connect Timeout. read_timeout (float) Read Timeout. execute(*args, shard_key=none, sock=none, asking=false, retries=3) Execute arbitrary redis command. args (list, int, float) shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set HashClient class pyredis.hashclient(buckets, database=0, password=none, encoding=none, conn_timeout=2, read_timeout=2) Client for Talking to Static Hashed Redis Cluster. The Client will calculate a crc16 hash using the shard_key, which is be default the first Key in case the command supports multiple keys. If the Key is using the TAG annotation bla{tag}blarg, then only the tag portion is used, in this case tag. The key space is split into buckets, so in theory you could provide a list with ( host, port) pairs to the buckets parameter. If you have less then ( host, port) pairs, the client will try to distribute the key spaces evenly between available pairs. Warning Since this is static hashing, the order of pairs has to match on each client you use! Also changing the number of pairs will change the mapping between buckets and pairs, rendering your data inaccessible! Inherits the following Commmand classes: commands.connection, commands.hash, commands.hyperloglog, commands.key, commands.list, commands.publish, commands.scripting, commands.set, commands.sset, 12 Chapter 3. API Documentation

17 commands.string, commands.transaction bulk True if bulk mode is enabled. Returns bool bulk_start(bulk_size=5000, keep_results=true) Enable bulk mode Put the client into bulk mode. Instead of executing a command & waiting for the reply, all commands are send to Redis without fetching the result. The results get fetched whenever $bulk_size commands have been executed, which will also resets the counter, or of bulk_stop() is called. bulk_size (int) Number of commands to execute, before fetching results. keep_results (bool) If True, keep the results. The Results will be returned when calling bulk_stop. Returns None bulk_stop() Stop bulk mode. All outstanding results from previous commands get fetched. If bulk_start was called with keep_results=true, return a list with all results from the executed commands in order. The list of results can also contain Exceptions, hat you should check for. close() Close client. Returns None, list Returns None closed Check if client is closed. Returns bool execute(*args, shard_key=none, sock=none) Execute arbitrary redis command. args (list, int, float) shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set PubSubClient class pyredis.pubsubclient(**kwargs) Pub/Sub Client. Subscribe part of the Redis Pub/Sub System Client 13

18 kwargs pyredis.pubsubclient takes the same arguments as pyredis.connection.connection. close() Close Client Returns None closed Check if Client is closed. Returns bool get() Fetch published item from Redis. Returns list SentinelClient class pyredis.sentinelclient(sentinels) Redis Sentinel Client. sentinels (list) Accepts a list of sentinels in this form: [( sentinel1, 26379), ( sentinel2, 26379), ( sentinel3, 26379)] close() Close Connection. Returns None execute(*args) Execute sentinel command. args (string, int, float) get_master(name) Get Master Info. Return dictionary with master details. name (str) Name of Redis service Returns dict get_masters() Get list of masters. Returns list of dicts get_slaves(name) Get slaves. Return a list of dictionaries, with slave details. name (str) Name of Redis service Returns next_sentinel() Switch to the Next Sentinel. Returns None 14 Chapter 3. API Documentation

19 sentinels Return configured sentinels. Returns deque 3.3 Pool BasePool class pyredis.pool.basepool(database=0, password=none, encoding=none, conn_timeout=2, read_timeout=2, pool_size=16, lock=<unlocked _thread.lock object>) Base Class for all other pools. All other pools inherit from this base class. This class itself, cannot be used directly. database (int) Select which db should be used for this pool password (str) Password used for authentication. If None, no authentication is done encoding (str) Convert result strings with this encoding. If None, no encoding is done. conn_timeout (float) Connect Timeout. read_timeout (float) Read Timeout. pool_size (int) Upper limit of connections this pool can handle. lock (_lock object, defaults to threading.lock) Class implementing a Lock. acquire() Acquire a client connection from the pool. Returns redis.client, exception conn_timeout Return configured connection timeout Returns float database Return configured database. Returns int encoding Return configured encoding Returns str, None password Return configured password for this pool. Returns str, None pool_size Return, or adjust the current pool size Pool 15

20 shrinking is implemented via closing unused connections. if there not enough unused connections to fulfil the shrink request, connections returned via pool.release are closed. Returns int, None read_timeout Return configured read timeout Returns float release(conn) Return a client connection to the pool. conn redis.client instance, managed by this pool. Returns None ClusterPool class pyredis.clusterpool(seeds, slave_ok=false, **kwargs) Redis Cluster Pool. Inherits all the arguments, methods and attributes from BasePool. seeds Accepts a list of seed nodes in this form: [( host1, 6379), ( host2, 6379), ( host3, 6379)] slave_ok (bool) Defaults to False. If True, this pool will return connections to slave instances. retries (int) In case there is a chunk move ongoing, while executing a command, how many times should we try to find the right node, before giving up. execute(*args, **kwargs) Execute arbitrary redis command. args (list, int, float) slave_ok True if this pool will return slave connections Returns bool HashPool class pyredis.hashpool(buckets, **kwargs) Pool for straight connections to Redis Inherits all the arguments, methods and attributes from BasePool. The Client will calculate a crc16 hash using the shard_key, which is be default the first Key in case the command supports multiple keys. If the Key is using the TAG annotation bla{tag}blarg, then only the tag portion is used, in this case tag. The key space is split into buckets, so in theory you could provide a list with ( host, port) pairs to the buckets parameter. If you have less then ( host, port) pairs, the client will try to distribute the key spaces evenly between available pairs. 16 Chapter 3. API Documentation

21 Warning Since this is static hashing, the the order of pairs has to match on each client you use! Also changing the number of pairs will change the mapping between buckets and pairs, rendering your data inaccessible! buckets list of ( host, port) pairs, where each pair represents a bucket example: [( localhost, 7001), ( localhost, 7002), ( localhost, 7003)] buckets Return configured buckets. Returns list execute(*args, **kwargs) Execute arbitrary redis command. args (list, int, float) Pool class pyredis.pool(host=none, port=6379, unix_sock=none, **kwargs) Pool for straight connections to Redis Inherits all the arguments, methods and attributes from BasePool. host (str) Host IP or Name to connect, can only be set when unix_sock is None. port (int) Port to connect, only used when host is also set. unix_sock (str) Unix Socket to connect, can only be set when host is None. execute(*args) Execute arbitrary redis command. args (list, int, float) host Return configured host. Returns str, None port Return configured port. Returns int unix_sock Return configured Unix socket. Returns str, None SentinelHashPool class pyredis.sentinelpool(sentinels, name, slave_ok=false, retries=3, **kwargs) Sentinel backed Pool. Inherits all the arguments, methods and attributes from BasePool Pool 17

22 sentinels (list) Accepts a list of sentinels in this form: [( sentinel1, 26379), ( sentinel2, 26379), ( sentinel3, 26379)] name (str) Name of the cluster managed by sentinel, that this pool should manage. slave_ok (bool) Defaults to False. If True, this pool will return connections to slave instances. retries (int) In case a sentinel delivers stale data, how many other sentinels should be tried. execute(*args) Execute arbitrary redis command. args (list, int, float) name Name of the configured Sentinel managed cluster. Returns str retries Number of retries in case of stale sentinel. Returns int sentinels Deque with configured sentinels. Returns deque slave_ok True if this pool return slave connections Returns bool SentinelPool class pyredis.sentinelpool(sentinels, name, slave_ok=false, retries=3, **kwargs) Sentinel backed Pool. Inherits all the arguments, methods and attributes from BasePool. sentinels (list) Accepts a list of sentinels in this form: [( sentinel1, 26379), ( sentinel2, 26379), ( sentinel3, 26379)] name (str) Name of the cluster managed by sentinel, that this pool should manage. slave_ok (bool) Defaults to False. If True, this pool will return connections to slave instances. retries (int) In case a sentinel delivers stale data, how many other sentinels should be tried. execute(*args) Execute arbitrary redis command. args (list, int, float) 18 Chapter 3. API Documentation

23 name Name of the configured Sentinel managed cluster. Returns str retries Number of retries in case of stale sentinel. Returns int sentinels Deque with configured sentinels. Returns deque slave_ok True if this pool return slave connections Returns bool 3.4 Commands Connection class pyredis.commands.connection echo(*args, shard_key=none, sock=none) Execute ECHO Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. ping(shard_key=none, sock=none) Execute PING Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. Returns result,exception 3.4. Commands 19

24 3.4.2 Hash class pyredis.commands.hash hdel(*args) Execute HDEL Command, consult Redis documentation for details. hexists(*args) Execute HEXISTS Command, consult Redis documentation for details. hget(*args) Execute HGET Command, consult Redis documentation for details. hgetall(*args) Execute HGETALL Command, consult Redis documentation for details. hincrby(*args) Execute HINCRBY Command, consult Redis documentation for details. hincrbyfloat(*args) Execute HINCRBYFLOAT Command, consult Redis documentation for details. hkeys(*args) Execute HKEYS Command, consult Redis documentation for details. hlen(*args) Execute HLEN Command, consult Redis documentation for details. hmget(*args) Execute HMGET Command, consult Redis documentation for details. hmset(*args) Execute HMSET Command, consult Redis documentation for details. hscan(*args) Execute HSCAN Command, consult Redis documentation for details. hset(*args) Execute HSET Command, consult Redis documentation for details. 20 Chapter 3. API Documentation

25 hsetnx(*args) Execute HSETNX Command, consult Redis documentation for details. hstrlen(*args) Execute HSTRLEN Command, consult Redis documentation for details. hvals(*args) Execute HVALS Command, consult Redis documentation for details HyperLogLog class pyredis.commands.hyperloglog pfadd(*args) Execute PFADD Command, consult Redis documentation for details. pfcount(*args) Execute PFCOUNT Command, consult Redis documentation for details. pfmerge(*args) Execute PFMERGE Command, consult Redis documentation for details Geo class pyredis.commands.geo geoadd(*args) Execute GEOADD Command, consult Redis documentation for details. geodist(*args) Execute GEODIST Command, consult Redis documentation for details. geohash(*args) Execute GEOHASH Command, consult Redis documentation for details. geopos(*args) Execute GEOPOS Command, consult Redis documentation for details. georadius(*args) Execute GEORADIUS Command, consult Redis documentation for details Commands 21

26 georadiusbymember(*args) Execute GEORADIUSBYMEMBER Command, consult Redis documentation for details Key class pyredis.commands.key delete(*args) Execute DEL Command, consult Redis documentation for details. dump(*args) Execute DUMP Command, consult Redis documentation for details. exists(*args) Execute EXISTS Command, consult Redis documentation for details. expire(*args) Execute EXPIRE Command, consult Redis documentation for details. expireat(*args) Execute EXPIREAT Command, consult Redis documentation for details. keys(*args, shard_key=none, sock=none) Execute KEYS Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. migrate(*args) Execute MIGRATE Command, consult Redis documentation for details. move(*args) Execute MOVE Command, consult Redis documentation for details. 22 Chapter 3. API Documentation

27 object(*args, shard_key=none, sock=none) Execute OBJECT Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. persist(*args) Execute PERSIST Command, consult Redis documentation for details. pexpire(*args) Execute PEXPIRE Command, consult Redis documentation for details. pexpireat(*args) Execute PEXPIREAT Command, consult Redis documentation for details. pttl(*args) Execute PTTL Command, consult Redis documentation for details. randomkey(*args, shard_key=none, sock=none) Execute RANDOMKEY Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. rename(*args) Execute RENAME Command, consult Redis documentation for details. renamenx(*args) Execute RENAMENX Command, consult Redis documentation for details. restore(*args) Execute RESTORE Command, consult Redis documentation for details Commands 23

28 scan(*args, shard_key=none, sock=none) Execute SCAN Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. sort(*args) Execute SORT Command, consult Redis documentation for details. ttl(*args) Execute TTL Command, consult Redis documentation for details. type(*args) Execute TYPE Command, consult Redis documentation for details. wait(*args) Execute WAIT Command, consult Redis documentation for details List class pyredis.commands.list blpop(*args) Execute BLPOP Command, consult Redis documentation for details. brpop(*args) Execute BRPOP Command, consult Redis documentation for details. brpoplpush(*args) Execute BRPOPPUSH Command, consult Redis documentation for details. lindex(*args) Execute LINDEX Command, consult Redis documentation for details. 24 Chapter 3. API Documentation

29 linsert(*args) Execute LINSERT Command, consult Redis documentation for details. llen(*args) Execute LLEN Command, consult Redis documentation for details. lpop(*args) Execute LPOP Command, consult Redis documentation for details. lpush(*args) Execute LPUSH Command, consult Redis documentation for details. lpushx(*args) Execute LPUSHX Command, consult Redis documentation for details. lrange(*args) Execute LRANGE Command, consult Redis documentation for details. lrem(*args) Execute LREM Command, consult Redis documentation for details. lset(*args) Execute LSET Command, consult Redis documentation for details. ltrim(*args) Execute LTRIM Command, consult Redis documentation for details. rpop(*args) Execute RPOP Command, consult Redis documentation for details. rpoplpush(*args) Execute RPOPLPUSH Command, consult Redis documentation for details. rpush(*args) Execute RPUSH Command, consult Redis documentation for details. rpushx(*args) Execute RPUSHX Command, consult Redis documentation for details Commands 25

30 3.4.7 Publish class pyredis.commands.publish publish(*args) Execute PUBLISH Command, consult Redis documentation for details Scripting class pyredis.commands.scripting eval(*args, shard_key=none, sock=none) Execute EVAL Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. evalsha(*args, shard_key=none, sock=none) Execute EVALSHA Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_debug(*args, shard_key=none, sock=none) Execute SCRIPT DEBUG Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. 26 Chapter 3. API Documentation

31 script_exists(*args, shard_key=none, sock=none) Execute SCRIPT EXISTS Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_flush(*args, shard_key=none, sock=none) Execute SCRIPT FLUSH Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_kill(*args, shard_key=none, sock=none) Execute SCRIPT KILL Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_load(*args, shard_key=none, sock=none) Execute SCRIPT LOAD Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set Commands 27

32 3.4.9 Set class pyredis.commands.set sadd(*args) Execute SADD Command, consult Redis documentation for details. scard(*args) Execute SCARD Command, consult Redis documentation for details. sdiff(*args) Execute SDIFF Command, consult Redis documentation for details. sdiffstore(*args) Execute SDIFFSTORE Command, consult Redis documentation for details. sinter(*args) Execute SINTER Command, consult Redis documentation for details. sinterstore(*args) Execute SINTERSTORE Command, consult Redis documentation for details. sismember(*args) Execute SISMEMBER Command, consult Redis documentation for details. smembers(*args) Execute SMEMBERS Command, consult Redis documentation for details. smove(*args) Execute SMOVE Command, consult Redis documentation for details. spop(*args) Execute SPOP Command, consult Redis documentation for details. srandmember(*args) Execute SRANDMEMBER Command, consult Redis documentation for details. srem(*args) Execute SREM Command, consult Redis documentation for details. 28 Chapter 3. API Documentation

33 sscan(*args) Execute SSCAN Command, consult Redis documentation for details. sunion(*args) Execute SUNION Command, consult Redis documentation for details. sunoinstore(*args) Execute SUNIONSTORE Command, consult Redis documentation for details SSet class pyredis.commands.sset zadd(*args) Execute ZADD Command, consult Redis documentation for details. zcard(*args) Execute ZCARD Command, consult Redis documentation for details. zcount(*args) Execute ZCOUNT Command, consult Redis documentation for details. zincrby(*args) Execute ZINCRBY Command, consult Redis documentation for details. zinterstore(*args) Execute ZINTERSTORE Command, consult Redis documentation for details. zlexcount(*args) Execute ZLEXCOUNT Command, consult Redis documentation for details. zrange(*args) Execute ZRANGE Command, consult Redis documentation for details. zrangebylex(*args) Execute ZRANGEBYLEX Command, consult Redis documentation for details. zrangebyscore(*args) Execute ZRANGEBYSCORE Command, consult Redis documentation for details Commands 29

34 zrank(*args) Execute ZRANK Command, consult Redis documentation for details. zrem(*args) Execute ZREM Command, consult Redis documentation for details. zremrangebylex(*args) Execute ZREMRANGEBYLEX Command, consult Redis documentation for details. zremrangebyrank(*args) Execute ZREMRANGEBYRANK Command, consult Redis documentation for details. zremrangebyscrore(*args) Execute ZREMRANGEBYSCORE Command, consult Redis documentation for details. zrevrange(*args) Execute ZREVRANGE Command, consult Redis documentation for details. zrevrangebylex(*args) Execute ZREVRANGEBYLEX Command, consult Redis documentation for details. zrevrangebyscore(*args) Execute ZREVRANGEBYSCORE Command, consult Redis documentation for details. zrevrank(*args) Execute ZREVRANK Command, consult Redis documentation for details. zscan(*args) Execute ZSCAN Command, consult Redis documentation for details. zscore(*args) Execute ZSCORE Command, consult Redis documentation for details. zunionstore(*args) Execute ZUNIONSTORE Command, consult Redis documentation for details. 30 Chapter 3. API Documentation

35 String class pyredis.commands.string append(*args) Execute APPEND Command, consult Redis documentation for details. bitcount(*args) Execute BITCOUNT Command, consult Redis documentation for details. bitfield(*args) Execute BITFIELD Command, consult Redis documentation for details. bitop(*args) Execute BITOP Command, consult Redis documentation for details. bitpos(*args) Execute BITPOS Command, consult Redis documentation for details. decr(*args) Execute DECR Command, consult Redis documentation for details. decrby(*args) Execute DECRBY Command, consult Redis documentation for details. get(*args) Execute GET Command, consult Redis documentation for details. getbit(*args) Execute GETBIT Command, consult Redis documentation for details. getrange(*args) Execute GETRANGE Command, consult Redis documentation for details. getset(*args) Execute GETSET Command, consult Redis documentation for details. incr(*args) Execute INCR Command, consult Redis documentation for details Commands 31

36 incrby(*args) Execute INCRBY Command, consult Redis documentation for details. incrbyfloat(*args) Execute INCRBYFLOAT Command, consult Redis documentation for details. mget(*args) Execute MGET Command, consult Redis documentation for details. mset(*args) Execute MSET Command, consult Redis documentation for details. msetnx(*args) Execute MSETNX Command, consult Redis documentation for details. psetex(*args) Execute PSETEX Command, consult Redis documentation for details. set(*args) Execute SET Command, consult Redis documentation for details. setbit(*args) Execute SETBIT Command, consult Redis documentation for details. setex(*args) Execute SETEX Command, consult Redis documentation for details. setnx(*args) Execute SETNX Command, consult Redis documentation for details. setrange(*args) Execute SETRANGE Command, consult Redis documentation for details. strlen(*args) Execute STRLEN Command, consult Redis documentation for details Subscribe class pyredis.commands.subscribe 32 Chapter 3. API Documentation

37 psubscribe(*args) Execute PSUBSCRIBE Command, consult Redis documentation for details. punsubscribe(*args) Execute PUNSUBSCRIBE Command, consult Redis documentation for details. subscribe(*args) Execute SUBSCRIBE Command, consult Redis documentation for details. unsubscribe(*args) Execute UNSUBSCRIBE Command, consult Redis documentation for details Transaction class pyredis.commands.transaction discard(*args, shard_key=none, sock=none) Execute DISCARD Command, consult Redis documentation for details. exec(*args, shard_key=none, sock=none) Execute EXEC Command, consult Redis documentation for details. multi(*args, shard_key=none, sock=none) Execute MULTI Command, consult Redis documentation for details. unwatch(*args, shard_key=none, sock=none) Execute UNWATCH Command, consult Redis documentation for details. watch(*args) Execute WATCH Command, consult Redis documentation for details Scripting class pyredis.commands.scripting eval(*args, shard_key=none, sock=none) Execute EVAL Command, consult Redis documentation for details Commands 33

38 shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. evalsha(*args, shard_key=none, sock=none) Execute EVALSHA Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_debug(*args, shard_key=none, sock=none) Execute SCRIPT DEBUG Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_exists(*args, shard_key=none, sock=none) Execute SCRIPT EXISTS Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_flush(*args, shard_key=none, sock=none) Execute SCRIPT FLUSH Command, consult Redis documentation for details. 34 Chapter 3. API Documentation

39 shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_kill(*args, shard_key=none, sock=none) Execute SCRIPT KILL Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set. script_load(*args, shard_key=none, sock=none) Execute SCRIPT LOAD Command, consult Redis documentation for details. shard_key (string) (optional) Should be set to the key name you try to work with. Can not be used if sock is set. sock (string) (optional) The string representation of a socket, the command should be executed against. For example: testhost_6379 Can not be used if shard_key is set Commands 35

40 36 Chapter 3. API Documentation

41 CHAPTER 4 Indices and tables genindex modindex search 37

42 38 Chapter 4. Indices and tables

43 Index A acquire() (pyredis.pool.basepool method), 15 append() (pyredis.commands.string method), 31 B BasePool (class in pyredis.pool), 15 bitcount() (pyredis.commands.string method), 31 bitfield() (pyredis.commands.string method), 31 bitop() (pyredis.commands.string method), 31 bitpos() (pyredis.commands.string method), 31 blpop() (pyredis.commands.list method), 24 brpop() (pyredis.commands.list method), 24 brpoplpush() (pyredis.commands.list method), 24 buckets (pyredis.hashpool attribute), 17 bulk (pyredis.client attribute), 10 bulk (pyredis.hashclient attribute), 13 bulk_start() (pyredis.client method), 10 bulk_start() (pyredis.hashclient method), 13 bulk_stop() (pyredis.client method), 11 bulk_stop() (pyredis.hashclient method), 13 C Client (class in pyredis), 10 close() (pyredis.client method), 11 close() (pyredis.connection.connection method), 9 close() (pyredis.hashclient method), 13 close() (pyredis.pubsubclient method), 14 close() (pyredis.sentinelclient method), 14 closed (pyredis.client attribute), 11 closed (pyredis.hashclient attribute), 13 closed (pyredis.pubsubclient attribute), 14 ClusterClient (class in pyredis), 11 ClusterPool (class in pyredis), 16 conn_timeout (pyredis.pool.basepool attribute), 15 Connection (class in pyredis.commands), 19 Connection (class in pyredis.connection), 9 D database (pyredis.pool.basepool attribute), 15 decr() (pyredis.commands.string method), 31 decrby() (pyredis.commands.string method), 31 delete() (pyredis.commands.key method), 22 discard() (pyredis.commands.transaction method), 33 dump() (pyredis.commands.key method), 22 E echo() (pyredis.commands.connection method), 19 encoding (pyredis.pool.basepool attribute), 15 eval() (pyredis.commands.scripting method), 26, 33 evalsha() (pyredis.commands.scripting method), 26, 34 exec() (pyredis.commands.transaction method), 33 execute() (pyredis.client method), 11 execute() (pyredis.clusterclient method), 12 execute() (pyredis.clusterpool method), 16 execute() (pyredis.hashclient method), 13 execute() (pyredis.hashpool method), 17 execute() (pyredis.pool method), 17 execute() (pyredis.sentinelclient method), 14 execute() (pyredis.sentinelpool method), 18 exists() (pyredis.commands.key method), 22 expire() (pyredis.commands.key method), 22 expireat() (pyredis.commands.key method), 22 G Geo (class in pyredis.commands), 21 geoadd() (pyredis.commands.geo method), 21 geodist() (pyredis.commands.geo method), 21 geohash() (pyredis.commands.geo method), 21 geopos() (pyredis.commands.geo method), 21 georadius() (pyredis.commands.geo method), 21 georadiusbymember() (pyredis.commands.geo method), 22 get() (pyredis.commands.string method), 31 get() (pyredis.pubsubclient method), 14 get_master() (pyredis.sentinelclient method), 14 get_masters() (pyredis.sentinelclient method), 14 get_slaves() (pyredis.sentinelclient method), 14 getbit() (pyredis.commands.string method), 31 39

44 getrange() (pyredis.commands.string method), 31 getset() (pyredis.commands.string method), 31 H Hash (class in pyredis.commands), 20 HashClient (class in pyredis), 12 HashPool (class in pyredis), 16 hdel() (pyredis.commands.hash method), 20 hexists() (pyredis.commands.hash method), 20 hget() (pyredis.commands.hash method), 20 hgetall() (pyredis.commands.hash method), 20 hincrby() (pyredis.commands.hash method), 20 hincrbyfloat() (pyredis.commands.hash method), 20 hkeys() (pyredis.commands.hash method), 20 hlen() (pyredis.commands.hash method), 20 hmget() (pyredis.commands.hash method), 20 hmset() (pyredis.commands.hash method), 20 host (pyredis.pool attribute), 17 hscan() (pyredis.commands.hash method), 20 hset() (pyredis.commands.hash method), 20 hsetnx() (pyredis.commands.hash method), 20 hstrlen() (pyredis.commands.hash method), 21 hvals() (pyredis.commands.hash method), 21 HyperLogLog (class in pyredis.commands), 21 I incr() (pyredis.commands.string method), 31 incrby() (pyredis.commands.string method), 31 incrbyfloat() (pyredis.commands.string method), 32 K Key (class in pyredis.commands), 22 keys() (pyredis.commands.key method), 22 L lindex() (pyredis.commands.list method), 24 linsert() (pyredis.commands.list method), 24 List (class in pyredis.commands), 24 llen() (pyredis.commands.list method), 25 lpop() (pyredis.commands.list method), 25 lpush() (pyredis.commands.list method), 25 lpushx() (pyredis.commands.list method), 25 lrange() (pyredis.commands.list method), 25 lrem() (pyredis.commands.list method), 25 lset() (pyredis.commands.list method), 25 ltrim() (pyredis.commands.list method), 25 M mget() (pyredis.commands.string method), 32 migrate() (pyredis.commands.key method), 22 move() (pyredis.commands.key method), 22 mset() (pyredis.commands.string method), 32 msetnx() (pyredis.commands.string method), 32 multi() (pyredis.commands.transaction method), 33 N name (pyredis.sentinelpool attribute), 18, 19 next_sentinel() (pyredis.sentinelclient method), 14 O object() (pyredis.commands.key method), 22 P password (pyredis.pool.basepool attribute), 15 persist() (pyredis.commands.key method), 23 pexpire() (pyredis.commands.key method), 23 pexpireat() (pyredis.commands.key method), 23 pfadd() (pyredis.commands.hyperloglog method), 21 pfcount() (pyredis.commands.hyperloglog method), 21 pfmerge() (pyredis.commands.hyperloglog method), 21 ping() (pyredis.commands.connection method), 19 Pool (class in pyredis), 17 pool_size (pyredis.pool.basepool attribute), 15 port (pyredis.pool attribute), 17 psetex() (pyredis.commands.string method), 32 psubscribe() (pyredis.commands.subscribe method), 32 pttl() (pyredis.commands.key method), 23 Publish (class in pyredis.commands), 26 publish() (pyredis.commands.publish method), 26 PubSubClient (class in pyredis), 13 punsubscribe() (pyredis.commands.subscribe method), 33 R randomkey() (pyredis.commands.key method), 23 read() (pyredis.connection.connection method), 9 read_timeout (pyredis.pool.basepool attribute), 16 release() (pyredis.pool.basepool method), 16 rename() (pyredis.commands.key method), 23 renamenx() (pyredis.commands.key method), 23 restore() (pyredis.commands.key method), 23 retries (pyredis.sentinelpool attribute), 18, 19 rpop() (pyredis.commands.list method), 25 rpoplpush() (pyredis.commands.list method), 25 rpush() (pyredis.commands.list method), 25 rpushx() (pyredis.commands.list method), 25 S sadd() (pyredis.commands.set method), 28 scan() (pyredis.commands.key method), 24 scard() (pyredis.commands.set method), 28 script_debug() (pyredis.commands.scripting method), 26, 34 script_exists() (pyredis.commands.scripting method), 27, 34 script_flush() (pyredis.commands.scripting method), 27, Index

45 script_kill() (pyredis.commands.scripting method), 27, 35 script_load() (pyredis.commands.scripting method), 27, 35 Scripting (class in pyredis.commands), 26, 33 sdiff() (pyredis.commands.set method), 28 sdiffstore() (pyredis.commands.set method), 28 SentinelClient (class in pyredis), 14 SentinelPool (class in pyredis), 17, 18 sentinels (pyredis.sentinelclient attribute), 14 sentinels (pyredis.sentinelpool attribute), 18, 19 Set (class in pyredis.commands), 28 set() (pyredis.commands.string method), 32 setbit() (pyredis.commands.string method), 32 setex() (pyredis.commands.string method), 32 setnx() (pyredis.commands.string method), 32 setrange() (pyredis.commands.string method), 32 sinter() (pyredis.commands.set method), 28 sinterstore() (pyredis.commands.set method), 28 sismember() (pyredis.commands.set method), 28 slave_ok (pyredis.clusterpool attribute), 16 slave_ok (pyredis.sentinelpool attribute), 18, 19 smembers() (pyredis.commands.set method), 28 smove() (pyredis.commands.set method), 28 sort() (pyredis.commands.key method), 24 spop() (pyredis.commands.set method), 28 srandmember() (pyredis.commands.set method), 28 srem() (pyredis.commands.set method), 28 sscan() (pyredis.commands.set method), 29 SSet (class in pyredis.commands), 29 String (class in pyredis.commands), 31 strlen() (pyredis.commands.string method), 32 Subscribe (class in pyredis.commands), 32 subscribe() (pyredis.commands.subscribe method), 33 sunion() (pyredis.commands.set method), 29 sunoinstore() (pyredis.commands.set method), 29 T Transaction (class in pyredis.commands), 33 ttl() (pyredis.commands.key method), 24 type() (pyredis.commands.key method), 24 U unix_sock (pyredis.pool attribute), 17 unsubscribe() (pyredis.commands.subscribe method), 33 unwatch() (pyredis.commands.transaction method), 33 W wait() (pyredis.commands.key method), 24 watch() (pyredis.commands.transaction method), 33 write() (pyredis.connection.connection method), 10 Z zadd() (pyredis.commands.sset method), 29 zcard() (pyredis.commands.sset method), 29 zcount() (pyredis.commands.sset method), 29 zincrby() (pyredis.commands.sset method), 29 zinterstore() (pyredis.commands.sset method), 29 zlexcount() (pyredis.commands.sset method), 29 zrange() (pyredis.commands.sset method), 29 zrangebylex() (pyredis.commands.sset method), 29 zrangebyscore() (pyredis.commands.sset method), 29 zrank() (pyredis.commands.sset method), 30 zrem() (pyredis.commands.sset method), 30 zremrangebylex() (pyredis.commands.sset method), 30 zremrangebyrank() (pyredis.commands.sset method), 30 zremrangebyscrore() (pyredis.commands.sset method), 30 zrevrange() (pyredis.commands.sset method), 30 zrevrangebylex() (pyredis.commands.sset method), 30 zrevrangebyscore() (pyredis.commands.sset method), 30 zrevrank() (pyredis.commands.sset method), 30 zscan() (pyredis.commands.sset method), 30 zscore() (pyredis.commands.sset method), 30 zunionstore() (pyredis.commands.sset method), 30 Index 41