Code Documentation¶
Module¶
This module provides access to a redis server using a redis server embedded in the module. It provides enhanced redis bindings that are able to configure run, and cleanup a redis server when they are accessed.
-
redislite.
__version__
¶ str – The version of the redislite module.
-
redislite.
__redis_executable__
¶ str – The full path to the embedded redis-server executable.
-
redislite.
__redis_server_version__
¶ str – The version of the embedded redis-server built intot he module.
-
redislite.
__git_source_url__
¶ str – The github web url for the source code used to generate this module. This will be an empty string if the module was not built from a github repo.
-
redislite.
__git_version__
¶ str – Version number derived from the number of git revisions. This will be an empty string if not built from a git repo.
-
redislite.
__git_origin__
¶ str – The git origin of the source repository the module was built from. This will be an empty string if not built from a git repo.
-
redislite.
__git_branch__
¶ str – The git branch the module was built from. This will be an empty string if not built from a git repo.
-
redislite.
__git_hash__
¶ str – The git hash value for the code used to build this module.
Example
To access redis using a newly installed and configured redis server, then set and retrieve some data:
>>> import redislite
>>> connection = redislite.Redis()
>>> connection.set('key', 'value')
True
>>> connection.get('key')
'value'
>>>
redislite.Redis() Class¶
-
class
redislite.
Redis
(*args, **kwargs)[source]¶ Bases:
redislite.client.RedisMixin
,redis.client.Redis
This class provides an enhanced version of the
redis.Redis()
class that uses an embedded redis-server by default.Parameters: - dbfilename (str, optional) –
The name of the Redis db file to be used.
This argument is only used if the embedded redis-server is used.
The value of this argument is provided as the “dbfilename” setting in the embedded redis server configuration. This will result in the embedded redis server dumping it’s database to this file on exit/close.
This will also result in the embedded redis server using an existing redis rdb database if the file exists on start.
If this file exists and is in use by another redislite instance, this class will get a reference to the existing running redis instance so both instances share the same redis-server process and don’t corrupt the db file.
- serverconfig (dict, optional) –
A dictionary of additional redis-server configuration settings. The key is the name of the setting in the configuration file, the values may be list, str, or None.
If the value is a list the setting will be repeated in the configuration, once for each value.
If the value is a string, the setting will occur once with that string as the setting.
If the value is None, the setting will be removed from the default setting values if it exists in the defaults.
- host (str, optional) –
The hostname or ip address of the redis server to connect to.
If this argument is specified the embedded redis server will not be used.
- port (int, optional) –
The port number of the redis server to connect to.
If this argument is specified, the embedded redis server will not be used.
- **kwargs (optional) – All other keyword arguments supported by the
redis.Redis()
class are supported.
Returns: Return type: A
redislite.Redis()
objectRaises: RedisLiteServerStartError
– The embedded Redis server failed to startExample
redis_connection =
redislite.Redis('/tmp/redis.db')
Notes
If the dbfilename argument is not provided each instance will get a different redis-server instance.
-
db
¶ str – The fully qualified filename associated with the redis dbfilename configuration setting. This attribute is read only.
-
logfile
¶ str – The name of the redis-server logfile
-
pid
¶ int – Pid of the running embedded redis server, this attribute is read only.
-
redis_log
¶ str – The contents of the redis-server log file
-
start_timeout
¶ float – Number of seconds to wait for the redis-server process to start before generating a RedisLiteServerStartError exception.
-
append
(key, value)¶ Appends the string
value
to the value atkey
. Ifkey
doesn’t already exist, create it with a value ofvalue
. Returns the new length of the value atkey
.
-
bgrewriteaof
()¶ Tell the Redis server to rewrite the AOF file from data in memory.
-
bgsave
()¶ Tell the Redis server to save its data to disk. Unlike save(), this method is asynchronous and returns immediately.
-
bitcount
(key, start=None, end=None)¶ Returns the count of set bits in the value of
key
. Optionalstart
andend
paramaters indicate which bytes to consider
-
bitop
(operation, dest, *keys)¶ Perform a bitwise operation using
operation
betweenkeys
and store the result indest
.
-
bitpos
(key, bit, start=None, end=None)¶ Return the position of the first bit set to 1 or 0 in a string.
start
andend
difines search range. The range is interpreted as a range of bytes and not a range of bits, so start=0 and end=2 means to look at the first three bytes.
-
blpop
(keys, timeout=0)¶ LPOP a value off of the first non-empty list named in the
keys
list.If none of the lists in
keys
has a value to LPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
-
brpop
(keys, timeout=0)¶ RPOP a value off of the first non-empty list named in the
keys
list.If none of the lists in
keys
has a value to LPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
-
brpoplpush
(src, dst, timeout=0)¶ Pop a value off the tail of
src
, push it on the head ofdst
and then return it.This command blocks until a value is in
src
or untiltimeout
seconds elapse, whichever is first. Atimeout
value of 0 blocks forever.
-
client_getname
()¶ Returns the current connection name
-
client_kill
(address)¶ Disconnects the client at
address
(ip:port)
-
client_list
()¶ Returns a list of currently connected clients
-
client_setname
(name)¶ Sets the current connection name
-
config_get
(pattern='*')¶ Return a dictionary of configuration based on the
pattern
-
config_resetstat
()¶ Reset runtime statistics
-
config_rewrite
()¶ Rewrite config file with the minimal change to reflect running config
-
config_set
(name, value)¶ Set config item
name
withvalue
-
db
Return the connection string to allow connecting to the same redis server. :return: connection_path
-
dbsize
()¶ Returns the number of keys in the current database
-
debug_object
(key)¶ Returns version specific meta information about a given key
-
decr
(name, amount=1)¶ Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
-
delete
(*names)¶ Delete one or more keys specified by
names
-
dump
(name)¶ Return a serialized version of the value stored at the specified key. If key does not exist a nil bulk reply is returned.
-
echo
(value)¶ Echo the string back from the server
-
eval
(script, numkeys, *keys_and_args)¶ Execute the Lua
script
, specifying thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.In practice, use the object returned by
register_script
. This function exists purely for Redis API completion.
-
evalsha
(sha, numkeys, *keys_and_args)¶ Use the
sha
to execute a Lua script already registered via EVAL or SCRIPT LOAD. Specify thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.In practice, use the object returned by
register_script
. This function exists purely for Redis API completion.
-
execute_command
(*args, **options)¶ Execute a command and return a parsed response
-
exists
(name)¶ Returns a boolean indicating whether key
name
exists
-
expire
(name, time)¶ Set an expire flag on key
name
fortime
seconds.time
can be represented by an integer or a Python timedelta object.
-
expireat
(name, when)¶ Set an expire flag on key
name
.when
can be represented as an integer indicating unix time or a Python datetime object.
-
flushall
()¶ Delete all keys in all databases on the current host
-
flushdb
()¶ Delete all keys in the current database
-
from_url
(url, db=None, **kwargs)¶ Return a Redis client object configured from the given URL.
For example:
redis://[:password]@localhost:6379/0 unix://[:password]@/path/to/socket.sock?db=0
There are several ways to specify a database number. The parse function will return the first specified option:
- A
db
querystring option, e.g. redis://localhost?db=0 - If using the redis:// scheme, the path argument of the url, e.g. redis://localhost/0
- The
db
argument to this function.
If none of these options are specified, db=0 is used.
Any additional querystring arguments and keyword arguments will be passed along to the ConnectionPool class’s initializer. In the case of conflicting arguments, querystring arguments always win.
- A
-
get
(name)¶ Return the value at key
name
, or None if the key doesn’t exist
-
getbit
(name, offset)¶ Returns a boolean indicating the value of
offset
inname
-
getrange
(key, start, end)¶ Returns the substring of the string value stored at
key
, determined by the offsetsstart
andend
(both are inclusive)
-
getset
(name, value)¶ Sets the value at key
name
tovalue
and returns the old value at keyname
atomically.
-
hdel
(name, *keys)¶ Delete
keys
from hashname
-
hexists
(name, key)¶ Returns a boolean indicating if
key
exists within hashname
-
hget
(name, key)¶ Return the value of
key
within the hashname
-
hgetall
(name)¶ Return a Python dict of the hash’s name/value pairs
-
hincrby
(name, key, amount=1)¶ Increment the value of
key
in hashname
byamount
-
hincrbyfloat
(name, key, amount=1.0)¶ Increment the value of
key
in hashname
by floatingamount
-
hkeys
(name)¶ Return the list of keys within hash
name
-
hlen
(name)¶ Return the number of elements in hash
name
-
hmget
(name, keys, *args)¶ Returns a list of values ordered identically to
keys
-
hmset
(name, mapping)¶ Set key to value within hash
name
for each corresponding key and value from themapping
dict.
-
hscan
(name, cursor=0, match=None, count=None)¶ Incrementally return key/value slices in a hash. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
hscan_iter
(name, match=None, count=None)¶ Make an iterator using the HSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
hset
(name, key, value)¶ Set
key
tovalue
within hashname
Returns 1 if HSET created a new field, otherwise 0
-
hsetnx
(name, key, value)¶ Set
key
tovalue
within hashname
ifkey
does not exist. Returns 1 if HSETNX created a field, otherwise 0.
-
hvals
(name)¶ Return the list of values within hash
name
-
incr
(name, amount=1)¶ Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
-
incrby
(name, amount=1)¶ Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
-
incrbyfloat
(name, amount=1.0)¶ Increments the value at key
name
by floatingamount
. If no key exists, the value will be initialized asamount
-
info
(section=None)¶ Returns a dictionary containing information about the Redis server
The
section
option can be used to select a specific section of informationThe section option is not supported by older versions of Redis Server, and will generate ResponseError
-
keys
(pattern='*')¶ Returns a list of keys matching
pattern
-
lastsave
()¶ Return a Python datetime object representing the last time the Redis database was saved to disk
-
lindex
(name, index)¶ Return the item from list
name
at positionindex
Negative indexes are supported and will return an item at the end of the list
-
linsert
(name, where, refvalue, value)¶ Insert
value
in listname
either immediately before or after [where
]refvalue
Returns the new length of the list on success or -1 if
refvalue
is not in the list.
-
llen
(name)¶ Return the length of the list
name
-
lock
(name, timeout=None, sleep=0.1, blocking_timeout=None, lock_class=None, thread_local=True)¶ Return a new Lock object using key
name
that mimics the behavior of threading.Lock.If specified,
timeout
indicates a maximum life for the lock. By default, it will remain locked until release() is called.sleep
indicates the amount of time to sleep per loop iteration when the lock is in blocking mode and another client is currently holding the lock.blocking_timeout
indicates the maximum amount of time in seconds to spend trying to acquire the lock. A value ofNone
indicates continue trying forever.blocking_timeout
can be specified as a float or integer, both representing the number of seconds to wait.lock_class
forces the specified lock implementation.thread_local
indicates whether the lock token is placed in thread-local storage. By default, the token is placed in thread local storage so that a thread only sees its token, not a token set by another thread. Consider the following timeline:- time: 0, thread-1 acquires my-lock, with a timeout of 5 seconds.
- thread-1 sets the token to “abc”
- time: 1, thread-2 blocks trying to acquire my-lock using the
- Lock instance.
- time: 5, thread-1 has not yet completed. redis expires the lock
- key.
- time: 5, thread-2 acquired my-lock now that it’s available.
- thread-2 sets the token to “xyz”
- time: 6, thread-1 finishes its work and calls release(). if the
- token is not stored in thread local storage, then thread-1 would see the token value as “xyz” and would be able to successfully release the thread-2’s lock.
In some use cases it’s necessary to disable thread local storage. For example, if you have code where one thread acquires a lock and passes that lock instance to a worker thread to release later. If thread local storage isn’t disabled in this case, the worker thread won’t see the token set by the thread that acquired the lock. Our assumption is that these cases aren’t common and as such default to using thread local storage.
-
lpop
(name)¶ Remove and return the first item of the list
name
-
lpush
(name, *values)¶ Push
values
onto the head of the listname
-
lpushx
(name, value)¶ Push
value
onto the head of the listname
ifname
exists
-
lrange
(name, start, end)¶ Return a slice of the list
name
between positionstart
andend
start
andend
can be negative numbers just like Python slicing notation
-
lrem
(name, value, num=0)[source]¶ Remove the first
num
occurrences of elements equal tovalue
from the list stored atname
.- The
num
argument influences the operation in the following ways: - num > 0: Remove elements equal to value moving from head to tail. num < 0: Remove elements equal to value moving from tail to head. num = 0: Remove all elements equal to value.
- The
-
lset
(name, index, value)¶ Set
position
of listname
tovalue
-
ltrim
(name, start, end)¶ Trim the list
name
, removing all values not within the slice betweenstart
andend
start
andend
can be negative numbers just like Python slicing notation
-
mget
(keys, *args)¶ Returns a list of values ordered identically to
keys
-
move
(name, db)¶ Moves the key
name
to a different Redis databasedb
-
mset
(*args, **kwargs)¶ Sets key/values based on a mapping. Mapping can be supplied as a single dictionary argument or as kwargs.
-
msetnx
(*args, **kwargs)¶ Sets key/values based on a mapping if none of the keys are already set. Mapping can be supplied as a single dictionary argument or as kwargs. Returns a boolean indicating if the operation was successful.
-
object
(infotype, key)¶ Return the encoding, idletime, or refcount about the key
-
parse_response
(connection, command_name, **options)¶ Parses a response from the Redis server
-
persist
(name)¶ Removes an expiration on
name
-
pexpire
(name, time)¶ Set an expire flag on key
name
fortime
milliseconds.time
can be represented by an integer or a Python timedelta object.
-
pexpireat
(name, when)¶ Set an expire flag on key
name
.when
can be represented as an integer representing unix time in milliseconds (unix time * 1000) or a Python datetime object.
-
pfadd
(name, *values)¶ Adds the specified elements to the specified HyperLogLog.
-
pfcount
(*sources)¶ Return the approximated cardinality of the set observed by the HyperLogLog at key(s).
-
pfmerge
(dest, *sources)¶ Merge N different HyperLogLogs into a single one.
-
pid
Get the current redis-server process id.
Returns: The process id of the redis-server process associated with this redislite instance or None. If the redis-server is not running. Return type: pid(int)
-
ping
()¶ Ping the Redis server
-
pipeline
(transaction=True, shard_hint=None)[source]¶ Return a new pipeline object that can queue multiple commands for later execution.
transaction
indicates whether all commands should be executed atomically. Apart from making a group of operations atomic, pipelines are useful for reducing the back-and-forth overhead between the client and server.
-
psetex
(name, time_ms, value)¶ Set the value of key
name
tovalue
that expires intime_ms
milliseconds.time_ms
can be represented by an integer or a Python timedelta object
-
pttl
(name)¶ Returns the number of milliseconds until the key
name
will expire
-
publish
(channel, message)¶ Publish
message
onchannel
. Returns the number of subscribers the message was delivered to.
-
pubsub
(**kwargs)¶ Return a Publish/Subscribe object. With this object, you can subscribe to channels and listen for messages that get published to them.
-
randomkey
()¶ Returns the name of a random key
-
redis_log
Redis server log content as a string
Returns: Log contents Return type: str
-
redis_log_tail
(lines=1, width=80)¶ The redis log output
Parameters: Returns: List of strings containing the lines from the logfile requested
Return type:
-
register_script
(script)¶ Register a Lua
script
specifying thekeys
it will touch. Returns a Script object that is callable and hides the complexity of deal with scripts, keys, and shas. This is the preferred way to work with Lua scripts.
-
rename
(src, dst)¶ Rename key
src
todst
-
renamenx
(src, dst)¶ Rename key
src
todst
ifdst
doesn’t already exist
-
restore
(name, ttl, value)¶ Create a key using the provided serialized value, previously obtained using DUMP.
-
rpop
(name)¶ Remove and return the last item of the list
name
-
rpoplpush
(src, dst)¶ RPOP a value off of the
src
list and atomically LPUSH it on to thedst
list. Returns the value.
-
rpush
(name, *values)¶ Push
values
onto the tail of the listname
-
rpushx
(name, value)¶ Push
value
onto the tail of the listname
ifname
exists
-
sadd
(name, *values)¶ Add
value(s)
to setname
-
save
()¶ Tell the Redis server to save its data to disk, blocking until the save is complete
-
scan
(cursor=0, match=None, count=None)¶ Incrementally return lists of key names. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
scan_iter
(match=None, count=None)¶ Make an iterator using the SCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
scard
(name)¶ Return the number of elements in set
name
-
script_exists
(*args)¶ Check if a script exists in the script cache by specifying the SHAs of each script as
args
. Returns a list of boolean values indicating if if each already script exists in the cache.
-
script_flush
()¶ Flush all scripts from the script cache
-
script_kill
()¶ Kill the currently executing Lua script
-
script_load
(script)¶ Load a Lua
script
into the script cache. Returns the SHA.
-
sdiff
(keys, *args)¶ Return the difference of sets specified by
keys
-
sdiffstore
(dest, keys, *args)¶ Store the difference of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
sentinel
(*args)¶ Redis Sentinel’s SENTINEL command.
-
sentinel_get_master_addr_by_name
(service_name)¶ Returns a (host, port) pair for the given
service_name
-
sentinel_master
(service_name)¶ Returns a dictionary containing the specified masters state.
-
sentinel_masters
()¶ Returns a list of dictionaries containing each master’s state.
-
sentinel_monitor
(name, ip, port, quorum)¶ Add a new master to Sentinel to be monitored
-
sentinel_remove
(name)¶ Remove a master from Sentinel’s monitoring
-
sentinel_sentinels
(service_name)¶ Returns a list of sentinels for
service_name
-
sentinel_set
(name, option, value)¶ Set Sentinel monitoring parameters for a given master
-
sentinel_slaves
(service_name)¶ Returns a list of slaves for
service_name
-
set
(name, value, ex=None, px=None, nx=False, xx=False)¶ Set the value at key
name
tovalue
ex
sets an expire flag on keyname
forex
seconds.px
sets an expire flag on keyname
forpx
milliseconds.nx
if set to True, set the value at keyname
tovalue
if it- does not already exist.
xx
if set to True, set the value at keyname
tovalue
if it- already exists.
-
set_response_callback
(command, callback)¶ Set a custom Response Callback
-
setbit
(name, offset, value)¶ Flag the
offset
inname
asvalue
. Returns a boolean indicating the previous value ofoffset
.
-
setex
(name, value, time)[source]¶ Set the value of key
name
tovalue
that expires intime
seconds.time
can be represented by an integer or a Python timedelta object.
-
setnx
(name, value)¶ Set the value of key
name
tovalue
if key doesn’t exist
-
setrange
(name, offset, value)¶ Overwrite bytes in the value of
name
starting atoffset
withvalue
. Ifoffset
plus the length ofvalue
exceeds the length of the original value, the new value will be larger than before. Ifoffset
exceeds the length of the original value, null bytes will be used to pad between the end of the previous value and the start of what’s being injected.Returns the length of the new string.
-
shutdown
()¶ Shutdown the server
-
sinter
(keys, *args)¶ Return the intersection of sets specified by
keys
-
sinterstore
(dest, keys, *args)¶ Store the intersection of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
sismember
(name, value)¶ Return a boolean indicating if
value
is a member of setname
-
slaveof
(host=None, port=None)¶ Set the server to be a replicated slave of the instance identified by the
host
andport
. If called without arguments, the instance is promoted to a master instead.
-
slowlog_get
(num=None)¶ Get the entries from the slowlog. If
num
is specified, get the most recentnum
items.
-
slowlog_len
()¶ Get the number of items in the slowlog
-
slowlog_reset
()¶ Remove all items in the slowlog
-
smembers
(name)¶ Return all members of the set
name
-
smove
(src, dst, value)¶ Move
value
from setsrc
to setdst
atomically
-
sort
(name, start=None, num=None, by=None, get=None, desc=False, alpha=False, store=None, groups=False)¶ Sort and return the list, set or sorted set at
name
.start
andnum
allow for paging through the sorted databy
allows using an external key to weight and sort the items.- Use an “*” to indicate where in the key the item value is located
get
allows for returning items from external keys rather than the- sorted data itself. Use an “*” to indicate where int he key the item value is located
desc
allows for reversing the sortalpha
allows for sorting lexicographically rather than numericallystore
allows for storing the result of the sort into- the key
store
groups
if set to True and ifget
contains at least two- elements, sort will return a list of tuples, each containing the
values fetched from the arguments to
get
.
-
spop
(name)¶ Remove and return a random member of set
name
-
srandmember
(name, number=None)¶ If
number
is None, returns a random member of setname
.If
number
is supplied, returns a list ofnumber
random memebers of setname
. Note this is only available when running Redis 2.6+.
-
srem
(name, *values)¶ Remove
values
from setname
-
sscan
(name, cursor=0, match=None, count=None)¶ Incrementally return lists of elements in a set. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
sscan_iter
(name, match=None, count=None)¶ Make an iterator using the SSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
strlen
(name)¶ Return the number of bytes stored in the value of
name
-
substr
(name, start, end=-1)¶ Return a substring of the string at key
name
.start
andend
are 0-based integers specifying the portion of the string to return.
-
sunion
(keys, *args)¶ Return the union of sets specified by
keys
-
sunionstore
(dest, keys, *args)¶ Store the union of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
time
()¶ Returns the server time as a 2-item tuple of ints: (seconds since epoch, microseconds into this second).
-
transaction
(func, *watches, **kwargs)¶ Convenience method for executing the callable func as a transaction while watching all keys specified in watches. The ‘func’ callable should expect a single argument which is a Pipeline object.
-
ttl
(name)¶ Returns the number of seconds until the key
name
will expire
-
type
(name)¶ Returns the type of key
name
-
unwatch
()¶ Unwatches the value at key
name
, or None of the key doesn’t exist
-
wait
(num_replicas, timeout)¶ Redis synchronous replication That returns the number of replicas that processed the query when we finally have at least
num_replicas
, or when thetimeout
was reached.
-
watch
(*names)¶ Watches the values at keys
names
, or None if the key doesn’t exist
-
zadd
(name, *args, **kwargs)[source]¶ NOTE: The order of arguments differs from that of the official ZADD command. For backwards compatability, this method accepts arguments in the form of name1, score1, name2, score2, while the official Redis documents expects score1, name1, score2, name2.
If you’re looking to use the standard syntax, consider using the StrictRedis class. See the API Reference section of the docs for more information.
Set any number of element-name, score pairs to the key
name
. Pairs can be specified in two ways:As *args, in the form of: name1, score1, name2, score2, ... or as **kwargs, in the form of: name1=score1, name2=score2, ...
The following example would add four values to the ‘my-key’ key: redis.zadd(‘my-key’, ‘name1’, 1.1, ‘name2’, 2.2, name3=3.3, name4=4.4)
-
zcard
(name)¶ Return the number of elements in the sorted set
name
-
zcount
(name, min, max)¶ Returns the number of elements in the sorted set at key
name
with a score betweenmin
andmax
.
-
zincrby
(name, value, amount=1)¶ Increment the score of
value
in sorted setname
byamount
-
zinterstore
(dest, keys, aggregate=None)¶ Intersect multiple sorted sets specified by
keys
into a new sorted set,dest
. Scores in the destination will be aggregated based on theaggregate
, or SUM if none is provided.
-
zlexcount
(name, min, max)¶ Return the number of items in the sorted set
name
between the lexicographical rangemin
andmax
.
-
zrange
(name, start, end, desc=False, withscores=False, score_cast_func=<type 'float'>)¶ Return a range of values from sorted set
name
betweenstart
andend
sorted in ascending order.start
andend
can be negative, indicating the end of the range.desc
a boolean indicating whether to sort the results descendinglywithscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrangebylex
(name, min, max, start=None, num=None)¶ Return the lexicographical range of values from sorted set
name
betweenmin
andmax
.If
start
andnum
are specified, then return a slice of the range.
-
zrangebyscore
(name, min, max, start=None, num=None, withscores=False, score_cast_func=<type 'float'>)¶ Return a range of values from the sorted set
name
with scores betweenmin
andmax
.If
start
andnum
are specified, then return a slice of the range.withscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func` a callable used to cast the score return value
-
zrank
(name, value)¶ Returns a 0-based value indicating the rank of
value
in sorted setname
-
zrem
(name, *values)¶ Remove member
values
from sorted setname
-
zremrangebylex
(name, min, max)¶ Remove all elements in the sorted set
name
between the lexicographical range specified bymin
andmax
.Returns the number of elements removed.
-
zremrangebyrank
(name, min, max)¶ Remove all elements in the sorted set
name
with ranks betweenmin
andmax
. Values are 0-based, ordered from smallest score to largest. Values can be negative indicating the highest scores. Returns the number of elements removed
-
zremrangebyscore
(name, min, max)¶ Remove all elements in the sorted set
name
with scores betweenmin
andmax
. Returns the number of elements removed.
-
zrevrange
(name, start, end, withscores=False, score_cast_func=<type 'float'>)¶ Return a range of values from sorted set
name
betweenstart
andend
sorted in descending order.start
andend
can be negative, indicating the end of the range.withscores
indicates to return the scores along with the values The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrevrangebylex
(name, max, min, start=None, num=None)¶ Return the reversed lexicographical range of values from sorted set
name
betweenmax
andmin
.If
start
andnum
are specified, then return a slice of the range.
-
zrevrangebyscore
(name, max, min, start=None, num=None, withscores=False, score_cast_func=<type 'float'>)¶ Return a range of values from the sorted set
name
with scores betweenmin
andmax
in descending order.If
start
andnum
are specified, then return a slice of the range.withscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrevrank
(name, value)¶ Returns a 0-based value indicating the descending rank of
value
in sorted setname
-
zscan
(name, cursor=0, match=None, count=None, score_cast_func=<type 'float'>)¶ Incrementally return lists of elements in a sorted set. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returnsscore_cast_func
a callable used to cast the score return value
-
zscan_iter
(name, match=None, count=None, score_cast_func=<type 'float'>)¶ Make an iterator using the ZSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returnsscore_cast_func
a callable used to cast the score return value
-
zscore
(name, value)¶ Return the score of element
value
in sorted setname
-
zunionstore
(dest, keys, aggregate=None)¶ Union multiple sorted sets specified by
keys
into a new sorted set,dest
. Scores in the destination will be aggregated based on theaggregate
, or SUM if none is provided.
- dbfilename (str, optional) –
redislite.StrictRedis() Class¶
-
class
redislite.
StrictRedis
(*args, **kwargs)[source]¶ Bases:
redislite.client.RedisMixin
,redis.client.StrictRedis
This class provides an enhanced version of the
redis.StrictRedis()
class that uses an embedded redis-server by default.Example
redis_connection =
redislite.StrictRedis('/tmp/redis.db')
Notes
If the dbfilename argument is not provided each instance will get a different redis-server instance.
Parameters: dbfilename (str) – The name of the Redis db file to be used. This argument is only used if the embedded redis-server is used. The value of this argument is provided as the “dbfilename” setting in the embedded redis server configuration. This will result in the embedded redis server dumping it’s database to this file on exit/close. This will also result in the embedded redis server using an existing redis database if the file exists on start. If this file exists and is in use by another redislite instance, this class will get a reference to the existing running redis instance so both instances share the same redis-server process and don’t corrupt the db file. - Kwargs:
- host(str):
- The hostname or ip address of the redis server to connect to. If this argument is not None, the embedded redis server will not be used. Defaults to None.
- port(int): The
- port number of the redis server to connect to. If this argument is not None, the embedded redis server will not be used. Defaults to None.
- serverconfig(dict): A dictionary of additional redis-server
configuration settings. All keys and values must be str. Supported keys are:
activerehashing, aof_rewrite_incremental_fsync, appendfilename, appendfsync, appendonly, auto_aof_rewrite_min_size, auto_aof_rewrite_percentage, aof_load_truncated, databases, hash_max_ziplist_entries, hash_max_ziplist_value, hll_sparse_max_bytes, hz, latency_monitor_threshold, list_max_ziplist_entries, list_max_ziplist_value, logfile, loglevel, lua_time_limit, no_appendfsync_on_rewrite, notify_keyspace_events, port, rdbchecksum, rdbcompression, repl_disable_tcp_nodelay, slave_read_only, slave_serve_stale_data, stop_writes_on_bgsave_error, tcp_backlog, tcp_keepalive, unixsocket, unixsocketperm, slave_priority, timeout, set_max_intset_entries, zset_max_ziplist_entries, zset_max_ziplist_value
Returns: A redis.StrictRedis()
class object if the host or port arguments where set or aredislite.StrictRedis()
object otherwise.Raises: RedisLiteServerStartError
-
db
¶ string – The fully qualified filename associated with the redis dbfilename configuration setting. This attribute is read only.
-
pid
¶ int – Pid of the running embedded redis server, this attribute is read only.
-
start_timeout
¶ float – Number of seconds to wait for the redis-server process to start before generating a RedisLiteServerStartError exception.
-
append
(key, value)[source]¶ Appends the string
value
to the value atkey
. Ifkey
doesn’t already exist, create it with a value ofvalue
. Returns the new length of the value atkey
.
-
bgsave
()[source]¶ Tell the Redis server to save its data to disk. Unlike save(), this method is asynchronous and returns immediately.
-
bitcount
(key, start=None, end=None)[source]¶ Returns the count of set bits in the value of
key
. Optionalstart
andend
paramaters indicate which bytes to consider
-
bitop
(operation, dest, *keys)[source]¶ Perform a bitwise operation using
operation
betweenkeys
and store the result indest
.
-
bitpos
(key, bit, start=None, end=None)[source]¶ Return the position of the first bit set to 1 or 0 in a string.
start
andend
difines search range. The range is interpreted as a range of bytes and not a range of bits, so start=0 and end=2 means to look at the first three bytes.
-
blpop
(keys, timeout=0)[source]¶ LPOP a value off of the first non-empty list named in the
keys
list.If none of the lists in
keys
has a value to LPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
-
brpop
(keys, timeout=0)[source]¶ RPOP a value off of the first non-empty list named in the
keys
list.If none of the lists in
keys
has a value to LPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
-
brpoplpush
(src, dst, timeout=0)[source]¶ Pop a value off the tail of
src
, push it on the head ofdst
and then return it.This command blocks until a value is in
src
or untiltimeout
seconds elapse, whichever is first. Atimeout
value of 0 blocks forever.
-
db
Return the connection string to allow connecting to the same redis server. :return: connection_path
-
decr
(name, amount=1)[source]¶ Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
-
dump
(name)[source]¶ Return a serialized version of the value stored at the specified key. If key does not exist a nil bulk reply is returned.
-
eval
(script, numkeys, *keys_and_args)[source]¶ Execute the Lua
script
, specifying thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.In practice, use the object returned by
register_script
. This function exists purely for Redis API completion.
-
evalsha
(sha, numkeys, *keys_and_args)[source]¶ Use the
sha
to execute a Lua script already registered via EVAL or SCRIPT LOAD. Specify thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.In practice, use the object returned by
register_script
. This function exists purely for Redis API completion.
-
expire
(name, time)[source]¶ Set an expire flag on key
name
fortime
seconds.time
can be represented by an integer or a Python timedelta object.
-
expireat
(name, when)[source]¶ Set an expire flag on key
name
.when
can be represented as an integer indicating unix time or a Python datetime object.
-
from_url
(url, db=None, **kwargs)[source]¶ Return a Redis client object configured from the given URL.
For example:
redis://[:password]@localhost:6379/0 unix://[:password]@/path/to/socket.sock?db=0
There are several ways to specify a database number. The parse function will return the first specified option:
- A
db
querystring option, e.g. redis://localhost?db=0 - If using the redis:// scheme, the path argument of the url, e.g. redis://localhost/0
- The
db
argument to this function.
If none of these options are specified, db=0 is used.
Any additional querystring arguments and keyword arguments will be passed along to the ConnectionPool class’s initializer. In the case of conflicting arguments, querystring arguments always win.
- A
-
getrange
(key, start, end)[source]¶ Returns the substring of the string value stored at
key
, determined by the offsetsstart
andend
(both are inclusive)
-
getset
(name, value)[source]¶ Sets the value at key
name
tovalue
and returns the old value at keyname
atomically.
-
hincrbyfloat
(name, key, amount=1.0)[source]¶ Increment the value of
key
in hashname
by floatingamount
-
hmset
(name, mapping)[source]¶ Set key to value within hash
name
for each corresponding key and value from themapping
dict.
-
hscan
(name, cursor=0, match=None, count=None)[source]¶ Incrementally return key/value slices in a hash. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
hscan_iter
(name, match=None, count=None)[source]¶ Make an iterator using the HSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
hset
(name, key, value)[source]¶ Set
key
tovalue
within hashname
Returns 1 if HSET created a new field, otherwise 0
-
hsetnx
(name, key, value)[source]¶ Set
key
tovalue
within hashname
ifkey
does not exist. Returns 1 if HSETNX created a field, otherwise 0.
-
incr
(name, amount=1)[source]¶ Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
-
incrby
(name, amount=1)[source]¶ Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
-
incrbyfloat
(name, amount=1.0)[source]¶ Increments the value at key
name
by floatingamount
. If no key exists, the value will be initialized asamount
-
info
(section=None)[source]¶ Returns a dictionary containing information about the Redis server
The
section
option can be used to select a specific section of informationThe section option is not supported by older versions of Redis Server, and will generate ResponseError
-
lastsave
()[source]¶ Return a Python datetime object representing the last time the Redis database was saved to disk
-
lindex
(name, index)[source]¶ Return the item from list
name
at positionindex
Negative indexes are supported and will return an item at the end of the list
-
linsert
(name, where, refvalue, value)[source]¶ Insert
value
in listname
either immediately before or after [where
]refvalue
Returns the new length of the list on success or -1 if
refvalue
is not in the list.
-
lock
(name, timeout=None, sleep=0.1, blocking_timeout=None, lock_class=None, thread_local=True)[source]¶ Return a new Lock object using key
name
that mimics the behavior of threading.Lock.If specified,
timeout
indicates a maximum life for the lock. By default, it will remain locked until release() is called.sleep
indicates the amount of time to sleep per loop iteration when the lock is in blocking mode and another client is currently holding the lock.blocking_timeout
indicates the maximum amount of time in seconds to spend trying to acquire the lock. A value ofNone
indicates continue trying forever.blocking_timeout
can be specified as a float or integer, both representing the number of seconds to wait.lock_class
forces the specified lock implementation.thread_local
indicates whether the lock token is placed in thread-local storage. By default, the token is placed in thread local storage so that a thread only sees its token, not a token set by another thread. Consider the following timeline:- time: 0, thread-1 acquires my-lock, with a timeout of 5 seconds.
- thread-1 sets the token to “abc”
- time: 1, thread-2 blocks trying to acquire my-lock using the
- Lock instance.
- time: 5, thread-1 has not yet completed. redis expires the lock
- key.
- time: 5, thread-2 acquired my-lock now that it’s available.
- thread-2 sets the token to “xyz”
- time: 6, thread-1 finishes its work and calls release(). if the
- token is not stored in thread local storage, then thread-1 would see the token value as “xyz” and would be able to successfully release the thread-2’s lock.
In some use cases it’s necessary to disable thread local storage. For example, if you have code where one thread acquires a lock and passes that lock instance to a worker thread to release later. If thread local storage isn’t disabled in this case, the worker thread won’t see the token set by the thread that acquired the lock. Our assumption is that these cases aren’t common and as such default to using thread local storage.
-
lrange
(name, start, end)[source]¶ Return a slice of the list
name
between positionstart
andend
start
andend
can be negative numbers just like Python slicing notation
-
lrem
(name, count, value)[source]¶ Remove the first
count
occurrences of elements equal tovalue
from the list stored atname
.- The count argument influences the operation in the following ways:
- count > 0: Remove elements equal to value moving from head to tail. count < 0: Remove elements equal to value moving from tail to head. count = 0: Remove all elements equal to value.
-
ltrim
(name, start, end)[source]¶ Trim the list
name
, removing all values not within the slice betweenstart
andend
start
andend
can be negative numbers just like Python slicing notation
-
mset
(*args, **kwargs)[source]¶ Sets key/values based on a mapping. Mapping can be supplied as a single dictionary argument or as kwargs.
-
msetnx
(*args, **kwargs)[source]¶ Sets key/values based on a mapping if none of the keys are already set. Mapping can be supplied as a single dictionary argument or as kwargs. Returns a boolean indicating if the operation was successful.
-
parse_response
(connection, command_name, **options)[source]¶ Parses a response from the Redis server
-
pexpire
(name, time)[source]¶ Set an expire flag on key
name
fortime
milliseconds.time
can be represented by an integer or a Python timedelta object.
-
pexpireat
(name, when)[source]¶ Set an expire flag on key
name
.when
can be represented as an integer representing unix time in milliseconds (unix time * 1000) or a Python datetime object.
-
pfcount
(*sources)[source]¶ Return the approximated cardinality of the set observed by the HyperLogLog at key(s).
-
pid
Get the current redis-server process id.
Returns: The process id of the redis-server process associated with this redislite instance or None. If the redis-server is not running. Return type: pid(int)
-
pipeline
(transaction=True, shard_hint=None)[source]¶ Return a new pipeline object that can queue multiple commands for later execution.
transaction
indicates whether all commands should be executed atomically. Apart from making a group of operations atomic, pipelines are useful for reducing the back-and-forth overhead between the client and server.
-
psetex
(name, time_ms, value)[source]¶ Set the value of key
name
tovalue
that expires intime_ms
milliseconds.time_ms
can be represented by an integer or a Python timedelta object
-
publish
(channel, message)[source]¶ Publish
message
onchannel
. Returns the number of subscribers the message was delivered to.
-
pubsub
(**kwargs)[source]¶ Return a Publish/Subscribe object. With this object, you can subscribe to channels and listen for messages that get published to them.
-
redis_log_tail
(lines=1, width=80)¶ The redis log output
Parameters: Returns: List of strings containing the lines from the logfile requested
Return type:
-
register_script
(script)[source]¶ Register a Lua
script
specifying thekeys
it will touch. Returns a Script object that is callable and hides the complexity of deal with scripts, keys, and shas. This is the preferred way to work with Lua scripts.
-
restore
(name, ttl, value)[source]¶ Create a key using the provided serialized value, previously obtained using DUMP.
-
rpoplpush
(src, dst)[source]¶ RPOP a value off of the
src
list and atomically LPUSH it on to thedst
list. Returns the value.
-
scan
(cursor=0, match=None, count=None)[source]¶ Incrementally return lists of key names. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
scan_iter
(match=None, count=None)[source]¶ Make an iterator using the SCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
script_exists
(*args)[source]¶ Check if a script exists in the script cache by specifying the SHAs of each script as
args
. Returns a list of boolean values indicating if if each already script exists in the cache.
-
sdiffstore
(dest, keys, *args)[source]¶ Store the difference of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
sentinel_get_master_addr_by_name
(service_name)[source]¶ Returns a (host, port) pair for the given
service_name
-
set
(name, value, ex=None, px=None, nx=False, xx=False)[source]¶ Set the value at key
name
tovalue
ex
sets an expire flag on keyname
forex
seconds.px
sets an expire flag on keyname
forpx
milliseconds.nx
if set to True, set the value at keyname
tovalue
if it- does not already exist.
xx
if set to True, set the value at keyname
tovalue
if it- already exists.
-
setbit
(name, offset, value)[source]¶ Flag the
offset
inname
asvalue
. Returns a boolean indicating the previous value ofoffset
.
-
setex
(name, time, value)[source]¶ Set the value of key
name
tovalue
that expires intime
seconds.time
can be represented by an integer or a Python timedelta object.
-
setrange
(name, offset, value)[source]¶ Overwrite bytes in the value of
name
starting atoffset
withvalue
. Ifoffset
plus the length ofvalue
exceeds the length of the original value, the new value will be larger than before. Ifoffset
exceeds the length of the original value, null bytes will be used to pad between the end of the previous value and the start of what’s being injected.Returns the length of the new string.
-
sinterstore
(dest, keys, *args)[source]¶ Store the intersection of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
slaveof
(host=None, port=None)[source]¶ Set the server to be a replicated slave of the instance identified by the
host
andport
. If called without arguments, the instance is promoted to a master instead.
-
slowlog_get
(num=None)[source]¶ Get the entries from the slowlog. If
num
is specified, get the most recentnum
items.
-
sort
(name, start=None, num=None, by=None, get=None, desc=False, alpha=False, store=None, groups=False)[source]¶ Sort and return the list, set or sorted set at
name
.start
andnum
allow for paging through the sorted databy
allows using an external key to weight and sort the items.- Use an “*” to indicate where in the key the item value is located
get
allows for returning items from external keys rather than the- sorted data itself. Use an “*” to indicate where int he key the item value is located
desc
allows for reversing the sortalpha
allows for sorting lexicographically rather than numericallystore
allows for storing the result of the sort into- the key
store
groups
if set to True and ifget
contains at least two- elements, sort will return a list of tuples, each containing the
values fetched from the arguments to
get
.
-
srandmember
(name, number=None)[source]¶ If
number
is None, returns a random member of setname
.If
number
is supplied, returns a list ofnumber
random memebers of setname
. Note this is only available when running Redis 2.6+.
-
sscan
(name, cursor=0, match=None, count=None)[source]¶ Incrementally return lists of elements in a set. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
sscan_iter
(name, match=None, count=None)[source]¶ Make an iterator using the SSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returns
-
substr
(name, start, end=-1)[source]¶ Return a substring of the string at key
name
.start
andend
are 0-based integers specifying the portion of the string to return.
-
sunionstore
(dest, keys, *args)[source]¶ Store the union of sets specified by
keys
into a new set nameddest
. Returns the number of keys in the new set.
-
time
()[source]¶ Returns the server time as a 2-item tuple of ints: (seconds since epoch, microseconds into this second).
-
transaction
(func, *watches, **kwargs)[source]¶ Convenience method for executing the callable func as a transaction while watching all keys specified in watches. The ‘func’ callable should expect a single argument which is a Pipeline object.
-
wait
(num_replicas, timeout)[source]¶ Redis synchronous replication That returns the number of replicas that processed the query when we finally have at least
num_replicas
, or when thetimeout
was reached.
-
zadd
(name, *args, **kwargs)[source]¶ Set any number of score, element-name pairs to the key
name
. Pairs can be specified in two ways:As *args, in the form of: score1, name1, score2, name2, ... or as **kwargs, in the form of: name1=score1, name2=score2, ...
The following example would add four values to the ‘my-key’ key: redis.zadd(‘my-key’, 1.1, ‘name1’, 2.2, ‘name2’, name3=3.3, name4=4.4)
-
zcount
(name, min, max)[source]¶ Returns the number of elements in the sorted set at key
name
with a score betweenmin
andmax
.
-
zinterstore
(dest, keys, aggregate=None)[source]¶ Intersect multiple sorted sets specified by
keys
into a new sorted set,dest
. Scores in the destination will be aggregated based on theaggregate
, or SUM if none is provided.
-
zlexcount
(name, min, max)[source]¶ Return the number of items in the sorted set
name
between the lexicographical rangemin
andmax
.
-
zrange
(name, start, end, desc=False, withscores=False, score_cast_func=<type 'float'>)[source]¶ Return a range of values from sorted set
name
betweenstart
andend
sorted in ascending order.start
andend
can be negative, indicating the end of the range.desc
a boolean indicating whether to sort the results descendinglywithscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrangebylex
(name, min, max, start=None, num=None)[source]¶ Return the lexicographical range of values from sorted set
name
betweenmin
andmax
.If
start
andnum
are specified, then return a slice of the range.
-
zrangebyscore
(name, min, max, start=None, num=None, withscores=False, score_cast_func=<type 'float'>)[source]¶ Return a range of values from the sorted set
name
with scores betweenmin
andmax
.If
start
andnum
are specified, then return a slice of the range.withscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func` a callable used to cast the score return value
-
zremrangebylex
(name, min, max)[source]¶ Remove all elements in the sorted set
name
between the lexicographical range specified bymin
andmax
.Returns the number of elements removed.
-
zremrangebyrank
(name, min, max)[source]¶ Remove all elements in the sorted set
name
with ranks betweenmin
andmax
. Values are 0-based, ordered from smallest score to largest. Values can be negative indicating the highest scores. Returns the number of elements removed
-
zremrangebyscore
(name, min, max)[source]¶ Remove all elements in the sorted set
name
with scores betweenmin
andmax
. Returns the number of elements removed.
-
zrevrange
(name, start, end, withscores=False, score_cast_func=<type 'float'>)[source]¶ Return a range of values from sorted set
name
betweenstart
andend
sorted in descending order.start
andend
can be negative, indicating the end of the range.withscores
indicates to return the scores along with the values The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrevrangebylex
(name, max, min, start=None, num=None)[source]¶ Return the reversed lexicographical range of values from sorted set
name
betweenmax
andmin
.If
start
andnum
are specified, then return a slice of the range.
-
zrevrangebyscore
(name, max, min, start=None, num=None, withscores=False, score_cast_func=<type 'float'>)[source]¶ Return a range of values from the sorted set
name
with scores betweenmin
andmax
in descending order.If
start
andnum
are specified, then return a slice of the range.withscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairsscore_cast_func
a callable used to cast the score return value
-
zrevrank
(name, value)[source]¶ Returns a 0-based value indicating the descending rank of
value
in sorted setname
-
zscan
(name, cursor=0, match=None, count=None, score_cast_func=<type 'float'>)[source]¶ Incrementally return lists of elements in a sorted set. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returnsscore_cast_func
a callable used to cast the score return value
-
zscan_iter
(name, match=None, count=None, score_cast_func=<type 'float'>)[source]¶ Make an iterator using the ZSCAN command so that the client doesn’t need to remember the cursor position.
match
allows for filtering the keys by patterncount
allows for hint the minimum number of returnsscore_cast_func
a callable used to cast the score return value
Functions to patch the redis module¶
Functions to replace (monkeypatch) the redis module classes with redislite classes.
-
redislite.patch.
patch_redis
(dbfile=None)[source]¶ Patch all the redis classes provided by redislite that have been patched.
Example
patch_redis(‘/tmp/redis.db’)
Notes
If the dbfile parameter is not passed, each any instances of
redis.StrictRedis()
class with no arguments will get a unique instance of the redis server. If the dbfile parameter is provided, all instances ofredis.Redis()
will share/reference the same instance of the redis server.Parameters: dbfile (str) – The name of the Redis db file to be used. If this argument is passed all instances of the redis.Redis()
class will share a single instance of the embedded redis server.Returns: This function does not return any values.
-
redislite.patch.
patch_redis_Redis
(dbfile=None)[source]¶ This class patches the redis module to replace the
redis.Redis()
class with the redislite enhancedredislite.Redis()
class that uses the embedded redis server.Example
patch_redis_Redis(‘/tmp/redis.db’)
Notes
If the dbfile parameter is not passed, each instance of the redis.Redis() class with no arguments will get a separate redis server. If the dbfile parameter is provided, all instances of the redis.Redis() class without a host or path argument will share/reference the same redis server.
Parameters: dbfile (str) – The name of the Redis db file to be used. If this argument is passed all instances of the redis.Redis
class will share a single embedded redis server.Returns: This function does not return any values.
-
redislite.patch.
patch_redis_StrictRedis
(dbfile=None)[source]¶ This class patches the redis module to replace the :param dbfile:
redis.StrictRedis()
class with the redislite enhancedredislite.StrictRedis()
class that uses the embedded redis server.Example
patch_redis_StrictRedis(‘/tmp/redis.db’)
Notes
If the dbfile parameter is not passed, all
redis.StrictRedis()
class with no arguments will get a separate redis server. If the dbfile parameter is provided, all instances of theredis.Redis()
class passed with the same dbfile value will share/reference the same redis server.Parameters: dbfile (str) – The name of the Redis db file to be used. If this argument is passed all instances of the redis.Redis
class will share a single instance of the embedded redis server.Returns: This function does not return any values.
-
redislite.patch.
unpatch_redis
()[source]¶ Unpatch all the redis classes provided by
redislite
that have been patched.Example
unpatch_redis()
Functions for troubleshooting¶
Redislite Debug Utilities
This module contains utility functions useful for troubleshooting redislite.
This module can be run from the command line using the following command:
python -m redislite.debug
This will output information like the following:
$ python -m redislite.debug
Redislite debug information:
Version: 1.0.171
Module Path: /tmp/redislite/lib/python3.4/site-packages/redislite
Installed Redis Server:
Redis Executable: /tmp/redislite/lib/python3.4/site-packages/redislite/bin/redis-server
build = 3a2b5dab9c14cd5e
sha = 4657e47d:1
bits = 64
v = 2.8.17
malloc = libc
Found redis-server: /tmp/redislite/lib/python3.4/site-packages/redislite/bin/redis-server
v = 2.8.17
sha = 4657e47d:1
malloc = libc
bits = 64
build = 3a2b5dab9c14cd5e
Source Code Information
Git Source URL: https://github.com/yahoo/redislite/tree/2ebd1b4d9c9ad41c78e8048fda3c69d2917c0348
Git Hash: 2ebd1b4d9c9ad41c78e8048fda3c69d2917c0348
Git Version: 1.0.171
Git Origin: https://github.com/yahoo/redislite.git
Git Branch: master
When run from the command line this will print a dump of information about the module and it’s build information.