Redis Commands#
Core Commands#
The following functions can be used to replicate their equivalent Redis command. Generally they can be used as functions on your redis connection. For the simplest example, see below:
Getting and settings data in redis:
import redis
r = redis.Redis(decode_responses=True)
r.set('mykey', 'thevalueofmykey')
r.get('mykey')
- class redis.commands.core.CoreCommands(*args, **kwargs)[source]#
A class containing all of the implemented redis commands. This class is to be used as a mixin for synchronous Redis clients.
- acl_cat(category=None, **kwargs)#
Returns a list of categories or commands within a category.
If
category
is not supplied, returns a list of all categories. Ifcategory
is supplied, returns a list of all commands within that category.For more information see https://redis.io/commands/acl-cat
- Parameters
category (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- acl_deluser(*username, **kwargs)#
Delete the ACL for the specified
username
sFor more information see https://redis.io/commands/acl-deluser
- Parameters
username (str) –
- Return type
Union[Awaitable[Any], Any]
- acl_dryrun(username, *args, **kwargs)#
Simulate the execution of a given command by a given
username
.For more information see https://redis.io/commands/acl-dryrun
- acl_genpass(bits=None, **kwargs)#
Generate a random password value. If
bits
is supplied then use this number of bits, rounded to the next multiple of 4. See: https://redis.io/commands/acl-genpass- Parameters
bits (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- acl_getuser(username, **kwargs)#
Get the ACL details for the specified
username
.If
username
does not exist, return NoneFor more information see https://redis.io/commands/acl-getuser
- Parameters
username (str) –
- Return type
Union[Awaitable[Any], Any]
- acl_help(**kwargs)#
The ACL HELP command returns helpful text describing the different subcommands.
For more information see https://redis.io/commands/acl-help
- Return type
Union[Awaitable[Any], Any]
- acl_list(**kwargs)#
Return a list of all ACLs on the server
For more information see https://redis.io/commands/acl-list
- Return type
Union[Awaitable[Any], Any]
- acl_load(**kwargs)#
Load ACL rules from the configured
aclfile
.Note that the server must be configured with the
aclfile
directive to be able to load ACL rules from an aclfile.For more information see https://redis.io/commands/acl-load
- Return type
Union[Awaitable[Any], Any]
- acl_log(count=None, **kwargs)#
Get ACL logs as a list. :param int count: Get logs[0:count]. :rtype: List.
For more information see https://redis.io/commands/acl-log
- Parameters
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- acl_log_reset(**kwargs)#
Reset ACL logs. :rtype: Boolean.
For more information see https://redis.io/commands/acl-log
- Return type
Union[Awaitable[Any], Any]
- acl_save(**kwargs)#
Save ACL rules to the configured
aclfile
.Note that the server must be configured with the
aclfile
directive to be able to save ACL rules to an aclfile.For more information see https://redis.io/commands/acl-save
- Return type
Union[Awaitable[Any], Any]
- acl_setuser(username, enabled=False, nopass=False, passwords=None, hashed_passwords=None, categories=None, commands=None, keys=None, channels=None, selectors=None, reset=False, reset_keys=False, reset_channels=False, reset_passwords=False, **kwargs)#
Create or update an ACL user.
Create or update the ACL for username. If the user already exists, the existing ACL is completely overwritten and replaced with the specified values.
For more information, see https://redis.io/commands/acl-setuser
- Parameters
username (str) – The name of the user whose ACL is to be created or updated.
enabled (bool) – Indicates whether the user should be allowed to authenticate. Defaults to False.
nopass (bool) – Indicates whether the user can authenticate without a password. This cannot be True if passwords are also specified.
passwords (Optional[Union[str, Iterable[str]]]) – A list of plain text passwords to add to or remove from the user. Each password must be prefixed with a ‘+’ to add or a ‘-’ to remove. For convenience, a single prefixed string can be used when adding or removing a single password.
hashed_passwords (Optional[Union[str, Iterable[str]]]) – A list of SHA-256 hashed passwords to add to or remove from the user. Each hashed password must be prefixed with a ‘+’ to add or a ‘-’ to remove. For convenience, a single prefixed string can be used when adding or removing a single password.
categories (Optional[Iterable[str]]) – A list of strings representing category permissions. Each string must be prefixed with either a ‘+’ to add the category permission or a ‘-’ to remove the category permission.
commands (Optional[Iterable[str]]) – A list of strings representing command permissions. Each string must be prefixed with either a ‘+’ to add the command permission or a ‘-’ to remove the command permission.
keys (Optional[Iterable[Union[bytes, str, memoryview]]]) – A list of key patterns to grant the user access to. Key patterns allow
'*'
to support wildcard matching. For example,'*'
grants access to all keys while'cache:*'
grants access to all keys that are prefixed withcache:
. keys should not be prefixed with a'~'
.reset (bool) – Indicates whether the user should be fully reset prior to applying the new ACL. Setting this to True will remove all existing passwords, flags, and privileges from the user and then apply the specified rules. If False, the user’s existing passwords, flags, and privileges will be kept and any new specified rules will be applied on top.
reset_keys (bool) – Indicates whether the user’s key permissions should be reset prior to applying any new key permissions specified in keys. If False, the user’s existing key permissions will be kept and any new specified key permissions will be applied on top.
reset_channels (bool) – Indicates whether the user’s channel permissions should be reset prior to applying any new channel permissions specified in channels. If False, the user’s existing channel permissions will be kept and any new specified channel permissions will be applied on top.
reset_passwords (bool) – Indicates whether to remove all existing passwords and the nopass flag from the user prior to applying any new passwords specified in passwords or hashed_passwords. If False, the user’s existing passwords and nopass status will be kept and any new specified passwords or hashed passwords will be applied on top.
channels (Optional[Iterable[Union[bytes, str, memoryview]]]) –
selectors (Optional[Iterable[Tuple[str, Union[bytes, str, memoryview]]]]) –
- Return type
Union[Awaitable[Any], Any]
- acl_users(**kwargs)#
Returns a list of all registered users on the server.
For more information see https://redis.io/commands/acl-users
- Return type
Union[Awaitable[Any], Any]
- acl_whoami(**kwargs)#
Get the username for the current connection
For more information see https://redis.io/commands/acl-whoami
- Return type
Union[Awaitable[Any], Any]
- 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
.For more information see https://redis.io/commands/append
- Parameters
key (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- auth(password, username=None, **kwargs)#
Authenticates the user. If you do not pass username, Redis will try to authenticate for the “default” user. If you do pass username, it will authenticate for the given user. For more information see https://redis.io/commands/auth
- Parameters
password (str) –
username (Optional[str]) –
- bgrewriteaof(**kwargs)#
Tell the Redis server to rewrite the AOF file from data in memory.
For more information see https://redis.io/commands/bgrewriteaof
- bgsave(schedule=True, **kwargs)#
Tell the Redis server to save its data to disk. Unlike save(), this method is asynchronous and returns immediately.
For more information see https://redis.io/commands/bgsave
- Parameters
schedule (bool) –
- Return type
Union[Awaitable[Any], Any]
- bitcount(key, start=None, end=None, mode=None)#
Returns the count of set bits in the value of
key
. Optionalstart
andend
parameters indicate which bytes to considerFor more information see https://redis.io/commands/bitcount
- Parameters
key (Union[bytes, str, memoryview]) –
start (Optional[int]) –
end (Optional[int]) –
mode (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- bitfield(key, default_overflow=None)#
Return a BitFieldOperation instance to conveniently construct one or more bitfield operations on
key
.For more information see https://redis.io/commands/bitfield
- Parameters
self (Union[redis.client.Redis, redis.asyncio.client.Redis]) –
key (Union[bytes, str, memoryview]) –
default_overflow (Optional[str]) –
- Return type
BitFieldOperation
- bitfield_ro(key, encoding, offset, items=None)#
Return an array of the specified bitfield values where the first value is found using
encoding
andoffset
parameters and remaining values are result of corresponding encoding/offset pairs in optional listitems
Read-only variant of the BITFIELD command.For more information see https://redis.io/commands/bitfield_ro
- Parameters
self (Union[redis.client.Redis, redis.asyncio.client.Redis]) –
key (Union[bytes, str, memoryview]) –
encoding (str) –
offset (Union[int, str]) –
items (Optional[list]) –
- Return type
Union[Awaitable[Any], Any]
- bitop(operation, dest, *keys)#
Perform a bitwise operation using
operation
betweenkeys
and store the result indest
.For more information see https://redis.io/commands/bitop
- Parameters
operation (str) –
dest (Union[bytes, str, memoryview]) –
keys (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- bitpos(key, bit, start=None, end=None, mode=None)#
Return the position of the first bit set to 1 or 0 in a string.
start
andend
defines 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.For more information see https://redis.io/commands/bitpos
- Parameters
key (Union[bytes, str, memoryview]) –
bit (int) –
start (Optional[int]) –
end (Optional[int]) –
mode (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- blmove(first_list, second_list, timeout, src='LEFT', dest='RIGHT')#
Blocking version of lmove.
For more information see https://redis.io/commands/blmove
- Parameters
first_list (str) –
second_list (str) –
timeout (int) –
src (str) –
dest (str) –
- Return type
Union[Awaitable[Any], Any]
- blmpop(timeout, numkeys, *args, direction, count=1)#
Pop
count
values (default 1) from first non-empty in the list of provided key names.When all lists are empty this command blocks the connection until another client pushes to it or until the timeout, timeout of 0 blocks indefinitely
For more information see https://redis.io/commands/blmpop
- Parameters
timeout (float) –
numkeys (int) –
args (List[str]) –
direction (str) –
count (Optional[int]) –
- Return type
Optional[list]
- 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.
For more information see https://redis.io/commands/blpop
- Parameters
keys (List) –
timeout (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- 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 RPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/brpop
- Parameters
keys (List) –
timeout (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- 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.For more information see https://redis.io/commands/brpoplpush
- Parameters
src (str) –
dst (str) –
timeout (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- bzmpop(timeout, numkeys, keys, min=False, max=False, count=1)#
Pop
count
values (default 1) off of the first non-empty sorted set named in thekeys
list.If none of the sorted sets in
keys
has a value to pop, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzmpop
- Parameters
timeout (float) –
numkeys (int) –
keys (List[str]) –
min (Optional[bool]) –
max (Optional[bool]) –
count (Optional[int]) –
- Return type
Optional[list]
- bzpopmax(keys, timeout=0)#
ZPOPMAX a value off of the first non-empty sorted set named in the
keys
list.If none of the sorted sets in
keys
has a value to ZPOPMAX, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmax
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
timeout (Union[int, float, bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- bzpopmin(keys, timeout=0)#
ZPOPMIN a value off of the first non-empty sorted set named in the
keys
list.If none of the sorted sets in
keys
has a value to ZPOPMIN, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmin
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
timeout (Union[int, float, bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- client_getname(**kwargs)#
Returns the current connection name
For more information see https://redis.io/commands/client-getname
- Return type
Union[Awaitable[Any], Any]
- client_getredir(**kwargs)#
Returns the ID (an integer) of the client to whom we are redirecting tracking notifications.
see: https://redis.io/commands/client-getredir
- Return type
Union[Awaitable[Any], Any]
- client_id(**kwargs)#
Returns the current connection id
For more information see https://redis.io/commands/client-id
- Return type
Union[Awaitable[Any], Any]
- client_info(**kwargs)#
Returns information and statistics about the current client connection.
For more information see https://redis.io/commands/client-info
- Return type
Union[Awaitable[Any], Any]
- client_kill(address, **kwargs)#
Disconnects the client at
address
(ip:port)For more information see https://redis.io/commands/client-kill
- Parameters
address (str) –
- Return type
Union[Awaitable[Any], Any]
- client_kill_filter(_id=None, _type=None, addr=None, skipme=None, laddr=None, user=None, maxage=None, **kwargs)#
Disconnects client(s) using a variety of filter options :param _id: Kills a client by its unique ID field :param _type: Kills a client by type where type is one of ‘normal’, ‘master’, ‘slave’ or ‘pubsub’ :param addr: Kills a client by its ‘address:port’ :param skipme: If True, then the client calling the command will not get killed even if it is identified by one of the filter options. If skipme is not provided, the server defaults to skipme=True :param laddr: Kills a client by its ‘local (bind) address:port’ :param user: Kills a client for a specific user name :param maxage: Kills clients that are older than the specified age in seconds
- Parameters
_id (Optional[str]) –
_type (Optional[str]) –
addr (Optional[str]) –
skipme (Optional[bool]) –
laddr (Optional[bool]) –
user (Optional[str]) –
maxage (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- client_list(_type=None, client_id=[], **kwargs)#
Returns a list of currently connected clients. If type of client specified, only that type will be returned.
- Parameters
_type (Optional[str]) – optional. one of the client types (normal, master, replica, pubsub)
client_id (List[Union[bytes, memoryview, str, int, float]]) – optional. a list of client ids
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/client-list
- client_no_evict(mode)#
Sets the client eviction mode for the current connection.
For more information see https://redis.io/commands/client-no-evict
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- client_no_touch(mode)#
# The command controls whether commands sent by the client will alter # the LRU/LFU of the keys they access. # When turned on, the current client will not change LFU/LRU stats, # unless it sends the TOUCH command.
For more information see https://redis.io/commands/client-no-touch
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- client_pause(timeout, all=True, **kwargs)#
Suspend all the Redis clients for the specified amount of time.
For more information see https://redis.io/commands/client-pause
- Parameters
timeout (int) – milliseconds to pause clients
all (bool) – If true (default) all client commands are blocked. otherwise, clients are only blocked if they attempt to execute a write command.
- Return type
Union[Awaitable[Any], Any]
For the WRITE mode, some commands have special behavior:
EVAL/EVALSHA: Will block client for all scripts.
PUBLISH: Will block client.
PFCOUNT: Will block client.
- WAIT: Acknowledgments will be delayed, so this command will
appear blocked.
- client_reply(reply, **kwargs)#
Enable and disable redis server replies.
reply
Must be ON OFF or SKIP, ON - The default most with server replies to commands OFF - Disable server responses to commands SKIP - Skip the response of the immediately following command.Note: When setting OFF or SKIP replies, you will need a client object with a timeout specified in seconds, and will need to catch the TimeoutError. The test_client_reply unit test illustrates this, and conftest.py has a client with a timeout.
See https://redis.io/commands/client-reply
- Parameters
reply (Union[Literal['ON'], ~typing.Literal['OFF'], ~typing.Literal['SKIP']]) –
- Return type
Union[Awaitable[Any], Any]
- client_setinfo(attr, value, **kwargs)#
Sets the current connection library name or version For mor information see https://redis.io/commands/client-setinfo
- Parameters
attr (str) –
value (str) –
- Return type
Union[Awaitable[Any], Any]
- client_setname(name, **kwargs)#
Sets the current connection name
For more information see https://redis.io/commands/client-setname
Note
This method sets client name only for current connection.
If you want to set a common name for all connections managed by this client, use
client_name
constructor argument.- Parameters
name (str) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking(on=True, clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False, **kwargs)#
Enables the tracking feature of the Redis server, that is used for server assisted client side caching.
on
indicate for tracking on or tracking off. The dafualt is on.clientid
send invalidation messages to the connection with the specified ID.bcast
enable tracking in broadcasting mode. In this mode invalidation messages are reported for all the prefixes specified, regardless of the keys requested by the connection.optin
when broadcasting is NOT active, normally don’t track keys in read only commands, unless they are called immediately after a CLIENT CACHING yes command.optout
when broadcasting is NOT active, normally track keys in read only commands, unless they are called immediately after a CLIENT CACHING no command.noloop
don’t send notifications about keys modified by this connection itself.prefix
for broadcasting, register a given key prefix, so that notifications will be provided only for keys starting with this string.See https://redis.io/commands/client-tracking
- Parameters
on (bool) –
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking_off(clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False)#
Turn off the tracking mode. For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
- Parameters
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking_on(clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False)#
Turn on the tracking mode. For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
- Parameters
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_trackinginfo(**kwargs)#
Returns the information about the current client connection’s use of the server assisted client side cache.
See https://redis.io/commands/client-trackinginfo
- Return type
Union[Awaitable[Any], Any]
- client_unblock(client_id, error=False, **kwargs)#
Unblocks a connection by its client id. If
error
is True, unblocks the client with a special error message. Iferror
is False (default), the client is unblocked using the regular timeout mechanism.For more information see https://redis.io/commands/client-unblock
- Parameters
client_id (int) –
error (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_unpause(**kwargs)#
Unpause all redis clients
For more information see https://redis.io/commands/client-unpause
- Return type
Union[Awaitable[Any], Any]
- command(**kwargs)#
Returns dict reply of details about all Redis commands.
For more information see https://redis.io/commands/command
- command_docs(*args)#
This function throws a NotImplementedError since it is intentionally not supported.
- command_getkeysandflags(*args)#
Returns array of keys from a full Redis command and their usage flags.
For more information see https://redis.io/commands/command-getkeysandflags
- Parameters
args (List[str]) –
- Return type
List[Union[str, List[str]]]
- command_list(module=None, category=None, pattern=None)#
Return an array of the server’s command names. You can use one of the following filters:
module
: get the commands that belong to the modulecategory
: get the commands in the ACL categorypattern
: get the commands that match the given patternFor more information see https://redis.io/commands/command-list/
- Parameters
module (Optional[str]) –
category (Optional[str]) –
pattern (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- config_get(pattern='*', *args, **kwargs)#
Return a dictionary of configuration based on the
pattern
For more information see https://redis.io/commands/config-get
- Parameters
pattern (Union[bytes, str, memoryview]) –
args (List[Union[bytes, str, memoryview]]) –
- Return type
Union[Awaitable[Any], Any]
- config_resetstat(**kwargs)#
Reset runtime statistics
For more information see https://redis.io/commands/config-resetstat
- Return type
Union[Awaitable[Any], Any]
- config_rewrite(**kwargs)#
Rewrite config file with the minimal change to reflect running config.
For more information see https://redis.io/commands/config-rewrite
- Return type
Union[Awaitable[Any], Any]
- config_set(name, value, *args, **kwargs)#
Set config item
name
withvalue
For more information see https://redis.io/commands/config-set
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
args (List[Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- copy(source, destination, destination_db=None, replace=False)#
Copy the value stored in the
source
key to thedestination
key.destination_db
an alternative destination database. By default, thedestination
key is created in the source Redis database.replace
whether thedestination
key should be removed before copying the value to it. By default, the value is not copied if thedestination
key already exists.For more information see https://redis.io/commands/copy
- Parameters
source (str) –
destination (str) –
destination_db (Optional[str]) –
replace (bool) –
- Return type
Union[Awaitable[Any], Any]
- dbsize(**kwargs)#
Returns the number of keys in the current database
For more information see https://redis.io/commands/dbsize
- Return type
Union[Awaitable[Any], Any]
- debug_object(key, **kwargs)#
Returns version specific meta information about a given key
For more information see https://redis.io/commands/debug-object
- Parameters
key (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- decr(name, amount=1)#
Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
For more information see https://redis.io/commands/decrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- decrby(name, amount=1)#
Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
For more information see https://redis.io/commands/decrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- delete(*names)#
Delete one or more keys specified by
names
- Parameters
names (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- 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.
For more information see https://redis.io/commands/dump
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- echo(value, **kwargs)#
Echo the string back from the server
For more information see https://redis.io/commands/echo
- Parameters
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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.For more information see https://redis.io/commands/eval
- Parameters
script (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- eval_ro(script, numkeys, *keys_and_args)#
The read-only variant of the EVAL command
Execute the read-only Lua
script
specifying thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.For more information see https://redis.io/commands/eval_ro
- Parameters
script (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- 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.For more information see https://redis.io/commands/evalsha
- Parameters
sha (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- evalsha_ro(sha, numkeys, *keys_and_args)#
The read-only variant of the EVALSHA command
Use the
sha
to execute a read-only 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.For more information see https://redis.io/commands/evalsha_ro
- Parameters
sha (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- exists(*names)#
Returns the number of
names
that existFor more information see https://redis.io/commands/exists
- Parameters
names (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- expire(name, time, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
fortime
seconds with givenoption
.time
can be represented by an integer or a Python timedelta object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expire
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- expireat(name, when, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
with givenoption
.when
can be represented as an integer indicating unix time or a Python datetime object.- Valid options are:
-> NX – Set expiry only when the key has no expiry -> XX – Set expiry only when the key has an existing expiry -> GT – Set expiry only when the new expiry is greater than current one -> LT – Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expireat
- Parameters
name (Union[bytes, str, memoryview]) –
when (Union[int, datetime]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- expiretime(key)#
Returns the absolute Unix timestamp (since January 1, 1970) in seconds at which the given key will expire.
For more information see https://redis.io/commands/expiretime
- Parameters
key (str) –
- Return type
int
- failover()#
This function throws a NotImplementedError since it is intentionally not supported.
- fcall(function, numkeys, *keys_and_args)#
Invoke a function.
For more information see https://redis.io/commands/fcall
- Parameters
numkeys (int) –
keys_and_args (Optional[List]) –
- Return type
Union[Awaitable[str], str]
- fcall_ro(function, numkeys, *keys_and_args)#
This is a read-only variant of the FCALL command that cannot execute commands that modify data.
For more information see https://redis.io/commands/fcal_ro
- Parameters
numkeys (int) –
keys_and_args (Optional[List]) –
- Return type
Union[Awaitable[str], str]
- flushall(asynchronous=False, **kwargs)#
Delete all keys in all databases on the current host.
asynchronous
indicates whether the operation is executed asynchronously by the server.For more information see https://redis.io/commands/flushall
- Parameters
asynchronous (bool) –
- Return type
Union[Awaitable[Any], Any]
- flushdb(asynchronous=False, **kwargs)#
Delete all keys in the current database.
asynchronous
indicates whether the operation is executed asynchronously by the server.For more information see https://redis.io/commands/flushdb
- Parameters
asynchronous (bool) –
- Return type
Union[Awaitable[Any], Any]
- function_delete(library)#
Delete the library called
library
and all its functions.For more information see https://redis.io/commands/function-delete
- Parameters
library (str) –
- Return type
Union[Awaitable[str], str]
- function_dump()#
Return the serialized payload of loaded libraries.
For more information see https://redis.io/commands/function-dump
- Return type
Union[Awaitable[str], str]
- function_flush(mode='SYNC')#
Deletes all the libraries.
For more information see https://redis.io/commands/function-flush
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- function_kill()#
Kill a function that is currently executing.
For more information see https://redis.io/commands/function-kill
- Return type
Union[Awaitable[str], str]
- function_list(library='*', withcode=False)#
Return information about the functions and libraries.
- Parameters
library (Optional[str]) – specify a pattern for matching library names
withcode (Optional[bool]) – cause the server to include the libraries source implementation in the reply
- Return type
Union[Awaitable[List], List]
- function_load(code, replace=False)#
Load a library to Redis. :param code: the source code (must start with Shebang statement that provides a metadata about the library) :param replace: changes the behavior to overwrite the existing library with the new contents. Return the library name that was loaded.
For more information see https://redis.io/commands/function-load
- Parameters
code (str) –
replace (Optional[bool]) –
- Return type
Union[Awaitable[str], str]
- function_restore(payload, policy='APPEND')#
Restore libraries from the serialized
payload
. You can use the optional policy argument to provide a policy for handling existing libraries.For more information see https://redis.io/commands/function-restore
- Parameters
payload (str) –
policy (Optional[str]) –
- Return type
Union[Awaitable[str], str]
- function_stats()#
Return information about the function that’s currently running and information about the available execution engines.
For more information see https://redis.io/commands/function-stats
- Return type
Union[Awaitable[List], List]
- geoadd(name, values, nx=False, xx=False, ch=False)#
Add the specified geospatial items to the specified key identified by the
name
argument. The Geospatial items are given as ordered members of thevalues
argument, each item or place is formed by the triad longitude, latitude and name.Note: You can use ZREM to remove elements.
nx
forces ZADD to only create new elements and not to update scores for elements that already exist.xx
forces ZADD to only update scores of elements that already exist. New elements will not be added.ch
modifies the return value to be the numbers of elements changed. Changed elements include new elements that were added and elements whose scores changed.For more information see https://redis.io/commands/geoadd
- Parameters
name (Union[bytes, str, memoryview]) –
values (Sequence[Union[bytes, memoryview, str, int, float]]) –
nx (bool) –
xx (bool) –
ch (bool) –
- Return type
Union[Awaitable[Any], Any]
- geodist(name, place1, place2, unit=None)#
Return the distance between
place1
andplace2
members of thename
key. The units must be one of the following : m, km mi, ft. By default meters are used.For more information see https://redis.io/commands/geodist
- Parameters
name (Union[bytes, str, memoryview]) –
place1 (Union[bytes, memoryview, str, int, float]) –
place2 (Union[bytes, memoryview, str, int, float]) –
unit (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- geohash(name, *values)#
Return the geo hash string for each item of
values
members of the specified key identified by thename
argument.For more information see https://redis.io/commands/geohash
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- geopos(name, *values)#
Return the positions of each item of
values
as members of the specified key identified by thename
argument. Each position is represented by the pairs lon and lat.For more information see https://redis.io/commands/geopos
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- georadius(name, longitude, latitude, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None, any=False)#
Return the members of the specified key identified by the
name
argument which are within the borders of the area specified with thelatitude
andlongitude
location and the maximum distance from the center specified by theradius
value.The units must be one of the following : m, km mi, ft. By default
withdist
indicates to return the distances of each place.withcoord
indicates to return the latitude and longitude of each place.withhash
indicates to return the geohash string of each place.count
indicates to return the number of elements up to N.sort
indicates to return the places in a sorted way, ASC for nearest to fairest and DESC for fairest to nearest.store
indicates to save the places names in a sorted set named with a specific key, each element of the destination sorted set is populated with the score got from the original geo sorted set.store_dist
indicates to save the places names in a sorted set named with a specific key, instead ofstore
the sorted set destination score is set with the distance.For more information see https://redis.io/commands/georadius
- Parameters
name (Union[bytes, str, memoryview]) –
longitude (float) –
latitude (float) –
radius (float) –
unit (Optional[str]) –
withdist (bool) –
withcoord (bool) –
withhash (bool) –
count (Optional[int]) –
sort (Optional[str]) –
store (Optional[Union[bytes, str, memoryview]]) –
store_dist (Optional[Union[bytes, str, memoryview]]) –
any (bool) –
- Return type
Union[Awaitable[Any], Any]
- georadiusbymember(name, member, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None, any=False)#
This command is exactly like
georadius
with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.For more information see https://redis.io/commands/georadiusbymember
- Parameters
name (Union[bytes, str, memoryview]) –
member (Union[bytes, memoryview, str, int, float]) –
radius (float) –
unit (Optional[str]) –
withdist (bool) –
withcoord (bool) –
withhash (bool) –
count (Optional[int]) –
sort (Optional[str]) –
store (Optional[Union[bytes, str, memoryview]]) –
store_dist (Optional[Union[bytes, str, memoryview]]) –
any (bool) –
- Return type
Union[Awaitable[Any], Any]
- geosearch(name, member=None, longitude=None, latitude=None, unit='m', radius=None, width=None, height=None, sort=None, count=None, any=False, withcoord=False, withdist=False, withhash=False)#
Return the members of specified key identified by the
name
argument, which are within the borders of the area specified by a given shape. This command extends the GEORADIUS command, so in addition to searching within circular areas, it supports searching within rectangular areas.This command should be used in place of the deprecated GEORADIUS and GEORADIUSBYMEMBER commands.
member
Use the position of the given existingmember in the sorted set. Can’t be given with
longitude
andlatitude
.
longitude
andlatitude
Use the position given by this coordinates. Can’t be given withmember
radius
Similar to GEORADIUS, search inside circular area according the given radius. Can’t be given withheight
andwidth
.height
andwidth
Search inside an axis-aligned rectangle, determined by the given height and width. Can’t be given withradius
unit
must be one of the following : m, km, mi, ft. m for meters (the default value), km for kilometers, mi for miles and ft for feet.sort
indicates to return the places in a sorted way, ASC for nearest to furthest and DESC for furthest to nearest.count
limit the results to the first count matching items.any
is set to True, the command will return as soon as enough matches are found. Can’t be provided withoutcount
withdist
indicates to return the distances of each place.withcoord
indicates to return the latitude and longitude of each place.withhash
indicates to return the geohash string of each place.For more information see https://redis.io/commands/geosearch
- Parameters
name (Union[bytes, str, memoryview]) –
member (Optional[Union[bytes, memoryview, str, int, float]]) –
longitude (Optional[float]) –
latitude (Optional[float]) –
unit (str) –
radius (Optional[float]) –
width (Optional[float]) –
height (Optional[float]) –
sort (Optional[str]) –
count (Optional[int]) –
any (bool) –
withcoord (bool) –
withdist (bool) –
withhash (bool) –
- Return type
Union[Awaitable[Any], Any]
- geosearchstore(dest, name, member=None, longitude=None, latitude=None, unit='m', radius=None, width=None, height=None, sort=None, count=None, any=False, storedist=False)#
This command is like GEOSEARCH, but stores the result in
dest
. By default, it stores the results in the destination sorted set with their geospatial information. ifstore_dist
set to True, the command will stores the items in a sorted set populated with their distance from the center of the circle or box, as a floating-point number.For more information see https://redis.io/commands/geosearchstore
- Parameters
dest (Union[bytes, str, memoryview]) –
name (Union[bytes, str, memoryview]) –
member (Optional[Union[bytes, memoryview, str, int, float]]) –
longitude (Optional[float]) –
latitude (Optional[float]) –
unit (str) –
radius (Optional[float]) –
width (Optional[float]) –
height (Optional[float]) –
sort (Optional[str]) –
count (Optional[int]) –
any (bool) –
storedist (bool) –
- Return type
Union[Awaitable[Any], Any]
- get(name)#
Return the value at key
name
, or None if the key doesn’t existFor more information see https://redis.io/commands/get
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- getbit(name, offset)#
Returns an integer indicating the value of
offset
inname
For more information see https://redis.io/commands/getbit
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
- Return type
Union[Awaitable[Any], Any]
- getdel(name)#
Get the value at key
name
and delete the key. This command is similar to GET, except for the fact that it also deletes the key on success (if and only if the key’s value type is a string).For more information see https://redis.io/commands/getdel
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- getex(name, ex=None, px=None, exat=None, pxat=None, persist=False)#
Get the value of key and optionally set its expiration. GETEX is similar to GET, but is a write command with additional options. All time parameters can be given as datetime.timedelta or integers.
ex
sets an expire flag on keyname
forex
seconds.px
sets an expire flag on keyname
forpx
milliseconds.exat
sets an expire flag on keyname
forex
seconds, specified in unix time.pxat
sets an expire flag on keyname
forex
milliseconds, specified in unix time.persist
remove the time to live associated withname
.For more information see https://redis.io/commands/getex
- Parameters
name (Union[bytes, str, memoryview]) –
ex (Optional[Union[int, timedelta]]) –
px (Optional[Union[int, timedelta]]) –
exat (Optional[Union[int, datetime]]) –
pxat (Optional[Union[int, datetime]]) –
persist (bool) –
- Return type
Union[Awaitable[Any], Any]
- getrange(key, start, end)#
Returns the substring of the string value stored at
key
, determined by the offsetsstart
andend
(both are inclusive)For more information see https://redis.io/commands/getrange
- Parameters
key (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
- Return type
Union[Awaitable[Any], Any]
- getset(name, value)#
Sets the value at key
name
tovalue
and returns the old value at keyname
atomically.As per Redis 6.2, GETSET is considered deprecated. Please use SET with GET parameter in new code.
For more information see https://redis.io/commands/getset
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- hdel(name, *keys)#
Delete
keys
from hashname
For more information see https://redis.io/commands/hdel
- Parameters
name (str) –
keys (str) –
- Return type
Union[Awaitable[int], int]
- hello()#
This function throws a NotImplementedError since it is intentionally not supported.
- hexists(name, key)#
Returns a boolean indicating if
key
exists within hashname
For more information see https://redis.io/commands/hexists
- Parameters
name (str) –
key (str) –
- Return type
Union[Awaitable[bool], bool]
- hexpire(name, seconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using relative time in seconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hexpire
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
seconds (Union[int, timedelta]) – Expiration time in seconds, relative. Can be an integer, or a Python timedelta object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hexpireat(name, unix_time_seconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using an absolute Unix timestamp in seconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hexpireat
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
unix_time_seconds (Union[int, datetime]) – Expiration time as Unix timestamp in seconds. Can be an integer or a Python datetime object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiration time.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hexpiretime(key, *fields)#
Returns the expiration times of hash fields as Unix timestamps in seconds.
For more information, see https://redis.io/commands/hexpiretime
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the expiration Unix timestamp in seconds, if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hget(name, key)#
Return the value of
key
within the hashname
For more information see https://redis.io/commands/hget
- Parameters
name (str) –
key (str) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- hgetall(name)#
Return a Python dict of the hash’s name/value pairs
For more information see https://redis.io/commands/hgetall
- Parameters
name (str) –
- Return type
Union[Awaitable[dict], dict]
- hincrby(name, key, amount=1)#
Increment the value of
key
in hashname
byamount
For more information see https://redis.io/commands/hincrby
- Parameters
name (str) –
key (str) –
amount (int) –
- Return type
Union[Awaitable[int], int]
- hincrbyfloat(name, key, amount=1.0)#
Increment the value of
key
in hashname
by floatingamount
For more information see https://redis.io/commands/hincrbyfloat
- Parameters
name (str) –
key (str) –
amount (float) –
- Return type
Union[Awaitable[float], float]
- hkeys(name)#
Return the list of keys within hash
name
For more information see https://redis.io/commands/hkeys
- Parameters
name (str) –
- Return type
Union[Awaitable[List], List]
- hlen(name)#
Return the number of elements in hash
name
For more information see https://redis.io/commands/hlen
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- hmget(name, keys, *args)#
Returns a list of values ordered identically to
keys
For more information see https://redis.io/commands/hmget
- Parameters
name (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[List], List]
- hmset(name, mapping)#
Set key to value within hash
name
for each corresponding key and value from themapping
dict.For more information see https://redis.io/commands/hmset
- Parameters
name (str) –
mapping (dict) –
- Return type
Union[Awaitable[str], str]
- hpersist(name, *fields)#
Removes the expiration time for each specified field in a hash.
For more information, see https://redis.io/commands/hpersist
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
fields (str) – A list of fields within the hash from which to remove the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expiration time.
1 if the expiration time was successfully removed from the field.
- Return type
Returns a list which contains for each field in the request
- hpexpire(name, milliseconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using relative time in milliseconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hpexpire
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
milliseconds (Union[int, timedelta]) – Expiration time in milliseconds, relative. Can be an integer, or a Python timedelta object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hpexpireat(name, unix_time_milliseconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using an absolute Unix timestamp in milliseconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hpexpireat
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
unix_time_milliseconds (Union[int, datetime]) – Expiration time as Unix timestamp in milliseconds. Can be an integer or a Python datetime object.
fields (str) – List of fields within the hash to apply the expiry.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hpexpiretime(key, *fields)#
Returns the expiration times of hash fields as Unix timestamps in milliseconds.
For more information, see https://redis.io/commands/hpexpiretime
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the expiration Unix timestamp in milliseconds, if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hpttl(key, *fields)#
Returns the TTL (Time To Live) in milliseconds for each specified field within a hash key.
For more information, see https://redis.io/commands/hpttl
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the TTL.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the TTL in milliseconds if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hrandfield(key, count=None, withvalues=False)#
Return a random field from the hash value stored at key.
count: if the argument is positive, return an array of distinct fields. If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count. withvalues: The optional WITHVALUES modifier changes the reply so it includes the respective values of the randomly selected hash fields.
For more information see https://redis.io/commands/hrandfield
- Parameters
key (str) –
count (Optional[int]) –
withvalues (bool) –
- Return type
Union[Awaitable[Any], Any]
- hscan(name, cursor=0, match=None, count=None, no_values=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 returnsno_values
indicates to return only the keys, without values.For more information see https://redis.io/commands/hscan
- Parameters
name (Union[bytes, str, memoryview]) –
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
no_values (Optional[bool]) –
- Return type
Union[Awaitable[Any], Any]
- hscan_iter(name, match=None, count=None, no_values=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 returnsno_values
indicates to return only the keys, without values- Parameters
name (str) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
no_values (Optional[bool]) –
- Return type
Iterator
- hset(name, key=None, value=None, mapping=None, items=None)#
Set
key
tovalue
within hashname
,mapping
accepts a dict of key/value pairs that will be added to hashname
.items
accepts a list of key/value pairs that will be added to hashname
. Returns the number of fields that were added.For more information see https://redis.io/commands/hset
- Parameters
name (str) –
key (Optional[str]) –
value (Optional[str]) –
mapping (Optional[dict]) –
items (Optional[list]) –
- Return type
Union[Awaitable[int], int]
- hsetnx(name, key, value)#
Set
key
tovalue
within hashname
ifkey
does not exist. Returns 1 if HSETNX created a field, otherwise 0.For more information see https://redis.io/commands/hsetnx
- Parameters
name (str) –
key (str) –
value (str) –
- Return type
Union[Awaitable[bool], bool]
- hstrlen(name, key)#
Return the number of bytes stored in the value of
key
within hashname
For more information see https://redis.io/commands/hstrlen
- Parameters
name (str) –
key (str) –
- Return type
Union[Awaitable[int], int]
- httl(key, *fields)#
Returns the TTL (Time To Live) in seconds for each specified field within a hash key.
For more information, see https://redis.io/commands/httl
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the TTL.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the TTL in seconds if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hvals(name)#
Return the list of values within hash
name
For more information see https://redis.io/commands/hvals
- Parameters
name (str) –
- Return type
Union[Awaitable[List], List]
- incr(name, amount=1)#
Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- incrby(name, amount=1)#
Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- incrbyfloat(name, amount=1.0)#
Increments the value at key
name
by floatingamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrbyfloat
- Parameters
name (Union[bytes, str, memoryview]) –
amount (float) –
- Return type
Union[Awaitable[Any], Any]
- info(section=None, *args, **kwargs)#
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
For more information see https://redis.io/commands/info
- Parameters
section (Optional[str]) –
args (List[str]) –
- Return type
Union[Awaitable[Any], Any]
- keys(pattern='*', **kwargs)#
Returns a list of keys matching
pattern
For more information see https://redis.io/commands/keys
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- lastsave(**kwargs)#
Return a Python datetime object representing the last time the Redis database was saved to disk
For more information see https://redis.io/commands/lastsave
- Return type
Union[Awaitable[Any], Any]
- latency_doctor()#
Raise a NotImplementedError, as the client will not support LATENCY DOCTOR. This funcion is best used within the redis-cli.
For more information see https://redis.io/commands/latency-doctor
- latency_graph()#
Raise a NotImplementedError, as the client will not support LATENCY GRAPH. This funcion is best used within the redis-cli.
For more information see https://redis.io/commands/latency-graph.
- latency_histogram(*args)#
This function throws a NotImplementedError since it is intentionally not supported.
- latency_history(event)#
Returns the raw data of the
event
’s latency spikes time series.For more information see https://redis.io/commands/latency-history
- Parameters
event (str) –
- Return type
Union[Awaitable[Any], Any]
- latency_latest()#
Reports the latest latency events logged.
For more information see https://redis.io/commands/latency-latest
- Return type
Union[Awaitable[Any], Any]
- latency_reset(*events)#
Resets the latency spikes time series of all, or only some, events.
For more information see https://redis.io/commands/latency-reset
- Parameters
events (str) –
- Return type
Union[Awaitable[Any], Any]
- lcs(key1, key2, len=False, idx=False, minmatchlen=0, withmatchlen=False)#
Find the longest common subsequence between
key1
andkey2
. Iflen
is true the length of the match will will be returned. Ifidx
is true the match position in each strings will be returned.minmatchlen
restrict the list of matches to the ones of the givenminmatchlen
. Ifwithmatchlen
the length of the match also will be returned. For more information see https://redis.io/commands/lcs- Parameters
key1 (str) –
key2 (str) –
len (Optional[bool]) –
idx (Optional[bool]) –
minmatchlen (Optional[int]) –
withmatchlen (Optional[bool]) –
- Return type
Union[str, int, list]
- 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
For more information see https://redis.io/commands/lindex
- Parameters
name (str) –
index (int) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- 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.For more information see https://redis.io/commands/linsert
- Parameters
name (str) –
where (str) –
refvalue (str) –
value (str) –
- Return type
Union[Awaitable[int], int]
- llen(name)#
Return the length of the list
name
For more information see https://redis.io/commands/llen
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- lmove(first_list, second_list, src='LEFT', dest='RIGHT')#
Atomically returns and removes the first/last element of a list, pushing it as the first/last element on the destination list. Returns the element being popped and pushed.
For more information see https://redis.io/commands/lmove
- Parameters
first_list (str) –
second_list (str) –
src (str) –
dest (str) –
- Return type
Union[Awaitable[Any], Any]
- lmpop(num_keys, *args, direction, count=1)#
Pop
count
values (default 1) first non-empty list key from the list of args provided key names.For more information see https://redis.io/commands/lmpop
- Parameters
num_keys (int) –
args (List[str]) –
direction (str) –
count (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- lolwut(*version_numbers, **kwargs)#
Get the Redis version and a piece of generative computer art
See: https://redis.io/commands/lolwut
- Parameters
version_numbers (Union[str, float]) –
- Return type
Union[Awaitable[Any], Any]
- lpop(name, count=None)#
Removes and returns the first elements of the list
name
.By default, the command pops a single element from the beginning of the list. When provided with the optional
count
argument, the reply will consist of up to count elements, depending on the list’s length.For more information see https://redis.io/commands/lpop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[Union[str, List]]], str, List]]
- lpos(name, value, rank=None, count=None, maxlen=None)#
Get position of
value
within the listname
If specified,
rank
indicates the “rank” of the first element to return in case there are multiple copies ofvalue
in the list. By default, LPOS returns the position of the first occurrence ofvalue
in the list. Whenrank
2, LPOS returns the position of the secondvalue
in the list. Ifrank
is negative, LPOS searches the list in reverse. For example, -1 would return the position of the last occurrence ofvalue
and -2 would return the position of the next to last occurrence ofvalue
.If specified,
count
indicates that LPOS should return a list of up tocount
positions. Acount
of 2 would return a list of up to 2 positions. Acount
of 0 returns a list of all positions matchingvalue
. Whencount
is specified and butvalue
does not exist in the list, an empty list is returned.If specified,
maxlen
indicates the maximum number of list elements to scan. Amaxlen
of 1000 will only return the position(s) of items within the first 1000 entries in the list. Amaxlen
of 0 (the default) will scan the entire list.For more information see https://redis.io/commands/lpos
- Parameters
name (str) –
value (str) –
rank (Optional[int]) –
count (Optional[int]) –
maxlen (Optional[int]) –
- Return type
Optional[Union[str, List]]
- lpush(name, *values)#
Push
values
onto the head of the listname
For more information see https://redis.io/commands/lpush
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- lpushx(name, *values)#
Push
value
onto the head of the listname
ifname
existsFor more information see https://redis.io/commands/lpushx
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- lrange(name, start, end)#
Return a slice of the list
name
between positionstart
andend
start
andend
can be negative numbers just like Python slicing notationFor more information see https://redis.io/commands/lrange
- Parameters
name (str) –
start (int) –
end (int) –
- Return type
Union[Awaitable[list], list]
- lrem(name, count, value)#
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.
For more information see https://redis.io/commands/lrem
- Parameters
name (str) –
count (int) –
value (str) –
- Return type
Union[Awaitable[int], int]
- lset(name, index, value)#
Set element at
index
of listname
tovalue
For more information see https://redis.io/commands/lset
- Parameters
name (str) –
index (int) –
value (str) –
- Return type
Union[Awaitable[str], str]
- 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 notationFor more information see https://redis.io/commands/ltrim
- Parameters
name (str) –
start (int) –
end (int) –
- Return type
Union[Awaitable[str], str]
- memory_malloc_stats(**kwargs)#
Return an internal statistics report from the memory allocator.
See: https://redis.io/commands/memory-malloc-stats
- Return type
Union[Awaitable[Any], Any]
- memory_purge(**kwargs)#
Attempts to purge dirty pages for reclamation by allocator
For more information see https://redis.io/commands/memory-purge
- Return type
Union[Awaitable[Any], Any]
- memory_stats(**kwargs)#
Return a dictionary of memory stats
For more information see https://redis.io/commands/memory-stats
- Return type
Union[Awaitable[Any], Any]
- memory_usage(key, samples=None, **kwargs)#
Return the total memory usage for key, its value and associated administrative overheads.
For nested data structures,
samples
is the number of elements to sample. If left unspecified, the server’s default is 5. Use 0 to sample all elements.For more information see https://redis.io/commands/memory-usage
- Parameters
key (Union[bytes, str, memoryview]) –
samples (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- mget(keys, *args)#
Returns a list of values ordered identically to
keys
For more information see https://redis.io/commands/mget
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
args (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- migrate(host, port, keys, destination_db, timeout, copy=False, replace=False, auth=None, **kwargs)#
Migrate 1 or more keys from the current Redis server to a different server specified by the
host
,port
anddestination_db
.The
timeout
, specified in milliseconds, indicates the maximum time the connection between the two servers can be idle before the command is interrupted.If
copy
is True, the specifiedkeys
are NOT deleted from the source server.If
replace
is True, this operation will overwrite the keys on the destination server if they exist.If
auth
is specified, authenticate to the destination server with the password provided.For more information see https://redis.io/commands/migrate
- Parameters
host (str) –
port (int) –
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
destination_db (int) –
timeout (int) –
copy (bool) –
replace (bool) –
auth (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- module_list()#
Returns a list of dictionaries containing the name and version of all loaded modules.
For more information see https://redis.io/commands/module-list
- Return type
Union[Awaitable[Any], Any]
- module_load(path, *args)#
Loads the module from
path
. Passes all*args
to the module, during loading. RaisesModuleError
if a module is not found atpath
.For more information see https://redis.io/commands/module-load
- Return type
Union[Awaitable[Any], Any]
- module_loadex(path, options=None, args=None)#
Loads a module from a dynamic library at runtime with configuration directives.
For more information see https://redis.io/commands/module-loadex
- Parameters
path (str) –
options (Optional[List[str]]) –
args (Optional[List[str]]) –
- Return type
Union[Awaitable[Any], Any]
- module_unload(name)#
Unloads the module
name
. RaisesModuleError
ifname
is not in loaded modules.For more information see https://redis.io/commands/module-unload
- Return type
Union[Awaitable[Any], Any]
- move(name, db)#
Moves the key
name
to a different Redis databasedb
For more information see https://redis.io/commands/move
- Parameters
name (Union[bytes, str, memoryview]) –
db (int) –
- Return type
Union[Awaitable[Any], Any]
- mset(mapping)#
Sets key/values based on a mapping. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str().
For more information see https://redis.io/commands/mset
- Parameters
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- msetnx(mapping)#
Sets key/values based on a mapping if none of the keys are already set. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str(). Returns a boolean indicating if the operation was successful.
For more information see https://redis.io/commands/msetnx
- Parameters
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- object(infotype, key, **kwargs)#
Return the encoding, idletime, or refcount about the key
- Parameters
infotype (str) –
key (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- persist(name)#
Removes an expiration on
name
For more information see https://redis.io/commands/persist
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pexpire(name, time, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
fortime
milliseconds with givenoption
.time
can be represented by an integer or a Python timedelta object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpire
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- pexpireat(name, when, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
with givenoption
.when
can be represented as an integer representing unix time in milliseconds (unix time * 1000) or a Python datetime object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpireat
- Parameters
name (Union[bytes, str, memoryview]) –
when (Union[int, datetime]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- pexpiretime(key)#
Returns the absolute Unix timestamp (since January 1, 1970) in milliseconds at which the given key will expire.
For more information see https://redis.io/commands/pexpiretime
- Parameters
key (str) –
- Return type
int
- pfadd(name, *values)#
Adds the specified elements to the specified HyperLogLog.
For more information see https://redis.io/commands/pfadd
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- pfcount(*sources)#
Return the approximated cardinality of the set observed by the HyperLogLog at key(s).
For more information see https://redis.io/commands/pfcount
- Parameters
sources (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pfmerge(dest, *sources)#
Merge N different HyperLogLogs into a single one.
For more information see https://redis.io/commands/pfmerge
- Parameters
dest (Union[bytes, str, memoryview]) –
sources (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- ping(**kwargs)#
Ping the Redis server
For more information see https://redis.io/commands/ping
- Return type
Union[Awaitable[Any], Any]
- 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 objectFor more information see https://redis.io/commands/psetex
- Parameters
name (Union[bytes, str, memoryview]) –
time_ms (Union[int, timedelta]) –
value (Union[bytes, memoryview, str, int, float]) –
- psync(replicationid, offset)#
Initiates a replication stream from the master. Newer version for sync.
For more information see https://redis.io/commands/sync
- Parameters
replicationid (str) –
offset (int) –
- pttl(name)#
Returns the number of milliseconds until the key
name
will expireFor more information see https://redis.io/commands/pttl
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- publish(channel, message, **kwargs)#
Publish
message
onchannel
. Returns the number of subscribers the message was delivered to.For more information see https://redis.io/commands/publish
- Parameters
channel (Union[bytes, str, memoryview]) –
message (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_channels(pattern='*', **kwargs)#
Return a list of channels that have at least one subscriber
For more information see https://redis.io/commands/pubsub-channels
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_numpat(**kwargs)#
Returns the number of subscriptions to patterns
For more information see https://redis.io/commands/pubsub-numpat
- Return type
Union[Awaitable[Any], Any]
- pubsub_numsub(*args, **kwargs)#
Return a list of (channel, number of subscribers) tuples for each channel given in
*args
For more information see https://redis.io/commands/pubsub-numsub
- Parameters
args (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_shardchannels(pattern='*', **kwargs)#
Return a list of shard_channels that have at least one subscriber
For more information see https://redis.io/commands/pubsub-shardchannels
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_shardnumsub(*args, **kwargs)#
Return a list of (shard_channel, number of subscribers) tuples for each channel given in
*args
For more information see https://redis.io/commands/pubsub-shardnumsub
- Parameters
args (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- quit(**kwargs)#
Ask the server to close the connection.
For more information see https://redis.io/commands/quit
- Return type
Union[Awaitable[Any], Any]
- randomkey(**kwargs)#
Returns the name of a random key
For more information see https://redis.io/commands/randomkey
- Return type
Union[Awaitable[Any], Any]
- readonly(**kwargs)#
Enables read queries for a connection to a Redis Cluster replica node.
For more information see https://redis.io/commands/readonly
- Return type
Union[Awaitable[Any], Any]
- readwrite(**kwargs)#
Disables read queries for a connection to a Redis Cluster slave node.
For more information see https://redis.io/commands/readwrite
- Return type
Union[Awaitable[Any], Any]
- 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.- Parameters
self (redis.client.Redis) –
script (Union[bytes, str, memoryview]) –
- Return type
Script
- rename(src, dst)#
Rename key
src
todst
For more information see https://redis.io/commands/rename
- Parameters
src (Union[bytes, str, memoryview]) –
dst (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- renamenx(src, dst)#
Rename key
src
todst
ifdst
doesn’t already existFor more information see https://redis.io/commands/renamenx
- Parameters
src (Union[bytes, str, memoryview]) –
dst (Union[bytes, str, memoryview]) –
- replicaof(*args, **kwargs)#
Update the replication settings of a redis replica, on the fly.
Examples of valid arguments include:
NO ONE (set no replication) host port (set to the host and port of a redis server)
For more information see https://redis.io/commands/replicaof
- Return type
Union[Awaitable[Any], Any]
- reset()#
Perform a full reset on the connection’s server side contenxt.
See: https://redis.io/commands/reset
- Return type
Union[Awaitable[Any], Any]
- restore(name, ttl, value, replace=False, absttl=False, idletime=None, frequency=None)#
Create a key using the provided serialized value, previously obtained using DUMP.
replace
allows an existing key onname
to be overridden. If it’s not specified an error is raised on collision.absttl
if True, specifiedttl
should represent an absolute Unix timestamp in milliseconds in which the key will expire. (Redis 5.0 or greater).idletime
Used for eviction, this is the number of seconds the key must be idle, prior to execution.frequency
Used for eviction, this is the frequency counter of the object stored at the key, prior to execution.For more information see https://redis.io/commands/restore
- Parameters
name (Union[bytes, str, memoryview]) –
ttl (float) –
value (Union[bytes, memoryview, str, int, float]) –
replace (bool) –
absttl (bool) –
idletime (Optional[int]) –
frequency (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- role()#
Provide information on the role of a Redis instance in the context of replication, by returning if the instance is currently a master, slave, or sentinel.
For more information see https://redis.io/commands/role
- Return type
Union[Awaitable[Any], Any]
- rpop(name, count=None)#
Removes and returns the last elements of the list
name
.By default, the command pops a single element from the end of the list. When provided with the optional
count
argument, the reply will consist of up to count elements, depending on the list’s length.For more information see https://redis.io/commands/rpop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[Union[str, List]]], str, List]]
- rpoplpush(src, dst)#
RPOP a value off of the
src
list and atomically LPUSH it on to thedst
list. Returns the value.For more information see https://redis.io/commands/rpoplpush
- Parameters
src (str) –
dst (str) –
- Return type
Union[Awaitable[str], str]
- rpush(name, *values)#
Push
values
onto the tail of the listname
For more information see https://redis.io/commands/rpush
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- rpushx(name, *values)#
Push
value
onto the tail of the listname
ifname
existsFor more information see https://redis.io/commands/rpushx
- Parameters
name (str) –
values (str) –
- Return type
Union[Awaitable[int], int]
- sadd(name, *values)#
Add
value(s)
to setname
For more information see https://redis.io/commands/sadd
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- save(**kwargs)#
Tell the Redis server to save its data to disk, blocking until the save is complete
For more information see https://redis.io/commands/save
- Return type
Union[Awaitable[Any], Any]
- scan(cursor=0, match=None, count=None, _type=None, **kwargs)#
Incrementally return lists of key names. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
provides a hint to Redis about the number of keys toreturn per batch.
_type
filters the returned values by a particular Redis type.Stock Redis instances allow for the following types: HASH, LIST, SET, STREAM, STRING, ZSET Additionally, Redis modules can expose other types as well.
For more information see https://redis.io/commands/scan
- Parameters
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
_type (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- scan_iter(match=None, count=None, _type=None, **kwargs)#
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
provides a hint to Redis about the number of keys toreturn per batch.
_type
filters the returned values by a particular Redis type.Stock Redis instances allow for the following types: HASH, LIST, SET, STREAM, STRING, ZSET Additionally, Redis modules can expose other types as well.
- Parameters
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
_type (Optional[str]) –
- Return type
Iterator
- scard(name)#
Return the number of elements in set
name
For more information see https://redis.io/commands/scard
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- 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_data.For more information see https://redis.io/commands/script-exists
- Parameters
args (str) –
- Return type
Union[Awaitable[Any], Any]
- script_flush(sync_type=None)#
Flush all scripts from the script cache_data.
sync_type
is by default SYNC (synchronous) but it can also beASYNC.
For more information see https://redis.io/commands/script-flush
- Parameters
sync_type (Optional[Union[Literal['SYNC'], ~typing.Literal['ASYNC']]]) –
- Return type
Union[Awaitable[Any], Any]
- script_kill()#
Kill the currently executing Lua script
For more information see https://redis.io/commands/script-kill
- Return type
Union[Awaitable[Any], Any]
- script_load(script)#
Load a Lua
script
into the script cache_data. Returns the SHA.For more information see https://redis.io/commands/script-load
- Parameters
script (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- sdiff(keys, *args)#
Return the difference of sets specified by
keys
For more information see https://redis.io/commands/sdiff
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[list], list]
- 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.For more information see https://redis.io/commands/sdiffstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- select(index, **kwargs)#
Select the Redis logical database at index.
See: https://redis.io/commands/select
- Parameters
index (int) –
- Return type
Union[Awaitable[Any], Any]
- set(name, value, ex=None, px=None, nx=False, xx=False, keepttl=False, get=False, exat=None, pxat=None)#
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
onlyif it does not exist.
xx
if set to True, set the value at keyname
tovalue
onlyif it already exists.
keepttl
if True, retain the time to live associated with the key.(Available since Redis 6.0)
get
if True, set the value at keyname
tovalue
and returnthe old value stored at key, or None if the key did not exist. (Available since Redis 6.2)
exat
sets an expire flag on keyname
forex
seconds,specified in unix time.
pxat
sets an expire flag on keyname
forex
milliseconds,specified in unix time.
For more information see https://redis.io/commands/set
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
ex (Optional[Union[int, timedelta]]) –
px (Optional[Union[int, timedelta]]) –
nx (bool) –
xx (bool) –
keepttl (bool) –
get (bool) –
exat (Optional[Union[int, datetime]]) –
pxat (Optional[Union[int, datetime]]) –
- Return type
Union[Awaitable[Any], Any]
- setbit(name, offset, value)#
Flag the
offset
inname
asvalue
. Returns an integer indicating the previous value ofoffset
.For more information see https://redis.io/commands/setbit
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
value (int) –
- Return type
Union[Awaitable[Any], Any]
- setex(name, time, value)#
Set the value of key
name
tovalue
that expires intime
seconds.time
can be represented by an integer or a Python timedelta object.For more information see https://redis.io/commands/setex
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- setnx(name, value)#
Set the value of key
name
tovalue
if key doesn’t existFor more information see https://redis.io/commands/setnx
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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.
For more information see https://redis.io/commands/setrange
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- shutdown(save=False, nosave=False, now=False, force=False, abort=False, **kwargs)#
Shutdown the Redis server. If Redis has persistence configured, data will be flushed before shutdown. It is possible to specify modifiers to alter the behavior of the command:
save
will force a DB saving operation even if no save points are configured.nosave
will prevent a DB saving operation even if one or more save points are configured.now
skips waiting for lagging replicas, i.e. it bypasses the first step in the shutdown sequence.force
ignores any errors that would normally prevent the server from exitingabort
cancels an ongoing shutdown and cannot be combined with other flags.For more information see https://redis.io/commands/shutdown
- Parameters
save (bool) –
nosave (bool) –
now (bool) –
force (bool) –
abort (bool) –
- Return type
None
- sinter(keys, *args)#
Return the intersection of sets specified by
keys
For more information see https://redis.io/commands/sinter
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[list], list]
- sintercard(numkeys, keys, limit=0)#
Return the cardinality of the intersect of multiple sets specified by
keys
.When LIMIT provided (defaults to 0 and means unlimited), if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality
For more information see https://redis.io/commands/sintercard
- Parameters
numkeys (int) –
keys (List[str]) –
limit (int) –
- Return type
Union[Awaitable[int], int]
- 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.For more information see https://redis.io/commands/sinterstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- sismember(name, value)#
Return whether
value
is a member of setname
: - 1 if the value is a member of the set. - 0 if the value is not a member of the set or if key does not exist.For more information see https://redis.io/commands/sismember
- Parameters
name (str) –
value (str) –
- Return type
Union[Awaitable[Union[Literal[0], ~typing.Literal[1]]], ~typing.Literal[0], ~typing.Literal[1]]
- slaveof(host=None, port=None, **kwargs)#
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.For more information see https://redis.io/commands/slaveof
- Parameters
host (Optional[str]) –
port (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- slowlog_get(num=None, **kwargs)#
Get the entries from the slowlog. If
num
is specified, get the most recentnum
items.For more information see https://redis.io/commands/slowlog-get
- Parameters
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- slowlog_len(**kwargs)#
Get the number of items in the slowlog
For more information see https://redis.io/commands/slowlog-len
- Return type
Union[Awaitable[Any], Any]
- slowlog_reset(**kwargs)#
Remove all items in the slowlog
For more information see https://redis.io/commands/slowlog-reset
- Return type
Union[Awaitable[Any], Any]
- smembers(name)#
Return all members of the set
name
For more information see https://redis.io/commands/smembers
- Parameters
name (str) –
- Return type
Union[Awaitable[Set], Set]
- smismember(name, values, *args)#
Return whether each value in
values
is a member of the setname
as a list ofint
in the order ofvalues
: - 1 if the value is a member of the set. - 0 if the value is not a member of the set or if key does not exist.For more information see https://redis.io/commands/smismember
- Parameters
name (str) –
values (List) –
args (List) –
- Return type
Union[Awaitable[List[Union[Literal[0], ~typing.Literal[1]]]], ~typing.List[~typing.Union[~typing.Literal[0], ~typing.Literal[1]]]]
- smove(src, dst, value)#
Move
value
from setsrc
to setdst
atomicallyFor more information see https://redis.io/commands/smove
- Parameters
src (str) –
dst (str) –
value (str) –
- Return type
Union[Awaitable[bool], bool]
- 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 thesorted data itself. Use an “*” to indicate where in the 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 intothe key
store
groups
if set to True and ifget
contains at least twoelements, sort will return a list of tuples, each containing the values fetched from the arguments to
get
.
For more information see https://redis.io/commands/sort
- Parameters
name (str) –
start (Optional[int]) –
num (Optional[int]) –
by (Optional[str]) –
get (Optional[List[str]]) –
desc (bool) –
alpha (bool) –
store (Optional[str]) –
groups (Optional[bool]) –
- Return type
Union[List, int]
- sort_ro(key, start=None, num=None, by=None, get=None, desc=False, alpha=False)#
Returns the elements contained in the list, set or sorted set at key. (read-only variant of the SORT command)
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 thesorted data itself. Use an “*” to indicate where in the key the item value is located
desc
allows for reversing the sortalpha
allows for sorting lexicographically rather than numericallyFor more information see https://redis.io/commands/sort_ro
- Parameters
key (str) –
start (Optional[int]) –
num (Optional[int]) –
by (Optional[str]) –
get (Optional[List[str]]) –
desc (bool) –
alpha (bool) –
- Return type
list
- spop(name, count=None)#
Remove and return a random member of set
name
For more information see https://redis.io/commands/spop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[str, List]]
- spublish(shard_channel, message)#
Posts a message to the given shard channel. Returns the number of clients that received the message
For more information see https://redis.io/commands/spublish
- Parameters
shard_channel (Union[bytes, str, memoryview]) –
message (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- srandmember(name, number=None)#
If
number
is None, returns a random member of setname
.If
number
is supplied, returns a list ofnumber
random members of setname
. Note this is only available when running Redis 2.6+.For more information see https://redis.io/commands/srandmember
- Parameters
name (str) –
number (Optional[int]) –
- Return type
Optional[Union[str, List]]
- srem(name, *values)#
Remove
values
from setname
For more information see https://redis.io/commands/srem
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- 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 returnsFor more information see https://redis.io/commands/sscan
- Parameters
name (Union[bytes, str, memoryview]) –
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- 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- Parameters
name (Union[bytes, str, memoryview]) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
- Return type
Iterator
- stralgo(algo, value1, value2, specific_argument='strings', len=False, idx=False, minmatchlen=None, withmatchlen=False, **kwargs)#
Implements complex algorithms that operate on strings. Right now the only algorithm implemented is the LCS algorithm (longest common substring). However new algorithms could be implemented in the future.
algo
Right now must be LCSvalue1
andvalue2
Can be two strings or two keysspecific_argument
Specifying if the arguments to the algorithm will be keys or strings. strings is the default.len
Returns just the len of the match.idx
Returns the match positions in each string.minmatchlen
Restrict the list of matches to the ones of a given minimal length. Can be provided only whenidx
set to True.withmatchlen
Returns the matches with the len of the match. Can be provided only whenidx
set to True.For more information see https://redis.io/commands/stralgo
- Parameters
algo (Literal['LCS']) –
value1 (Union[bytes, str, memoryview]) –
value2 (Union[bytes, str, memoryview]) –
specific_argument (Union[Literal['strings'], ~typing.Literal['keys']]) –
len (bool) –
idx (bool) –
minmatchlen (Optional[int]) –
withmatchlen (bool) –
- Return type
Union[Awaitable[Any], Any]
- strlen(name)#
Return the number of bytes stored in the value of
name
For more information see https://redis.io/commands/strlen
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- 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.- Parameters
name (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
- Return type
Union[Awaitable[Any], Any]
- sunion(keys, *args)#
Return the union of sets specified by
keys
For more information see https://redis.io/commands/sunion
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[List], List]
- 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.For more information see https://redis.io/commands/sunionstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- swapdb(first, second, **kwargs)#
Swap two databases
For more information see https://redis.io/commands/swapdb
- Parameters
first (int) –
second (int) –
- Return type
Union[Awaitable[Any], Any]
- sync()#
Initiates a replication stream from the master.
For more information see https://redis.io/commands/sync
- Return type
Union[Awaitable[Any], Any]
- tfcall(lib_name, func_name, keys=None, *args)#
Invoke a function.
lib_name
- the library name contains the function.func_name
- the function name to run.keys
- the keys that will be touched by the function.args
- Additional argument to pass to the function.For more information see https://redis.io/commands/tfcall/
- Parameters
lib_name (str) –
func_name (str) –
keys (Optional[Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]]) –
args (List) –
- Return type
Union[Awaitable[Any], Any]
- tfcall_async(lib_name, func_name, keys=None, *args)#
Invoke an async function (coroutine).
lib_name
- the library name contains the function.func_name
- the function name to run.keys
- the keys that will be touched by the function.args
- Additional argument to pass to the function.For more information see https://redis.io/commands/tfcall/
- Parameters
lib_name (str) –
func_name (str) –
keys (Optional[Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]]) –
args (List) –
- Return type
Union[Awaitable[Any], Any]
- tfunction_delete(lib_name)#
Delete a library from RedisGears.
lib_name
the library name to delete.For more information see https://redis.io/commands/tfunction-delete/
- Parameters
lib_name (str) –
- Return type
Union[Awaitable[Any], Any]
- tfunction_list(with_code=False, verbose=0, lib_name=None)#
List the functions with additional information about each function.
with_code
Show libraries code.verbose
output verbosity level, higher number will increase verbosity levellib_name
specifying a library name (can be used multiple times to show multiple libraries in a single command) # noqaFor more information see https://redis.io/commands/tfunction-list/
- Parameters
with_code (bool) –
verbose (int) –
lib_name (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- tfunction_load(lib_code, replace=False, config=None)#
Load a new library to RedisGears.
lib_code
- the library code.config
- a string representation of a JSON object that will be provided to the library on load time, for more information refer to https://github.com/RedisGears/RedisGears/blob/master/docs/function_advance_topics.md#library-configurationreplace
- an optional argument, instructs RedisGears to replace the function if its already existsFor more information see https://redis.io/commands/tfunction-load/
- Parameters
lib_code (str) –
replace (bool) –
config (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- time(**kwargs)#
Returns the server time as a 2-item tuple of ints: (seconds since epoch, microseconds into this second).
For more information see https://redis.io/commands/time
- Return type
Union[Awaitable[Any], Any]
- touch(*args)#
Alters the last access time of a key(s)
*args
. A key is ignored if it does not exist.For more information see https://redis.io/commands/touch
- Parameters
args (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- ttl(name)#
Returns the number of seconds until the key
name
will expireFor more information see https://redis.io/commands/ttl
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- type(name)#
Returns the type of key
name
For more information see https://redis.io/commands/type
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- unlink(*names)#
Unlink one or more keys specified by
names
For more information see https://redis.io/commands/unlink
- Parameters
names (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- unwatch()#
Unwatches the value at key
name
, or None of the key doesn’t existFor more information see https://redis.io/commands/unwatch
- Return type
None
- wait(num_replicas, timeout, **kwargs)#
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.For more information see https://redis.io/commands/wait
- Parameters
num_replicas (int) –
timeout (int) –
- Return type
Union[Awaitable[Any], Any]
- waitaof(num_local, num_replicas, timeout, **kwargs)#
This command blocks the current client until all previous write commands by that client are acknowledged as having been fsynced to the AOF of the local Redis and/or at least the specified number of replicas.
For more information see https://redis.io/commands/waitaof
- Parameters
num_local (int) –
num_replicas (int) –
timeout (int) –
- Return type
Union[Awaitable[Any], Any]
- watch(*names)#
Watches the values at keys
names
, or None if the key doesn’t existFor more information see https://redis.io/commands/watch
- Parameters
names (Union[bytes, str, memoryview]) –
- Return type
None
- xack(name, groupname, *ids)#
Acknowledges the successful processing of one or more messages.
- Parameters
name (Union[bytes, str, memoryview]) – name of the stream.
groupname (Union[bytes, str, memoryview]) – name of the consumer group.
*ids (Union[int, bytes, str, memoryview]) – message ids to acknowledge.
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/xack
- xadd(name, fields, id='*', maxlen=None, approximate=True, nomkstream=False, minid=None, limit=None)#
Add to a stream. name: name of the stream fields: dict of field/value pairs to insert into the stream id: Location to insert this record. By default it is appended. maxlen: truncate old stream members beyond this size. Can’t be specified with minid. approximate: actual stream length may be slightly more than maxlen nomkstream: When set to true, do not make a stream minid: the minimum id in the stream to query. Can’t be specified with maxlen. limit: specifies the maximum number of entries to retrieve
For more information see https://redis.io/commands/xadd
- Parameters
name (Union[bytes, str, memoryview]) –
fields (Dict[Union[bytes, memoryview, str, int, float], Union[bytes, memoryview, str, int, float]]) –
id (Union[int, bytes, str, memoryview]) –
maxlen (Optional[int]) –
approximate (bool) –
nomkstream (bool) –
minid (Optional[Union[int, bytes, str, memoryview]]) –
limit (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xautoclaim(name, groupname, consumername, min_idle_time, start_id='0-0', count=None, justid=False)#
Transfers ownership of pending stream entries that match the specified criteria. Conceptually, equivalent to calling XPENDING and then XCLAIM, but provides a more straightforward way to deal with message delivery failures via SCAN-like semantics. name: name of the stream. groupname: name of the consumer group. consumername: name of a consumer that claims the message. min_idle_time: filter messages that were idle less than this amount of milliseconds. start_id: filter messages with equal or greater ID. count: optional integer, upper limit of the number of entries that the command attempts to claim. Set to 100 by default. justid: optional boolean, false by default. Return just an array of IDs of messages successfully claimed, without returning the actual message
For more information see https://redis.io/commands/xautoclaim
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
consumername (Union[bytes, str, memoryview]) –
min_idle_time (int) –
start_id (Union[int, bytes, str, memoryview]) –
count (Optional[int]) –
justid (bool) –
- Return type
Union[Awaitable[Any], Any]
- xclaim(name, groupname, consumername, min_idle_time, message_ids, idle=None, time=None, retrycount=None, force=False, justid=False)#
Changes the ownership of a pending message.
name: name of the stream.
groupname: name of the consumer group.
consumername: name of a consumer that claims the message.
min_idle_time: filter messages that were idle less than this amount of milliseconds
message_ids: non-empty list or tuple of message IDs to claim
idle: optional. Set the idle time (last time it was delivered) of the message in ms
time: optional integer. This is the same as idle but instead of a relative amount of milliseconds, it sets the idle time to a specific Unix time (in milliseconds).
retrycount: optional integer. set the retry counter to the specified value. This counter is incremented every time a message is delivered again.
force: optional boolean, false by default. Creates the pending message entry in the PEL even if certain specified IDs are not already in the PEL assigned to a different client.
justid: optional boolean, false by default. Return just an array of IDs of messages successfully claimed, without returning the actual message
For more information see https://redis.io/commands/xclaim
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
consumername (Union[bytes, str, memoryview]) –
min_idle_time (int) –
message_ids (Union[List[Union[int, bytes, str, memoryview]], Tuple[Union[int, bytes, str, memoryview]]]) –
idle (Optional[int]) –
time (Optional[int]) –
retrycount (Optional[int]) –
force (bool) –
justid (bool) –
- Return type
Union[Awaitable[Any], Any]
- xdel(name, *ids)#
Deletes one or more messages from a stream.
- Parameters
name (Union[bytes, str, memoryview]) – name of the stream.
*ids (Union[int, bytes, str, memoryview]) – message ids to delete.
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/xdel
- xgroup_create(name, groupname, id='$', mkstream=False, entries_read=None)#
Create a new consumer group associated with a stream. name: name of the stream. groupname: name of the consumer group. id: ID of the last item in the stream to consider already delivered.
For more information see https://redis.io/commands/xgroup-create
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
id (Union[int, bytes, str, memoryview]) –
mkstream (bool) –
entries_read (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xgroup_createconsumer(name, groupname, consumername)#
Consumers in a consumer group are auto-created every time a new consumer name is mentioned by some command. They can be explicitly created by using this command. name: name of the stream. groupname: name of the consumer group. consumername: name of consumer to create.
See: https://redis.io/commands/xgroup-createconsumer
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
consumername (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xgroup_delconsumer(name, groupname, consumername)#
Remove a specific consumer from a consumer group. Returns the number of pending messages that the consumer had before it was deleted. name: name of the stream. groupname: name of the consumer group. consumername: name of consumer to delete
For more information see https://redis.io/commands/xgroup-delconsumer
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
consumername (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xgroup_destroy(name, groupname)#
Destroy a consumer group. name: name of the stream. groupname: name of the consumer group.
For more information see https://redis.io/commands/xgroup-destroy
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xgroup_setid(name, groupname, id, entries_read=None)#
Set the consumer group last delivered ID to something else. name: name of the stream. groupname: name of the consumer group. id: ID of the last item in the stream to consider already delivered.
For more information see https://redis.io/commands/xgroup-setid
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
id (Union[int, bytes, str, memoryview]) –
entries_read (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xinfo_consumers(name, groupname)#
Returns general information about the consumers in the group. name: name of the stream. groupname: name of the consumer group.
For more information see https://redis.io/commands/xinfo-consumers
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xinfo_groups(name)#
Returns general information about the consumer groups of the stream. name: name of the stream.
For more information see https://redis.io/commands/xinfo-groups
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xinfo_stream(name, full=False)#
Returns general information about the stream. name: name of the stream. full: optional boolean, false by default. Return full summary
For more information see https://redis.io/commands/xinfo-stream
- Parameters
name (Union[bytes, str, memoryview]) –
full (bool) –
- Return type
Union[Awaitable[Any], Any]
- xlen(name)#
Returns the number of elements in a given stream.
For more information see https://redis.io/commands/xlen
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xpending(name, groupname)#
Returns information about pending messages of a group. name: name of the stream. groupname: name of the consumer group.
For more information see https://redis.io/commands/xpending
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- xpending_range(name, groupname, min, max, count, consumername=None, idle=None)#
Returns information about pending messages, in a range.
name: name of the stream. groupname: name of the consumer group. idle: available from version 6.2. filter entries by their idle-time, given in milliseconds (optional). min: minimum stream ID. max: maximum stream ID. count: number of messages to return consumername: name of a consumer to filter by (optional).
- Parameters
name (Union[bytes, str, memoryview]) –
groupname (Union[bytes, str, memoryview]) –
min (Union[int, bytes, str, memoryview]) –
max (Union[int, bytes, str, memoryview]) –
count (int) –
consumername (Optional[Union[bytes, str, memoryview]]) –
idle (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xrange(name, min='-', max='+', count=None)#
Read stream values within an interval.
name: name of the stream.
- start: first stream ID. defaults to ‘-‘,
meaning the earliest available.
- finish: last stream ID. defaults to ‘+’,
meaning the latest available.
- count: if set, only return this many items, beginning with the
earliest available.
For more information see https://redis.io/commands/xrange
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[int, bytes, str, memoryview]) –
max (Union[int, bytes, str, memoryview]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xread(streams, count=None, block=None)#
Block and monitor multiple streams for new data.
- streams: a dict of stream names to stream IDs, where
IDs indicate the last ID already seen.
- count: if set, only return this many items, beginning with the
earliest available.
block: number of milliseconds to wait, if nothing already present.
For more information see https://redis.io/commands/xread
- Parameters
streams (Dict[Union[bytes, str, memoryview], Union[int, bytes, str, memoryview]]) –
count (Optional[int]) –
block (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xreadgroup(groupname, consumername, streams, count=None, block=None, noack=False)#
Read from a stream via a consumer group.
groupname: name of the consumer group.
consumername: name of the requesting consumer.
- streams: a dict of stream names to stream IDs, where
IDs indicate the last ID already seen.
- count: if set, only return this many items, beginning with the
earliest available.
block: number of milliseconds to wait, if nothing already present. noack: do not add messages to the PEL
For more information see https://redis.io/commands/xreadgroup
- Parameters
groupname (str) –
consumername (str) –
streams (Dict[Union[bytes, str, memoryview], Union[int, bytes, str, memoryview]]) –
count (Optional[int]) –
block (Optional[int]) –
noack (bool) –
- Return type
Union[Awaitable[Any], Any]
- xrevrange(name, max='+', min='-', count=None)#
Read stream values within an interval, in reverse order.
name: name of the stream
- start: first stream ID. defaults to ‘+’,
meaning the latest available.
- finish: last stream ID. defaults to ‘-‘,
meaning the earliest available.
- count: if set, only return this many items, beginning with the
latest available.
For more information see https://redis.io/commands/xrevrange
- Parameters
name (Union[bytes, str, memoryview]) –
max (Union[int, bytes, str, memoryview]) –
min (Union[int, bytes, str, memoryview]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- xtrim(name, maxlen=None, approximate=True, minid=None, limit=None)#
Trims old messages from a stream. name: name of the stream. maxlen: truncate old stream messages beyond this size Can’t be specified with minid. approximate: actual stream length may be slightly more than maxlen minid: the minimum id in the stream to query Can’t be specified with maxlen. limit: specifies the maximum number of entries to retrieve
For more information see https://redis.io/commands/xtrim
- Parameters
name (Union[bytes, str, memoryview]) –
maxlen (Optional[int]) –
approximate (bool) –
minid (Optional[Union[int, bytes, str, memoryview]]) –
limit (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zadd(name, mapping, nx=False, xx=False, ch=False, incr=False, gt=False, lt=False)#
Set any number of element-name, score pairs to the key
name
. Pairs are specified as a dict of element-names keys to score values.nx
forces ZADD to only create new elements and not to update scores for elements that already exist.xx
forces ZADD to only update scores of elements that already exist. New elements will not be added.ch
modifies the return value to be the numbers of elements changed. Changed elements include new elements that were added and elements whose scores changed.incr
modifies ZADD to behave like ZINCRBY. In this mode only a single element/score pair can be specified and the score is the amount the existing score will be incremented by. When using this mode the return value of ZADD will be the new score of the element.LT
Only update existing elements if the new score is less than the current score. This flag doesn’t prevent adding new elements.GT
Only update existing elements if the new score is greater than the current score. This flag doesn’t prevent adding new elements.The return value of ZADD varies based on the mode specified. With no options, ZADD returns the number of new elements added to the sorted set.
NX
,LT
, andGT
are mutually exclusive options.See: https://redis.io/commands/ZADD
- Parameters
name (Union[bytes, str, memoryview]) –
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
nx (bool) –
xx (bool) –
ch (bool) –
incr (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- zcard(name)#
Return the number of elements in the sorted set
name
For more information see https://redis.io/commands/zcard
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- zcount(name, min, max)#
Returns the number of elements in the sorted set at key
name
with a score betweenmin
andmax
.For more information see https://redis.io/commands/zcount
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[float, str]) –
max (Union[float, str]) –
- Return type
Union[Awaitable[Any], Any]
- zdiff(keys, withscores=False)#
Returns the difference between the first and all successive input sorted sets provided in
keys
.For more information see https://redis.io/commands/zdiff
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
withscores (bool) –
- Return type
Union[Awaitable[Any], Any]
- zdiffstore(dest, keys)#
Computes the difference between the first and all successive input sorted sets provided in
keys
and stores the result indest
.For more information see https://redis.io/commands/zdiffstore
- Parameters
dest (Union[bytes, str, memoryview]) –
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
- Return type
Union[Awaitable[Any], Any]
- zincrby(name, amount, value)#
Increment the score of
value
in sorted setname
byamount
For more information see https://redis.io/commands/zincrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (float) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- zinter(keys, aggregate=None, withscores=False)#
Return the intersect of multiple sorted sets specified by
keys
. With theaggregate
option, it is possible to specify how the results of the union are aggregated. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.For more information see https://redis.io/commands/zinter
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
aggregate (Optional[str]) –
withscores (bool) –
- Return type
Union[Awaitable[Any], Any]
- zintercard(numkeys, keys, limit=0)#
Return the cardinality of the intersect of multiple sorted sets specified by
keys
. When LIMIT provided (defaults to 0 and means unlimited), if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinalityFor more information see https://redis.io/commands/zintercard
- Parameters
numkeys (int) –
keys (List[str]) –
limit (int) –
- Return type
Union[Awaitable[int], int]
- 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
. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.For more information see https://redis.io/commands/zinterstore
- Parameters
dest (Union[bytes, str, memoryview]) –
keys (Union[Sequence[Union[bytes, str, memoryview]], Mapping[AnyKeyT, float]]) –
aggregate (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- zlexcount(name, min, max)#
Return the number of items in the sorted set
name
between the lexicographical rangemin
andmax
.For more information see https://redis.io/commands/zlexcount
- zmpop(num_keys, keys, min=False, max=False, count=1)#
Pop
count
values (default 1) off of the first non-empty sorted set named in thekeys
list. For more information see https://redis.io/commands/zmpop- Parameters
num_keys (int) –
keys (List[str]) –
min (Optional[bool]) –
max (Optional[bool]) –
count (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- zmscore(key, members)#
Returns the scores associated with the specified members in the sorted set stored at key.
members
should be a list of the member name. Return type is a list of score. If the member does not exist, a None will be returned in corresponding position.For more information see https://redis.io/commands/zmscore
- Parameters
key (Union[bytes, str, memoryview]) –
members (List[str]) –
- Return type
Union[Awaitable[Any], Any]
- zpopmax(name, count=None)#
Remove and return up to
count
members with the highest scores from the sorted setname
.For more information see https://redis.io/commands/zpopmax
- Parameters
name (Union[bytes, str, memoryview]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zpopmin(name, count=None)#
Remove and return up to
count
members with the lowest scores from the sorted setname
.For more information see https://redis.io/commands/zpopmin
- Parameters
name (Union[bytes, str, memoryview]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zrandmember(key, count=None, withscores=False)#
Return a random element from the sorted set value stored at key.
count
if the argument is positive, return an array of distinct fields. If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.withscores
The optional WITHSCORES modifier changes the reply so it includes the respective scores of the randomly selected elements from the sorted set.For more information see https://redis.io/commands/zrandmember
- Parameters
key (Union[bytes, str, memoryview]) –
count (Optional[int]) –
withscores (bool) –
- Return type
Union[Awaitable[Any], Any]
- zrange(name, start, end, desc=False, withscores=False, score_cast_func=<class 'float'>, byscore=False, bylex=False, offset=None, num=None)#
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 in reversed order.withscores
indicates to return the scores along with the values. The return type is a list of (value, score) pairs.score_cast_func
a callable used to cast the score return value.byscore
when set to True, returns the range of elements from the sorted set having scores equal or betweenstart
andend
.bylex
when set to True, returns the range of elements from the sorted set between thestart
andend
lexicographical closed range intervals. Validstart
andend
must start with ( or [, in order to specify whether the range interval is exclusive or inclusive, respectively.offset
andnum
are specified, then return a slice of the range. Can’t be provided when usingbylex
.For more information see https://redis.io/commands/zrange
- Parameters
name (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
desc (bool) –
withscores (bool) –
score_cast_func (Union[type, Callable]) –
byscore (bool) –
bylex (bool) –
offset (Optional[int]) –
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- 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.For more information see https://redis.io/commands/zrangebylex
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[bytes, memoryview, str, int, float]) –
max (Union[bytes, memoryview, str, int, float]) –
start (Optional[int]) –
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zrangebyscore(name, min, max, start=None, num=None, withscores=False, score_cast_func=<class '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
For more information see https://redis.io/commands/zrangebyscore
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[float, str]) –
max (Union[float, str]) –
start (Optional[int]) –
num (Optional[int]) –
withscores (bool) –
score_cast_func (Union[type, Callable]) –
- Return type
Union[Awaitable[Any], Any]
- zrangestore(dest, name, start, end, byscore=False, bylex=False, desc=False, offset=None, num=None)#
Stores in
dest
the result of a range of values from sorted setname
betweenstart
andend
sorted in ascending order.start
andend
can be negative, indicating the end of the range.byscore
when set to True, returns the range of elements from the sorted set having scores equal or betweenstart
andend
.bylex
when set to True, returns the range of elements from the sorted set between thestart
andend
lexicographical closed range intervals. Validstart
andend
must start with ( or [, in order to specify whether the range interval is exclusive or inclusive, respectively.desc
a boolean indicating whether to sort the results in reversed order.offset
andnum
are specified, then return a slice of the range. Can’t be provided when usingbylex
.For more information see https://redis.io/commands/zrangestore
- Parameters
dest (Union[bytes, str, memoryview]) –
name (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
byscore (bool) –
bylex (bool) –
desc (bool) –
offset (Optional[int]) –
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zrank(name, value, withscore=False)#
Returns a 0-based value indicating the rank of
value
in sorted setname
. The optional WITHSCORE argument supplements the command’s reply with the score of the element returned.For more information see https://redis.io/commands/zrank
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
withscore (bool) –
- Return type
Union[Awaitable[Any], Any]
- zrem(name, *values)#
Remove member
values
from sorted setname
For more information see https://redis.io/commands/zrem
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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.
For more information see https://redis.io/commands/zremrangebylex
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[bytes, memoryview, str, int, float]) –
max (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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 removedFor more information see https://redis.io/commands/zremrangebyrank
- Parameters
name (Union[bytes, str, memoryview]) –
min (int) –
max (int) –
- Return type
Union[Awaitable[Any], Any]
- zremrangebyscore(name, min, max)#
Remove all elements in the sorted set
name
with scores betweenmin
andmax
. Returns the number of elements removed.For more information see https://redis.io/commands/zremrangebyscore
- Parameters
name (Union[bytes, str, memoryview]) –
min (Union[float, str]) –
max (Union[float, str]) –
- Return type
Union[Awaitable[Any], Any]
- zrevrange(name, start, end, withscores=False, score_cast_func=<class '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 valueFor more information see https://redis.io/commands/zrevrange
- Parameters
name (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
withscores (bool) –
score_cast_func (Union[type, Callable]) –
- Return type
Union[Awaitable[Any], Any]
- 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.For more information see https://redis.io/commands/zrevrangebylex
- Parameters
name (Union[bytes, str, memoryview]) –
max (Union[bytes, memoryview, str, int, float]) –
min (Union[bytes, memoryview, str, int, float]) –
start (Optional[int]) –
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- zrevrangebyscore(name, max, min, start=None, num=None, withscores=False, score_cast_func=<class '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 valueFor more information see https://redis.io/commands/zrevrangebyscore
- Parameters
name (Union[bytes, str, memoryview]) –
max (Union[float, str]) –
min (Union[float, str]) –
start (Optional[int]) –
num (Optional[int]) –
withscores (bool) –
score_cast_func (Union[type, Callable]) –
- zrevrank(name, value, withscore=False)#
Returns a 0-based value indicating the descending rank of
value
in sorted setname
. The optionalwithscore
argument supplements the command’s reply with the score of the element returned.For more information see https://redis.io/commands/zrevrank
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
withscore (bool) –
- Return type
Union[Awaitable[Any], Any]
- zscan(name, cursor=0, match=None, count=None, score_cast_func=<class '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 valueFor more information see https://redis.io/commands/zscan
- Parameters
name (Union[bytes, str, memoryview]) –
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
score_cast_func (Union[type, Callable]) –
- Return type
Union[Awaitable[Any], Any]
- zscan_iter(name, match=None, count=None, score_cast_func=<class '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- Parameters
name (Union[bytes, str, memoryview]) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
score_cast_func (Union[type, Callable]) –
- Return type
Iterator
- zscore(name, value)#
Return the score of element
value
in sorted setname
For more information see https://redis.io/commands/zscore
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- zunion(keys, aggregate=None, withscores=False)#
Return the union of multiple sorted sets specified by
keys
.keys
can be provided as dictionary of keys and their weights. Scores will be aggregated based on theaggregate
, or SUM if none is provided.For more information see https://redis.io/commands/zunion
- Parameters
keys (Union[Sequence[Union[bytes, str, memoryview]], Mapping[AnyKeyT, float]]) –
aggregate (Optional[str]) –
withscores (bool) –
- Return type
Union[Awaitable[Any], Any]
- 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.For more information see https://redis.io/commands/zunionstore
- Parameters
dest (Union[bytes, str, memoryview]) –
keys (Union[Sequence[Union[bytes, str, memoryview]], Mapping[AnyKeyT, float]]) –
aggregate (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
Sentinel Commands#
- class redis.commands.sentinel.SentinelCommands[source]#
A class containing the commands specific to redis sentinel. This class is to be used as a mixin.
- sentinel_ckquorum(new_master_name)[source]#
Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover.
This command should be used in monitoring systems to check if a Sentinel deployment is ok.
- sentinel_failover(new_master_name)[source]#
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
- sentinel_flushconfig()[source]#
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
Normally Sentinel rewrites the configuration every time something changes in its state (in the context of the subset of the state which is persisted on disk across restart). However sometimes it is possible that the configuration file is lost because of operation errors, disk failures, package upgrade scripts or configuration managers. In those cases a way to to force Sentinel to rewrite the configuration file is handy.
This command works even if the previous configuration file is completely missing.
- sentinel_get_master_addr_by_name(service_name)[source]#
Returns a (host, port) pair for the given
service_name
- sentinel_reset(pattern)[source]#
This command will reset all the masters with matching name. The pattern argument is a glob-style pattern.
The reset process clears any previous state in a master (including a failover in progress), and removes every slave and sentinel already discovered and associated with the master.
Redis Cluster Commands#
The following Redis commands are available within a Redis Cluster. Generally they can be used as functions on your redis connection.
- class redis.commands.cluster.RedisClusterCommands(*args, **kwargs)[source]#
A class for all Redis Cluster commands
For key-based commands, the target node(s) will be internally determined by the keys’ hash slot. Non-key-based commands can be executed with the ‘target_nodes’ argument to target specific nodes. By default, if target_nodes is not specified, the command will be executed on the default cluster node.
- Parameters
:target_nodes – type can be one of the followings: - nodes flag: ALL_NODES, PRIMARIES, REPLICAS, RANDOM - ‘ClusterNode’ - ‘list(ClusterNodes)’ - ‘dict(any:clusterNodes)’
- for example:
r.cluster_info(target_nodes=RedisCluster.ALL_NODES)
- acl_cat(category=None, **kwargs)#
Returns a list of categories or commands within a category.
If
category
is not supplied, returns a list of all categories. Ifcategory
is supplied, returns a list of all commands within that category.For more information see https://redis.io/commands/acl-cat
- Parameters
category (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- acl_deluser(*username, **kwargs)#
Delete the ACL for the specified
username
sFor more information see https://redis.io/commands/acl-deluser
- Parameters
username (str) –
- Return type
Union[Awaitable[Any], Any]
- acl_dryrun(username, *args, **kwargs)#
Simulate the execution of a given command by a given
username
.For more information see https://redis.io/commands/acl-dryrun
- acl_genpass(bits=None, **kwargs)#
Generate a random password value. If
bits
is supplied then use this number of bits, rounded to the next multiple of 4. See: https://redis.io/commands/acl-genpass- Parameters
bits (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- acl_getuser(username, **kwargs)#
Get the ACL details for the specified
username
.If
username
does not exist, return NoneFor more information see https://redis.io/commands/acl-getuser
- Parameters
username (str) –
- Return type
Union[Awaitable[Any], Any]
- acl_help(**kwargs)#
The ACL HELP command returns helpful text describing the different subcommands.
For more information see https://redis.io/commands/acl-help
- Return type
Union[Awaitable[Any], Any]
- acl_list(**kwargs)#
Return a list of all ACLs on the server
For more information see https://redis.io/commands/acl-list
- Return type
Union[Awaitable[Any], Any]
- acl_load(**kwargs)#
Load ACL rules from the configured
aclfile
.Note that the server must be configured with the
aclfile
directive to be able to load ACL rules from an aclfile.For more information see https://redis.io/commands/acl-load
- Return type
Union[Awaitable[Any], Any]
- acl_log(count=None, **kwargs)#
Get ACL logs as a list. :param int count: Get logs[0:count]. :rtype: List.
For more information see https://redis.io/commands/acl-log
- Parameters
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- acl_log_reset(**kwargs)#
Reset ACL logs. :rtype: Boolean.
For more information see https://redis.io/commands/acl-log
- Return type
Union[Awaitable[Any], Any]
- acl_save(**kwargs)#
Save ACL rules to the configured
aclfile
.Note that the server must be configured with the
aclfile
directive to be able to save ACL rules to an aclfile.For more information see https://redis.io/commands/acl-save
- Return type
Union[Awaitable[Any], Any]
- acl_setuser(username, enabled=False, nopass=False, passwords=None, hashed_passwords=None, categories=None, commands=None, keys=None, channels=None, selectors=None, reset=False, reset_keys=False, reset_channels=False, reset_passwords=False, **kwargs)#
Create or update an ACL user.
Create or update the ACL for username. If the user already exists, the existing ACL is completely overwritten and replaced with the specified values.
For more information, see https://redis.io/commands/acl-setuser
- Parameters
username (str) – The name of the user whose ACL is to be created or updated.
enabled (bool) – Indicates whether the user should be allowed to authenticate. Defaults to False.
nopass (bool) – Indicates whether the user can authenticate without a password. This cannot be True if passwords are also specified.
passwords (Optional[Union[str, Iterable[str]]]) – A list of plain text passwords to add to or remove from the user. Each password must be prefixed with a ‘+’ to add or a ‘-’ to remove. For convenience, a single prefixed string can be used when adding or removing a single password.
hashed_passwords (Optional[Union[str, Iterable[str]]]) – A list of SHA-256 hashed passwords to add to or remove from the user. Each hashed password must be prefixed with a ‘+’ to add or a ‘-’ to remove. For convenience, a single prefixed string can be used when adding or removing a single password.
categories (Optional[Iterable[str]]) – A list of strings representing category permissions. Each string must be prefixed with either a ‘+’ to add the category permission or a ‘-’ to remove the category permission.
commands (Optional[Iterable[str]]) – A list of strings representing command permissions. Each string must be prefixed with either a ‘+’ to add the command permission or a ‘-’ to remove the command permission.
keys (Optional[Iterable[Union[bytes, str, memoryview]]]) – A list of key patterns to grant the user access to. Key patterns allow
'*'
to support wildcard matching. For example,'*'
grants access to all keys while'cache:*'
grants access to all keys that are prefixed withcache:
. keys should not be prefixed with a'~'
.reset (bool) – Indicates whether the user should be fully reset prior to applying the new ACL. Setting this to True will remove all existing passwords, flags, and privileges from the user and then apply the specified rules. If False, the user’s existing passwords, flags, and privileges will be kept and any new specified rules will be applied on top.
reset_keys (bool) – Indicates whether the user’s key permissions should be reset prior to applying any new key permissions specified in keys. If False, the user’s existing key permissions will be kept and any new specified key permissions will be applied on top.
reset_channels (bool) – Indicates whether the user’s channel permissions should be reset prior to applying any new channel permissions specified in channels. If False, the user’s existing channel permissions will be kept and any new specified channel permissions will be applied on top.
reset_passwords (bool) – Indicates whether to remove all existing passwords and the nopass flag from the user prior to applying any new passwords specified in passwords or hashed_passwords. If False, the user’s existing passwords and nopass status will be kept and any new specified passwords or hashed passwords will be applied on top.
channels (Optional[Iterable[Union[bytes, str, memoryview]]]) –
selectors (Optional[Iterable[Tuple[str, Union[bytes, str, memoryview]]]]) –
- Return type
Union[Awaitable[Any], Any]
- acl_users(**kwargs)#
Returns a list of all registered users on the server.
For more information see https://redis.io/commands/acl-users
- Return type
Union[Awaitable[Any], Any]
- acl_whoami(**kwargs)#
Get the username for the current connection
For more information see https://redis.io/commands/acl-whoami
- Return type
Union[Awaitable[Any], Any]
- 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
.For more information see https://redis.io/commands/append
- Parameters
key (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- auth(password, username=None, **kwargs)#
Authenticates the user. If you do not pass username, Redis will try to authenticate for the “default” user. If you do pass username, it will authenticate for the given user. For more information see https://redis.io/commands/auth
- Parameters
password (str) –
username (Optional[str]) –
- bf()#
Access the bloom namespace.
- bgrewriteaof(**kwargs)#
Tell the Redis server to rewrite the AOF file from data in memory.
For more information see https://redis.io/commands/bgrewriteaof
- bgsave(schedule=True, **kwargs)#
Tell the Redis server to save its data to disk. Unlike save(), this method is asynchronous and returns immediately.
For more information see https://redis.io/commands/bgsave
- Parameters
schedule (bool) –
- Return type
Union[Awaitable[Any], Any]
- bitcount(key, start=None, end=None, mode=None)#
Returns the count of set bits in the value of
key
. Optionalstart
andend
parameters indicate which bytes to considerFor more information see https://redis.io/commands/bitcount
- Parameters
key (Union[bytes, str, memoryview]) –
start (Optional[int]) –
end (Optional[int]) –
mode (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- bitfield(key, default_overflow=None)#
Return a BitFieldOperation instance to conveniently construct one or more bitfield operations on
key
.For more information see https://redis.io/commands/bitfield
- Parameters
self (Union[redis.client.Redis, redis.asyncio.client.Redis]) –
key (Union[bytes, str, memoryview]) –
default_overflow (Optional[str]) –
- Return type
BitFieldOperation
- bitfield_ro(key, encoding, offset, items=None)#
Return an array of the specified bitfield values where the first value is found using
encoding
andoffset
parameters and remaining values are result of corresponding encoding/offset pairs in optional listitems
Read-only variant of the BITFIELD command.For more information see https://redis.io/commands/bitfield_ro
- Parameters
self (Union[redis.client.Redis, redis.asyncio.client.Redis]) –
key (Union[bytes, str, memoryview]) –
encoding (str) –
offset (Union[int, str]) –
items (Optional[list]) –
- Return type
Union[Awaitable[Any], Any]
- bitop(operation, dest, *keys)#
Perform a bitwise operation using
operation
betweenkeys
and store the result indest
.For more information see https://redis.io/commands/bitop
- Parameters
operation (str) –
dest (Union[bytes, str, memoryview]) –
keys (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- bitpos(key, bit, start=None, end=None, mode=None)#
Return the position of the first bit set to 1 or 0 in a string.
start
andend
defines 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.For more information see https://redis.io/commands/bitpos
- Parameters
key (Union[bytes, str, memoryview]) –
bit (int) –
start (Optional[int]) –
end (Optional[int]) –
mode (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- blmove(first_list, second_list, timeout, src='LEFT', dest='RIGHT')#
Blocking version of lmove.
For more information see https://redis.io/commands/blmove
- Parameters
first_list (str) –
second_list (str) –
timeout (int) –
src (str) –
dest (str) –
- Return type
Union[Awaitable[Any], Any]
- blmpop(timeout, numkeys, *args, direction, count=1)#
Pop
count
values (default 1) from first non-empty in the list of provided key names.When all lists are empty this command blocks the connection until another client pushes to it or until the timeout, timeout of 0 blocks indefinitely
For more information see https://redis.io/commands/blmpop
- Parameters
timeout (float) –
numkeys (int) –
args (List[str]) –
direction (str) –
count (Optional[int]) –
- Return type
Optional[list]
- 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.
For more information see https://redis.io/commands/blpop
- Parameters
keys (List) –
timeout (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- 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 RPOP, then block fortimeout
seconds, or until a value gets pushed on to one of the lists.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/brpop
- Parameters
keys (List) –
timeout (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- 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.For more information see https://redis.io/commands/brpoplpush
- Parameters
src (str) –
dst (str) –
timeout (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- bzmpop(timeout, numkeys, keys, min=False, max=False, count=1)#
Pop
count
values (default 1) off of the first non-empty sorted set named in thekeys
list.If none of the sorted sets in
keys
has a value to pop, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzmpop
- Parameters
timeout (float) –
numkeys (int) –
keys (List[str]) –
min (Optional[bool]) –
max (Optional[bool]) –
count (Optional[int]) –
- Return type
Optional[list]
- bzpopmax(keys, timeout=0)#
ZPOPMAX a value off of the first non-empty sorted set named in the
keys
list.If none of the sorted sets in
keys
has a value to ZPOPMAX, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmax
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
timeout (Union[int, float, bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- bzpopmin(keys, timeout=0)#
ZPOPMIN a value off of the first non-empty sorted set named in the
keys
list.If none of the sorted sets in
keys
has a value to ZPOPMIN, then block fortimeout
seconds, or until a member gets added to one of the sorted sets.If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmin
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
timeout (Union[int, float, bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- cf()#
Access the bloom namespace.
- client_getname(**kwargs)#
Returns the current connection name
For more information see https://redis.io/commands/client-getname
- Return type
Union[Awaitable[Any], Any]
- client_getredir(**kwargs)#
Returns the ID (an integer) of the client to whom we are redirecting tracking notifications.
see: https://redis.io/commands/client-getredir
- Return type
Union[Awaitable[Any], Any]
- client_id(**kwargs)#
Returns the current connection id
For more information see https://redis.io/commands/client-id
- Return type
Union[Awaitable[Any], Any]
- client_info(**kwargs)#
Returns information and statistics about the current client connection.
For more information see https://redis.io/commands/client-info
- Return type
Union[Awaitable[Any], Any]
- client_kill(address, **kwargs)#
Disconnects the client at
address
(ip:port)For more information see https://redis.io/commands/client-kill
- Parameters
address (str) –
- Return type
Union[Awaitable[Any], Any]
- client_kill_filter(_id=None, _type=None, addr=None, skipme=None, laddr=None, user=None, maxage=None, **kwargs)#
Disconnects client(s) using a variety of filter options :param _id: Kills a client by its unique ID field :param _type: Kills a client by type where type is one of ‘normal’, ‘master’, ‘slave’ or ‘pubsub’ :param addr: Kills a client by its ‘address:port’ :param skipme: If True, then the client calling the command will not get killed even if it is identified by one of the filter options. If skipme is not provided, the server defaults to skipme=True :param laddr: Kills a client by its ‘local (bind) address:port’ :param user: Kills a client for a specific user name :param maxage: Kills clients that are older than the specified age in seconds
- Parameters
_id (Optional[str]) –
_type (Optional[str]) –
addr (Optional[str]) –
skipme (Optional[bool]) –
laddr (Optional[bool]) –
user (Optional[str]) –
maxage (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- client_list(_type=None, client_id=[], **kwargs)#
Returns a list of currently connected clients. If type of client specified, only that type will be returned.
- Parameters
_type (Optional[str]) – optional. one of the client types (normal, master, replica, pubsub)
client_id (List[Union[bytes, memoryview, str, int, float]]) – optional. a list of client ids
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/client-list
- client_no_evict(mode)#
Sets the client eviction mode for the current connection.
For more information see https://redis.io/commands/client-no-evict
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- client_no_touch(mode)#
# The command controls whether commands sent by the client will alter # the LRU/LFU of the keys they access. # When turned on, the current client will not change LFU/LRU stats, # unless it sends the TOUCH command.
For more information see https://redis.io/commands/client-no-touch
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- client_pause(timeout, all=True, **kwargs)#
Suspend all the Redis clients for the specified amount of time.
For more information see https://redis.io/commands/client-pause
- Parameters
timeout (int) – milliseconds to pause clients
all (bool) – If true (default) all client commands are blocked. otherwise, clients are only blocked if they attempt to execute a write command.
- Return type
Union[Awaitable[Any], Any]
For the WRITE mode, some commands have special behavior:
EVAL/EVALSHA: Will block client for all scripts.
PUBLISH: Will block client.
PFCOUNT: Will block client.
- WAIT: Acknowledgments will be delayed, so this command will
appear blocked.
- client_reply(reply, **kwargs)#
Enable and disable redis server replies.
reply
Must be ON OFF or SKIP, ON - The default most with server replies to commands OFF - Disable server responses to commands SKIP - Skip the response of the immediately following command.Note: When setting OFF or SKIP replies, you will need a client object with a timeout specified in seconds, and will need to catch the TimeoutError. The test_client_reply unit test illustrates this, and conftest.py has a client with a timeout.
See https://redis.io/commands/client-reply
- Parameters
reply (Union[Literal['ON'], ~typing.Literal['OFF'], ~typing.Literal['SKIP']]) –
- Return type
Union[Awaitable[Any], Any]
- client_setinfo(attr, value, **kwargs)#
Sets the current connection library name or version For mor information see https://redis.io/commands/client-setinfo
- Parameters
attr (str) –
value (str) –
- Return type
Union[Awaitable[Any], Any]
- client_setname(name, **kwargs)#
Sets the current connection name
For more information see https://redis.io/commands/client-setname
Note
This method sets client name only for current connection.
If you want to set a common name for all connections managed by this client, use
client_name
constructor argument.- Parameters
name (str) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking(on=True, clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False, **kwargs)#
Enables the tracking feature of the Redis server, that is used for server assisted client side caching.
on
indicate for tracking on or tracking off. The dafualt is on.clientid
send invalidation messages to the connection with the specified ID.bcast
enable tracking in broadcasting mode. In this mode invalidation messages are reported for all the prefixes specified, regardless of the keys requested by the connection.optin
when broadcasting is NOT active, normally don’t track keys in read only commands, unless they are called immediately after a CLIENT CACHING yes command.optout
when broadcasting is NOT active, normally track keys in read only commands, unless they are called immediately after a CLIENT CACHING no command.noloop
don’t send notifications about keys modified by this connection itself.prefix
for broadcasting, register a given key prefix, so that notifications will be provided only for keys starting with this string.See https://redis.io/commands/client-tracking
- Parameters
on (bool) –
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking_off(clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False)#
Turn off the tracking mode. For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
- Parameters
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_tracking_on(clientid=None, prefix=[], bcast=False, optin=False, optout=False, noloop=False)#
Turn on the tracking mode. For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
- Parameters
clientid (Optional[int]) –
prefix (Sequence[Union[bytes, str, memoryview]]) –
bcast (bool) –
optin (bool) –
optout (bool) –
noloop (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_trackinginfo(**kwargs)#
Returns the information about the current client connection’s use of the server assisted client side cache.
See https://redis.io/commands/client-trackinginfo
- Return type
Union[Awaitable[Any], Any]
- client_unblock(client_id, error=False, **kwargs)#
Unblocks a connection by its client id. If
error
is True, unblocks the client with a special error message. Iferror
is False (default), the client is unblocked using the regular timeout mechanism.For more information see https://redis.io/commands/client-unblock
- Parameters
client_id (int) –
error (bool) –
- Return type
Union[Awaitable[Any], Any]
- client_unpause(**kwargs)#
Unpause all redis clients
For more information see https://redis.io/commands/client-unpause
- Return type
Union[Awaitable[Any], Any]
- cluster_addslots(target_node, *slots)#
Assign new hash slots to receiving node. Sends to specified node.
- Target_node
‘ClusterNode’ The node to execute the command on
- Parameters
target_node (TargetNodesT) –
slots (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/cluster-addslots
- cluster_addslotsrange(target_node, *slots)#
Similar to the CLUSTER ADDSLOTS command. The difference between the two commands is that ADDSLOTS takes a list of slots to assign to the node, while ADDSLOTSRANGE takes a list of slot ranges (specified by start and end slots) to assign to the node.
- Target_node
‘ClusterNode’ The node to execute the command on
- Parameters
target_node (TargetNodesT) –
slots (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/cluster-addslotsrange
- cluster_count_failure_report(node_id)#
Return the number of failure reports active for a given node Sends to a random node
For more information see https://redis.io/commands/cluster-count-failure-reports
- Parameters
node_id (str) –
- Return type
Union[Awaitable[Any], Any]
- cluster_countkeysinslot(slot_id)#
Return the number of local keys in the specified hash slot Send to node based on specified slot_id
For more information see https://redis.io/commands/cluster-countkeysinslot
- Parameters
slot_id (int) –
- Return type
Union[Awaitable[Any], Any]
- cluster_delslots(*slots)#
Set hash slots as unbound in the cluster. It determines by it self what node the slot is in and sends it there
Returns a list of the results for each processed slot.
For more information see https://redis.io/commands/cluster-delslots
- Parameters
slots (Union[bytes, memoryview, str, int, float]) –
- Return type
List[bool]
- cluster_delslotsrange(*slots)#
Similar to the CLUSTER DELSLOTS command. The difference is that CLUSTER DELSLOTS takes a list of hash slots to remove from the node, while CLUSTER DELSLOTSRANGE takes a list of slot ranges to remove from the node.
For more information see https://redis.io/commands/cluster-delslotsrange
- Parameters
slots (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_failover(target_node, option=None)#
Forces a slave to perform a manual failover of its master Sends to specified node
- Target_node
‘ClusterNode’ The node to execute the command on
- Parameters
target_node (TargetNodesT) –
option (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/cluster-failover
- cluster_get_keys_in_slot(slot, num_keys)#
Returns the number of keys in the specified cluster slot
For more information see https://redis.io/commands/cluster-getkeysinslot
- Parameters
slot (int) –
num_keys (int) –
- Return type
Union[Awaitable[Any], Any]
- cluster_info(target_nodes=None)#
Provides info about Redis Cluster node state. The command will be sent to a random node in the cluster if no target node is specified.
For more information see https://redis.io/commands/cluster-info
- Parameters
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_keyslot(key)#
Returns the hash slot of the specified key Sends to random node in the cluster
For more information see https://redis.io/commands/cluster-keyslot
- Parameters
key (str) –
- Return type
Union[Awaitable[Any], Any]
- cluster_links(target_node)#
Each node in a Redis Cluster maintains a pair of long-lived TCP link with each peer in the cluster: One for sending outbound messages towards the peer and one for receiving inbound messages from the peer.
This command outputs information of all such peer links as an array.
For more information see https://redis.io/commands/cluster-links
- Parameters
target_node (TargetNodesT) –
- Return type
Union[Awaitable[Any], Any]
- cluster_meet(host, port, target_nodes=None)#
Force a node cluster to handshake with another node. Sends to specified node.
For more information see https://redis.io/commands/cluster-meet
- Parameters
host (str) –
port (int) –
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_myid(target_node)#
Returns the node’s id.
- Target_node
‘ClusterNode’ The node to execute the command on
- Parameters
target_node (TargetNodesT) –
- Return type
Union[Awaitable[Any], Any]
For more information check https://redis.io/commands/cluster-myid/
- cluster_myshardid(target_nodes=None)#
Returns the shard ID of the node.
For more information see https://redis.io/commands/cluster-myshardid/
- cluster_nodes()#
Get Cluster config for the node. Sends to random node in the cluster
For more information see https://redis.io/commands/cluster-nodes
- Return type
Union[Awaitable[Any], Any]
- cluster_replicas(node_id, target_nodes=None)#
Provides a list of replica nodes replicating from the specified primary target node.
For more information see https://redis.io/commands/cluster-replicas
- Parameters
node_id (str) –
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_replicate(target_nodes, node_id)#
Reconfigure a node as a slave of the specified master node
For more information see https://redis.io/commands/cluster-replicate
- Parameters
target_nodes (TargetNodesT) –
node_id (str) –
- Return type
Union[Awaitable[Any], Any]
- cluster_reset(soft=True, target_nodes=None)#
Reset a Redis Cluster node
If ‘soft’ is True then it will send ‘SOFT’ argument If ‘soft’ is False then it will send ‘HARD’ argument
For more information see https://redis.io/commands/cluster-reset
- Parameters
soft (bool) –
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_save_config(target_nodes=None)#
Forces the node to save cluster state on disk
For more information see https://redis.io/commands/cluster-saveconfig
- Parameters
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_set_config_epoch(epoch, target_nodes=None)#
Set the configuration epoch in a new node
For more information see https://redis.io/commands/cluster-set-config-epoch
- Parameters
epoch (int) –
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cluster_setslot(target_node, node_id, slot_id, state)#
Bind an hash slot to a specific node
- Target_node
‘ClusterNode’ The node to execute the command on
- Parameters
target_node (TargetNodesT) –
node_id (str) –
slot_id (int) –
state (str) –
- Return type
Union[Awaitable[Any], Any]
For more information see https://redis.io/commands/cluster-setslot
- cluster_setslot_stable(slot_id)#
Clears migrating / importing state from the slot. It determines by it self what node the slot is in and sends it there.
For more information see https://redis.io/commands/cluster-setslot
- Parameters
slot_id (int) –
- Return type
Union[Awaitable[Any], Any]
- cluster_shards(target_nodes=None)#
Returns details about the shards of the cluster.
For more information see https://redis.io/commands/cluster-shards
- cluster_slots(target_nodes=None)#
Get array of Cluster slot to node mappings
For more information see https://redis.io/commands/cluster-slots
- Parameters
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- cms()#
Access the bloom namespace.
- command(**kwargs)#
Returns dict reply of details about all Redis commands.
For more information see https://redis.io/commands/command
- command_docs(*args)#
This function throws a NotImplementedError since it is intentionally not supported.
- command_getkeysandflags(*args)#
Returns array of keys from a full Redis command and their usage flags.
For more information see https://redis.io/commands/command-getkeysandflags
- Parameters
args (List[str]) –
- Return type
List[Union[str, List[str]]]
- command_list(module=None, category=None, pattern=None)#
Return an array of the server’s command names. You can use one of the following filters:
module
: get the commands that belong to the modulecategory
: get the commands in the ACL categorypattern
: get the commands that match the given patternFor more information see https://redis.io/commands/command-list/
- Parameters
module (Optional[str]) –
category (Optional[str]) –
pattern (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- config_get(pattern='*', *args, **kwargs)#
Return a dictionary of configuration based on the
pattern
For more information see https://redis.io/commands/config-get
- Parameters
pattern (Union[bytes, str, memoryview]) –
args (List[Union[bytes, str, memoryview]]) –
- Return type
Union[Awaitable[Any], Any]
- config_resetstat(**kwargs)#
Reset runtime statistics
For more information see https://redis.io/commands/config-resetstat
- Return type
Union[Awaitable[Any], Any]
- config_rewrite(**kwargs)#
Rewrite config file with the minimal change to reflect running config.
For more information see https://redis.io/commands/config-rewrite
- Return type
Union[Awaitable[Any], Any]
- config_set(name, value, *args, **kwargs)#
Set config item
name
withvalue
For more information see https://redis.io/commands/config-set
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
args (List[Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- copy(source, destination, destination_db=None, replace=False)#
Copy the value stored in the
source
key to thedestination
key.destination_db
an alternative destination database. By default, thedestination
key is created in the source Redis database.replace
whether thedestination
key should be removed before copying the value to it. By default, the value is not copied if thedestination
key already exists.For more information see https://redis.io/commands/copy
- Parameters
source (str) –
destination (str) –
destination_db (Optional[str]) –
replace (bool) –
- Return type
Union[Awaitable[Any], Any]
- dbsize(**kwargs)#
Returns the number of keys in the current database
For more information see https://redis.io/commands/dbsize
- Return type
Union[Awaitable[Any], Any]
- debug_object(key, **kwargs)#
Returns version specific meta information about a given key
For more information see https://redis.io/commands/debug-object
- Parameters
key (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- decr(name, amount=1)#
Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
For more information see https://redis.io/commands/decrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- decrby(name, amount=1)#
Decrements the value of
key
byamount
. If no key exists, the value will be initialized as 0 -amount
For more information see https://redis.io/commands/decrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- delete(*keys)#
Deletes the given keys in the cluster. The keys are first split up into slots and then an DEL command is sent for every slot
Non-existent keys are ignored. Returns the number of keys that were deleted.
For more information see https://redis.io/commands/del
- Parameters
keys (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- 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.
For more information see https://redis.io/commands/dump
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- echo(value, **kwargs)#
Echo the string back from the server
For more information see https://redis.io/commands/echo
- Parameters
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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.For more information see https://redis.io/commands/eval
- Parameters
script (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- eval_ro(script, numkeys, *keys_and_args)#
The read-only variant of the EVAL command
Execute the read-only Lua
script
specifying thenumkeys
the script will touch and the key names and argument values inkeys_and_args
. Returns the result of the script.For more information see https://redis.io/commands/eval_ro
- Parameters
script (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- 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.For more information see https://redis.io/commands/evalsha
- Parameters
sha (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- evalsha_ro(sha, numkeys, *keys_and_args)#
The read-only variant of the EVALSHA command
Use the
sha
to execute a read-only 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.For more information see https://redis.io/commands/evalsha_ro
- Parameters
sha (str) –
numkeys (int) –
keys_and_args (str) –
- Return type
Union[Awaitable[str], str]
- exists(*keys)#
Returns the number of
names
that exist in the whole cluster. The keys are first split up into slots and then an EXISTS command is sent for every slotFor more information see https://redis.io/commands/exists
- Parameters
keys (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- expire(name, time, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
fortime
seconds with givenoption
.time
can be represented by an integer or a Python timedelta object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expire
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- expireat(name, when, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
with givenoption
.when
can be represented as an integer indicating unix time or a Python datetime object.- Valid options are:
-> NX – Set expiry only when the key has no expiry -> XX – Set expiry only when the key has an existing expiry -> GT – Set expiry only when the new expiry is greater than current one -> LT – Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expireat
- Parameters
name (Union[bytes, str, memoryview]) –
when (Union[int, datetime]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- expiretime(key)#
Returns the absolute Unix timestamp (since January 1, 1970) in seconds at which the given key will expire.
For more information see https://redis.io/commands/expiretime
- Parameters
key (str) –
- Return type
int
- failover()#
This function throws a NotImplementedError since it is intentionally not supported.
- fcall(function, numkeys, *keys_and_args)#
Invoke a function.
For more information see https://redis.io/commands/fcall
- Parameters
numkeys (int) –
keys_and_args (Optional[List]) –
- Return type
Union[Awaitable[str], str]
- fcall_ro(function, numkeys, *keys_and_args)#
This is a read-only variant of the FCALL command that cannot execute commands that modify data.
For more information see https://redis.io/commands/fcal_ro
- Parameters
numkeys (int) –
keys_and_args (Optional[List]) –
- Return type
Union[Awaitable[str], str]
- flushall(asynchronous=False, **kwargs)#
Delete all keys in all databases on the current host.
asynchronous
indicates whether the operation is executed asynchronously by the server.For more information see https://redis.io/commands/flushall
- Parameters
asynchronous (bool) –
- Return type
Union[Awaitable[Any], Any]
- flushdb(asynchronous=False, **kwargs)#
Delete all keys in the current database.
asynchronous
indicates whether the operation is executed asynchronously by the server.For more information see https://redis.io/commands/flushdb
- Parameters
asynchronous (bool) –
- Return type
Union[Awaitable[Any], Any]
- ft(index_name='idx')#
Access the search namespace, providing support for redis search.
- function_delete(library)#
Delete the library called
library
and all its functions.For more information see https://redis.io/commands/function-delete
- Parameters
library (str) –
- Return type
Union[Awaitable[str], str]
- function_dump()#
Return the serialized payload of loaded libraries.
For more information see https://redis.io/commands/function-dump
- Return type
Union[Awaitable[str], str]
- function_flush(mode='SYNC')#
Deletes all the libraries.
For more information see https://redis.io/commands/function-flush
- Parameters
mode (str) –
- Return type
Union[Awaitable[str], str]
- function_kill()#
Kill a function that is currently executing.
For more information see https://redis.io/commands/function-kill
- Return type
Union[Awaitable[str], str]
- function_list(library='*', withcode=False)#
Return information about the functions and libraries.
- Parameters
library (Optional[str]) – specify a pattern for matching library names
withcode (Optional[bool]) – cause the server to include the libraries source implementation in the reply
- Return type
Union[Awaitable[List], List]
- function_load(code, replace=False)#
Load a library to Redis. :param code: the source code (must start with Shebang statement that provides a metadata about the library) :param replace: changes the behavior to overwrite the existing library with the new contents. Return the library name that was loaded.
For more information see https://redis.io/commands/function-load
- Parameters
code (str) –
replace (Optional[bool]) –
- Return type
Union[Awaitable[str], str]
- function_restore(payload, policy='APPEND')#
Restore libraries from the serialized
payload
. You can use the optional policy argument to provide a policy for handling existing libraries.For more information see https://redis.io/commands/function-restore
- Parameters
payload (str) –
policy (Optional[str]) –
- Return type
Union[Awaitable[str], str]
- function_stats()#
Return information about the function that’s currently running and information about the available execution engines.
For more information see https://redis.io/commands/function-stats
- Return type
Union[Awaitable[List], List]
- gears_refresh_cluster(**kwargs)#
On an OSS cluster, before executing any gears function, you must call this command. # noqa
- Return type
Union[Awaitable[Any], Any]
- geoadd(name, values, nx=False, xx=False, ch=False)#
Add the specified geospatial items to the specified key identified by the
name
argument. The Geospatial items are given as ordered members of thevalues
argument, each item or place is formed by the triad longitude, latitude and name.Note: You can use ZREM to remove elements.
nx
forces ZADD to only create new elements and not to update scores for elements that already exist.xx
forces ZADD to only update scores of elements that already exist. New elements will not be added.ch
modifies the return value to be the numbers of elements changed. Changed elements include new elements that were added and elements whose scores changed.For more information see https://redis.io/commands/geoadd
- Parameters
name (Union[bytes, str, memoryview]) –
values (Sequence[Union[bytes, memoryview, str, int, float]]) –
nx (bool) –
xx (bool) –
ch (bool) –
- Return type
Union[Awaitable[Any], Any]
- geodist(name, place1, place2, unit=None)#
Return the distance between
place1
andplace2
members of thename
key. The units must be one of the following : m, km mi, ft. By default meters are used.For more information see https://redis.io/commands/geodist
- Parameters
name (Union[bytes, str, memoryview]) –
place1 (Union[bytes, memoryview, str, int, float]) –
place2 (Union[bytes, memoryview, str, int, float]) –
unit (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- geohash(name, *values)#
Return the geo hash string for each item of
values
members of the specified key identified by thename
argument.For more information see https://redis.io/commands/geohash
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- geopos(name, *values)#
Return the positions of each item of
values
as members of the specified key identified by thename
argument. Each position is represented by the pairs lon and lat.For more information see https://redis.io/commands/geopos
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- georadius(name, longitude, latitude, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None, any=False)#
Return the members of the specified key identified by the
name
argument which are within the borders of the area specified with thelatitude
andlongitude
location and the maximum distance from the center specified by theradius
value.The units must be one of the following : m, km mi, ft. By default
withdist
indicates to return the distances of each place.withcoord
indicates to return the latitude and longitude of each place.withhash
indicates to return the geohash string of each place.count
indicates to return the number of elements up to N.sort
indicates to return the places in a sorted way, ASC for nearest to fairest and DESC for fairest to nearest.store
indicates to save the places names in a sorted set named with a specific key, each element of the destination sorted set is populated with the score got from the original geo sorted set.store_dist
indicates to save the places names in a sorted set named with a specific key, instead ofstore
the sorted set destination score is set with the distance.For more information see https://redis.io/commands/georadius
- Parameters
name (Union[bytes, str, memoryview]) –
longitude (float) –
latitude (float) –
radius (float) –
unit (Optional[str]) –
withdist (bool) –
withcoord (bool) –
withhash (bool) –
count (Optional[int]) –
sort (Optional[str]) –
store (Optional[Union[bytes, str, memoryview]]) –
store_dist (Optional[Union[bytes, str, memoryview]]) –
any (bool) –
- Return type
Union[Awaitable[Any], Any]
- georadiusbymember(name, member, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None, any=False)#
This command is exactly like
georadius
with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.For more information see https://redis.io/commands/georadiusbymember
- Parameters
name (Union[bytes, str, memoryview]) –
member (Union[bytes, memoryview, str, int, float]) –
radius (float) –
unit (Optional[str]) –
withdist (bool) –
withcoord (bool) –
withhash (bool) –
count (Optional[int]) –
sort (Optional[str]) –
store (Optional[Union[bytes, str, memoryview]]) –
store_dist (Optional[Union[bytes, str, memoryview]]) –
any (bool) –
- Return type
Union[Awaitable[Any], Any]
- geosearch(name, member=None, longitude=None, latitude=None, unit='m', radius=None, width=None, height=None, sort=None, count=None, any=False, withcoord=False, withdist=False, withhash=False)#
Return the members of specified key identified by the
name
argument, which are within the borders of the area specified by a given shape. This command extends the GEORADIUS command, so in addition to searching within circular areas, it supports searching within rectangular areas.This command should be used in place of the deprecated GEORADIUS and GEORADIUSBYMEMBER commands.
member
Use the position of the given existingmember in the sorted set. Can’t be given with
longitude
andlatitude
.
longitude
andlatitude
Use the position given by this coordinates. Can’t be given withmember
radius
Similar to GEORADIUS, search inside circular area according the given radius. Can’t be given withheight
andwidth
.height
andwidth
Search inside an axis-aligned rectangle, determined by the given height and width. Can’t be given withradius
unit
must be one of the following : m, km, mi, ft. m for meters (the default value), km for kilometers, mi for miles and ft for feet.sort
indicates to return the places in a sorted way, ASC for nearest to furthest and DESC for furthest to nearest.count
limit the results to the first count matching items.any
is set to True, the command will return as soon as enough matches are found. Can’t be provided withoutcount
withdist
indicates to return the distances of each place.withcoord
indicates to return the latitude and longitude of each place.withhash
indicates to return the geohash string of each place.For more information see https://redis.io/commands/geosearch
- Parameters
name (Union[bytes, str, memoryview]) –
member (Optional[Union[bytes, memoryview, str, int, float]]) –
longitude (Optional[float]) –
latitude (Optional[float]) –
unit (str) –
radius (Optional[float]) –
width (Optional[float]) –
height (Optional[float]) –
sort (Optional[str]) –
count (Optional[int]) –
any (bool) –
withcoord (bool) –
withdist (bool) –
withhash (bool) –
- Return type
Union[Awaitable[Any], Any]
- geosearchstore(dest, name, member=None, longitude=None, latitude=None, unit='m', radius=None, width=None, height=None, sort=None, count=None, any=False, storedist=False)#
This command is like GEOSEARCH, but stores the result in
dest
. By default, it stores the results in the destination sorted set with their geospatial information. ifstore_dist
set to True, the command will stores the items in a sorted set populated with their distance from the center of the circle or box, as a floating-point number.For more information see https://redis.io/commands/geosearchstore
- Parameters
dest (Union[bytes, str, memoryview]) –
name (Union[bytes, str, memoryview]) –
member (Optional[Union[bytes, memoryview, str, int, float]]) –
longitude (Optional[float]) –
latitude (Optional[float]) –
unit (str) –
radius (Optional[float]) –
width (Optional[float]) –
height (Optional[float]) –
sort (Optional[str]) –
count (Optional[int]) –
any (bool) –
storedist (bool) –
- Return type
Union[Awaitable[Any], Any]
- get(name)#
Return the value at key
name
, or None if the key doesn’t existFor more information see https://redis.io/commands/get
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- getbit(name, offset)#
Returns an integer indicating the value of
offset
inname
For more information see https://redis.io/commands/getbit
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
- Return type
Union[Awaitable[Any], Any]
- getdel(name)#
Get the value at key
name
and delete the key. This command is similar to GET, except for the fact that it also deletes the key on success (if and only if the key’s value type is a string).For more information see https://redis.io/commands/getdel
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- getex(name, ex=None, px=None, exat=None, pxat=None, persist=False)#
Get the value of key and optionally set its expiration. GETEX is similar to GET, but is a write command with additional options. All time parameters can be given as datetime.timedelta or integers.
ex
sets an expire flag on keyname
forex
seconds.px
sets an expire flag on keyname
forpx
milliseconds.exat
sets an expire flag on keyname
forex
seconds, specified in unix time.pxat
sets an expire flag on keyname
forex
milliseconds, specified in unix time.persist
remove the time to live associated withname
.For more information see https://redis.io/commands/getex
- Parameters
name (Union[bytes, str, memoryview]) –
ex (Optional[Union[int, timedelta]]) –
px (Optional[Union[int, timedelta]]) –
exat (Optional[Union[int, datetime]]) –
pxat (Optional[Union[int, datetime]]) –
persist (bool) –
- Return type
Union[Awaitable[Any], Any]
- getrange(key, start, end)#
Returns the substring of the string value stored at
key
, determined by the offsetsstart
andend
(both are inclusive)For more information see https://redis.io/commands/getrange
- Parameters
key (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
- Return type
Union[Awaitable[Any], Any]
- getset(name, value)#
Sets the value at key
name
tovalue
and returns the old value at keyname
atomically.As per Redis 6.2, GETSET is considered deprecated. Please use SET with GET parameter in new code.
For more information see https://redis.io/commands/getset
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- graph(index_name='idx')#
Access the graph namespace, providing support for redis graph data.
- hdel(name, *keys)#
Delete
keys
from hashname
For more information see https://redis.io/commands/hdel
- Parameters
name (str) –
keys (str) –
- Return type
Union[Awaitable[int], int]
- hello()#
This function throws a NotImplementedError since it is intentionally not supported.
- hexists(name, key)#
Returns a boolean indicating if
key
exists within hashname
For more information see https://redis.io/commands/hexists
- Parameters
name (str) –
key (str) –
- Return type
Union[Awaitable[bool], bool]
- hexpire(name, seconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using relative time in seconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hexpire
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
seconds (Union[int, timedelta]) – Expiration time in seconds, relative. Can be an integer, or a Python timedelta object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hexpireat(name, unix_time_seconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using an absolute Unix timestamp in seconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hexpireat
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
unix_time_seconds (Union[int, datetime]) – Expiration time as Unix timestamp in seconds. Can be an integer or a Python datetime object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiration time.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hexpiretime(key, *fields)#
Returns the expiration times of hash fields as Unix timestamps in seconds.
For more information, see https://redis.io/commands/hexpiretime
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the expiration Unix timestamp in seconds, if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hget(name, key)#
Return the value of
key
within the hashname
For more information see https://redis.io/commands/hget
- Parameters
name (str) –
key (str) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- hgetall(name)#
Return a Python dict of the hash’s name/value pairs
For more information see https://redis.io/commands/hgetall
- Parameters
name (str) –
- Return type
Union[Awaitable[dict], dict]
- hincrby(name, key, amount=1)#
Increment the value of
key
in hashname
byamount
For more information see https://redis.io/commands/hincrby
- Parameters
name (str) –
key (str) –
amount (int) –
- Return type
Union[Awaitable[int], int]
- hincrbyfloat(name, key, amount=1.0)#
Increment the value of
key
in hashname
by floatingamount
For more information see https://redis.io/commands/hincrbyfloat
- Parameters
name (str) –
key (str) –
amount (float) –
- Return type
Union[Awaitable[float], float]
- hkeys(name)#
Return the list of keys within hash
name
For more information see https://redis.io/commands/hkeys
- Parameters
name (str) –
- Return type
Union[Awaitable[List], List]
- hlen(name)#
Return the number of elements in hash
name
For more information see https://redis.io/commands/hlen
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- hmget(name, keys, *args)#
Returns a list of values ordered identically to
keys
For more information see https://redis.io/commands/hmget
- Parameters
name (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[List], List]
- hmset(name, mapping)#
Set key to value within hash
name
for each corresponding key and value from themapping
dict.For more information see https://redis.io/commands/hmset
- Parameters
name (str) –
mapping (dict) –
- Return type
Union[Awaitable[str], str]
- hpersist(name, *fields)#
Removes the expiration time for each specified field in a hash.
For more information, see https://redis.io/commands/hpersist
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
fields (str) – A list of fields within the hash from which to remove the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expiration time.
1 if the expiration time was successfully removed from the field.
- Return type
Returns a list which contains for each field in the request
- hpexpire(name, milliseconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using relative time in milliseconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hpexpire
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
milliseconds (Union[int, timedelta]) – Expiration time in milliseconds, relative. Can be an integer, or a Python timedelta object.
fields (str) – List of fields within the hash to apply the expiration time to.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hpexpireat(name, unix_time_milliseconds, *fields, nx=False, xx=False, gt=False, lt=False)#
Sets or updates the expiration time for fields within a hash key, using an absolute Unix timestamp in milliseconds.
If a field already has an expiration time, the behavior of the update can be controlled using the nx, xx, gt, and lt parameters.
The return value provides detailed information about the outcome for each field.
For more information, see https://redis.io/commands/hpexpireat
- Parameters
name (Union[bytes, str, memoryview]) – The name of the hash key.
unix_time_milliseconds (Union[int, datetime]) – Expiration time as Unix timestamp in milliseconds. Can be an integer or a Python datetime object.
fields (str) – List of fields within the hash to apply the expiry.
nx (bool) – Set expiry only when the field has no expiry.
xx (bool) – Set expiry only when the field has an existing expiry.
gt (bool) – Set expiry only when the new expiry is greater than the current one.
lt (bool) – Set expiry only when the new expiry is less than the current one.
- Returns
-2 if the field does not exist, or if the key does not exist.
0 if the specified NX | XX | GT | LT condition was not met.
1 if the expiration time was set or updated.
2 if the field was deleted because the specified expiration time is in the past.
- Return type
Returns a list which contains for each field in the request
- hpexpiretime(key, *fields)#
Returns the expiration times of hash fields as Unix timestamps in milliseconds.
For more information, see https://redis.io/commands/hpexpiretime
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the expiration time.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the expiration Unix timestamp in milliseconds, if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hpttl(key, *fields)#
Returns the TTL (Time To Live) in milliseconds for each specified field within a hash key.
For more information, see https://redis.io/commands/hpttl
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the TTL.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the TTL in milliseconds if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hrandfield(key, count=None, withvalues=False)#
Return a random field from the hash value stored at key.
count: if the argument is positive, return an array of distinct fields. If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count. withvalues: The optional WITHVALUES modifier changes the reply so it includes the respective values of the randomly selected hash fields.
For more information see https://redis.io/commands/hrandfield
- Parameters
key (str) –
count (Optional[int]) –
withvalues (bool) –
- Return type
Union[Awaitable[Any], Any]
- hscan(name, cursor=0, match=None, count=None, no_values=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 returnsno_values
indicates to return only the keys, without values.For more information see https://redis.io/commands/hscan
- Parameters
name (Union[bytes, str, memoryview]) –
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
no_values (Optional[bool]) –
- Return type
Union[Awaitable[Any], Any]
- hscan_iter(name, match=None, count=None, no_values=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 returnsno_values
indicates to return only the keys, without values- Parameters
name (str) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
no_values (Optional[bool]) –
- Return type
Iterator
- hset(name, key=None, value=None, mapping=None, items=None)#
Set
key
tovalue
within hashname
,mapping
accepts a dict of key/value pairs that will be added to hashname
.items
accepts a list of key/value pairs that will be added to hashname
. Returns the number of fields that were added.For more information see https://redis.io/commands/hset
- Parameters
name (str) –
key (Optional[str]) –
value (Optional[str]) –
mapping (Optional[dict]) –
items (Optional[list]) –
- Return type
Union[Awaitable[int], int]
- hsetnx(name, key, value)#
Set
key
tovalue
within hashname
ifkey
does not exist. Returns 1 if HSETNX created a field, otherwise 0.For more information see https://redis.io/commands/hsetnx
- Parameters
name (str) –
key (str) –
value (str) –
- Return type
Union[Awaitable[bool], bool]
- hstrlen(name, key)#
Return the number of bytes stored in the value of
key
within hashname
For more information see https://redis.io/commands/hstrlen
- Parameters
name (str) –
key (str) –
- Return type
Union[Awaitable[int], int]
- httl(key, *fields)#
Returns the TTL (Time To Live) in seconds for each specified field within a hash key.
For more information, see https://redis.io/commands/httl
- Parameters
key (Union[bytes, str, memoryview]) – The hash key.
fields (str) – A list of fields within the hash for which to get the TTL.
- Returns
-2 if the field does not exist, or if the key does not exist.
-1 if the field exists but has no associated expire time.
A positive integer representing the TTL in seconds if the field has an associated expiration time.
- Return type
Returns a list which contains for each field in the request
- hvals(name)#
Return the list of values within hash
name
For more information see https://redis.io/commands/hvals
- Parameters
name (str) –
- Return type
Union[Awaitable[List], List]
- incr(name, amount=1)#
Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- incrby(name, amount=1)#
Increments the value of
key
byamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrby
- Parameters
name (Union[bytes, str, memoryview]) –
amount (int) –
- Return type
Union[Awaitable[Any], Any]
- incrbyfloat(name, amount=1.0)#
Increments the value at key
name
by floatingamount
. If no key exists, the value will be initialized asamount
For more information see https://redis.io/commands/incrbyfloat
- Parameters
name (Union[bytes, str, memoryview]) –
amount (float) –
- Return type
Union[Awaitable[Any], Any]
- info(section=None, *args, **kwargs)#
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
For more information see https://redis.io/commands/info
- Parameters
section (Optional[str]) –
args (List[str]) –
- Return type
Union[Awaitable[Any], Any]
- json(encoder=<json.encoder.JSONEncoder object>, decoder=<json.decoder.JSONDecoder object>)#
Access the json namespace, providing support for redis json.
- keys(pattern='*', **kwargs)#
Returns a list of keys matching
pattern
For more information see https://redis.io/commands/keys
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- lastsave(**kwargs)#
Return a Python datetime object representing the last time the Redis database was saved to disk
For more information see https://redis.io/commands/lastsave
- Return type
Union[Awaitable[Any], Any]
- latency_doctor()#
Raise a NotImplementedError, as the client will not support LATENCY DOCTOR. This funcion is best used within the redis-cli.
For more information see https://redis.io/commands/latency-doctor
- latency_graph()#
Raise a NotImplementedError, as the client will not support LATENCY GRAPH. This funcion is best used within the redis-cli.
For more information see https://redis.io/commands/latency-graph.
- latency_histogram(*args)#
This function throws a NotImplementedError since it is intentionally not supported.
- latency_history(event)#
Returns the raw data of the
event
’s latency spikes time series.For more information see https://redis.io/commands/latency-history
- Parameters
event (str) –
- Return type
Union[Awaitable[Any], Any]
- latency_latest()#
Reports the latest latency events logged.
For more information see https://redis.io/commands/latency-latest
- Return type
Union[Awaitable[Any], Any]
- latency_reset(*events)#
Resets the latency spikes time series of all, or only some, events.
For more information see https://redis.io/commands/latency-reset
- Parameters
events (str) –
- Return type
Union[Awaitable[Any], Any]
- lcs(key1, key2, len=False, idx=False, minmatchlen=0, withmatchlen=False)#
Find the longest common subsequence between
key1
andkey2
. Iflen
is true the length of the match will will be returned. Ifidx
is true the match position in each strings will be returned.minmatchlen
restrict the list of matches to the ones of the givenminmatchlen
. Ifwithmatchlen
the length of the match also will be returned. For more information see https://redis.io/commands/lcs- Parameters
key1 (str) –
key2 (str) –
len (Optional[bool]) –
idx (Optional[bool]) –
minmatchlen (Optional[int]) –
withmatchlen (Optional[bool]) –
- Return type
Union[str, int, list]
- 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
For more information see https://redis.io/commands/lindex
- Parameters
name (str) –
index (int) –
- Return type
Optional[Union[Awaitable[Optional[str]], str]]
- 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.For more information see https://redis.io/commands/linsert
- Parameters
name (str) –
where (str) –
refvalue (str) –
value (str) –
- Return type
Union[Awaitable[int], int]
- llen(name)#
Return the length of the list
name
For more information see https://redis.io/commands/llen
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- lmove(first_list, second_list, src='LEFT', dest='RIGHT')#
Atomically returns and removes the first/last element of a list, pushing it as the first/last element on the destination list. Returns the element being popped and pushed.
For more information see https://redis.io/commands/lmove
- Parameters
first_list (str) –
second_list (str) –
src (str) –
dest (str) –
- Return type
Union[Awaitable[Any], Any]
- lmpop(num_keys, *args, direction, count=1)#
Pop
count
values (default 1) first non-empty list key from the list of args provided key names.For more information see https://redis.io/commands/lmpop
- Parameters
num_keys (int) –
args (List[str]) –
direction (str) –
count (Optional[int]) –
- Return type
Union[Awaitable[list], list]
- lolwut(*version_numbers, **kwargs)#
Get the Redis version and a piece of generative computer art
See: https://redis.io/commands/lolwut
- Parameters
version_numbers (Union[str, float]) –
- Return type
Union[Awaitable[Any], Any]
- lpop(name, count=None)#
Removes and returns the first elements of the list
name
.By default, the command pops a single element from the beginning of the list. When provided with the optional
count
argument, the reply will consist of up to count elements, depending on the list’s length.For more information see https://redis.io/commands/lpop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[Union[str, List]]], str, List]]
- lpos(name, value, rank=None, count=None, maxlen=None)#
Get position of
value
within the listname
If specified,
rank
indicates the “rank” of the first element to return in case there are multiple copies ofvalue
in the list. By default, LPOS returns the position of the first occurrence ofvalue
in the list. Whenrank
2, LPOS returns the position of the secondvalue
in the list. Ifrank
is negative, LPOS searches the list in reverse. For example, -1 would return the position of the last occurrence ofvalue
and -2 would return the position of the next to last occurrence ofvalue
.If specified,
count
indicates that LPOS should return a list of up tocount
positions. Acount
of 2 would return a list of up to 2 positions. Acount
of 0 returns a list of all positions matchingvalue
. Whencount
is specified and butvalue
does not exist in the list, an empty list is returned.If specified,
maxlen
indicates the maximum number of list elements to scan. Amaxlen
of 1000 will only return the position(s) of items within the first 1000 entries in the list. Amaxlen
of 0 (the default) will scan the entire list.For more information see https://redis.io/commands/lpos
- Parameters
name (str) –
value (str) –
rank (Optional[int]) –
count (Optional[int]) –
maxlen (Optional[int]) –
- Return type
Optional[Union[str, List]]
- lpush(name, *values)#
Push
values
onto the head of the listname
For more information see https://redis.io/commands/lpush
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- lpushx(name, *values)#
Push
value
onto the head of the listname
ifname
existsFor more information see https://redis.io/commands/lpushx
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- lrange(name, start, end)#
Return a slice of the list
name
between positionstart
andend
start
andend
can be negative numbers just like Python slicing notationFor more information see https://redis.io/commands/lrange
- Parameters
name (str) –
start (int) –
end (int) –
- Return type
Union[Awaitable[list], list]
- lrem(name, count, value)#
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.
For more information see https://redis.io/commands/lrem
- Parameters
name (str) –
count (int) –
value (str) –
- Return type
Union[Awaitable[int], int]
- lset(name, index, value)#
Set element at
index
of listname
tovalue
For more information see https://redis.io/commands/lset
- Parameters
name (str) –
index (int) –
value (str) –
- Return type
Union[Awaitable[str], str]
- 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 notationFor more information see https://redis.io/commands/ltrim
- Parameters
name (str) –
start (int) –
end (int) –
- Return type
Union[Awaitable[str], str]
- memory_malloc_stats(**kwargs)#
Return an internal statistics report from the memory allocator.
See: https://redis.io/commands/memory-malloc-stats
- Return type
Union[Awaitable[Any], Any]
- memory_purge(**kwargs)#
Attempts to purge dirty pages for reclamation by allocator
For more information see https://redis.io/commands/memory-purge
- Return type
Union[Awaitable[Any], Any]
- memory_stats(**kwargs)#
Return a dictionary of memory stats
For more information see https://redis.io/commands/memory-stats
- Return type
Union[Awaitable[Any], Any]
- memory_usage(key, samples=None, **kwargs)#
Return the total memory usage for key, its value and associated administrative overheads.
For nested data structures,
samples
is the number of elements to sample. If left unspecified, the server’s default is 5. Use 0 to sample all elements.For more information see https://redis.io/commands/memory-usage
- Parameters
key (Union[bytes, str, memoryview]) –
samples (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- mget(keys, *args)#
Returns a list of values ordered identically to
keys
For more information see https://redis.io/commands/mget
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
args (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- mget_nonatomic(keys, *args)#
Splits the keys into different slots and then calls MGET for the keys of every slot. This operation will not be atomic if keys belong to more than one slot.
Returns a list of values ordered identically to
keys
For more information see https://redis.io/commands/mget
- Parameters
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
args (Union[bytes, str, memoryview]) –
- Return type
List[Optional[Any]]
- migrate(host, port, keys, destination_db, timeout, copy=False, replace=False, auth=None, **kwargs)#
Migrate 1 or more keys from the current Redis server to a different server specified by the
host
,port
anddestination_db
.The
timeout
, specified in milliseconds, indicates the maximum time the connection between the two servers can be idle before the command is interrupted.If
copy
is True, the specifiedkeys
are NOT deleted from the source server.If
replace
is True, this operation will overwrite the keys on the destination server if they exist.If
auth
is specified, authenticate to the destination server with the password provided.For more information see https://redis.io/commands/migrate
- Parameters
host (str) –
port (int) –
keys (Union[bytes, str, memoryview, Iterable[Union[bytes, str, memoryview]]]) –
destination_db (int) –
timeout (int) –
copy (bool) –
replace (bool) –
auth (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- module_list()#
Returns a list of dictionaries containing the name and version of all loaded modules.
For more information see https://redis.io/commands/module-list
- Return type
Union[Awaitable[Any], Any]
- module_load(path, *args)#
Loads the module from
path
. Passes all*args
to the module, during loading. RaisesModuleError
if a module is not found atpath
.For more information see https://redis.io/commands/module-load
- Return type
Union[Awaitable[Any], Any]
- module_loadex(path, options=None, args=None)#
Loads a module from a dynamic library at runtime with configuration directives.
For more information see https://redis.io/commands/module-loadex
- Parameters
path (str) –
options (Optional[List[str]]) –
args (Optional[List[str]]) –
- Return type
Union[Awaitable[Any], Any]
- module_unload(name)#
Unloads the module
name
. RaisesModuleError
ifname
is not in loaded modules.For more information see https://redis.io/commands/module-unload
- Return type
Union[Awaitable[Any], Any]
- move(name, db)#
Moves the key
name
to a different Redis databasedb
For more information see https://redis.io/commands/move
- Parameters
name (Union[bytes, str, memoryview]) –
db (int) –
- Return type
Union[Awaitable[Any], Any]
- mset(mapping)#
Sets key/values based on a mapping. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str().
For more information see https://redis.io/commands/mset
- Parameters
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- mset_nonatomic(mapping)#
Sets key/values based on a mapping. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str().
Splits the keys into different slots and then calls MSET for the keys of every slot. This operation will not be atomic if keys belong to more than one slot.
For more information see https://redis.io/commands/mset
- Parameters
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
- Return type
List[bool]
- msetnx(mapping)#
Sets key/values based on a mapping if none of the keys are already set. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str(). Returns a boolean indicating if the operation was successful.
For more information see https://redis.io/commands/msetnx
- Parameters
mapping (Mapping[AnyKeyT, Union[bytes, memoryview, str, int, float]]) –
- Return type
Union[Awaitable[Any], Any]
- object(infotype, key, **kwargs)#
Return the encoding, idletime, or refcount about the key
- Parameters
infotype (str) –
key (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- persist(name)#
Removes an expiration on
name
For more information see https://redis.io/commands/persist
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pexpire(name, time, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
fortime
milliseconds with givenoption
.time
can be represented by an integer or a Python timedelta object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpire
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- pexpireat(name, when, nx=False, xx=False, gt=False, lt=False)#
Set an expire flag on key
name
with givenoption
.when
can be represented as an integer representing unix time in milliseconds (unix time * 1000) or a Python datetime object.- Valid options are:
NX -> Set expiry only when the key has no expiry XX -> Set expiry only when the key has an existing expiry GT -> Set expiry only when the new expiry is greater than current one LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpireat
- Parameters
name (Union[bytes, str, memoryview]) –
when (Union[int, datetime]) –
nx (bool) –
xx (bool) –
gt (bool) –
lt (bool) –
- Return type
Union[Awaitable[Any], Any]
- pexpiretime(key)#
Returns the absolute Unix timestamp (since January 1, 1970) in milliseconds at which the given key will expire.
For more information see https://redis.io/commands/pexpiretime
- Parameters
key (str) –
- Return type
int
- pfadd(name, *values)#
Adds the specified elements to the specified HyperLogLog.
For more information see https://redis.io/commands/pfadd
- Parameters
name (Union[bytes, str, memoryview]) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- pfcount(*sources)#
Return the approximated cardinality of the set observed by the HyperLogLog at key(s).
For more information see https://redis.io/commands/pfcount
- Parameters
sources (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pfmerge(dest, *sources)#
Merge N different HyperLogLogs into a single one.
For more information see https://redis.io/commands/pfmerge
- Parameters
dest (Union[bytes, str, memoryview]) –
sources (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- ping(**kwargs)#
Ping the Redis server
For more information see https://redis.io/commands/ping
- Return type
Union[Awaitable[Any], Any]
- 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 objectFor more information see https://redis.io/commands/psetex
- Parameters
name (Union[bytes, str, memoryview]) –
time_ms (Union[int, timedelta]) –
value (Union[bytes, memoryview, str, int, float]) –
- psync(replicationid, offset)#
Initiates a replication stream from the master. Newer version for sync.
For more information see https://redis.io/commands/sync
- Parameters
replicationid (str) –
offset (int) –
- pttl(name)#
Returns the number of milliseconds until the key
name
will expireFor more information see https://redis.io/commands/pttl
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- publish(channel, message, **kwargs)#
Publish
message
onchannel
. Returns the number of subscribers the message was delivered to.For more information see https://redis.io/commands/publish
- Parameters
channel (Union[bytes, str, memoryview]) –
message (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_channels(pattern='*', **kwargs)#
Return a list of channels that have at least one subscriber
For more information see https://redis.io/commands/pubsub-channels
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_numpat(**kwargs)#
Returns the number of subscriptions to patterns
For more information see https://redis.io/commands/pubsub-numpat
- Return type
Union[Awaitable[Any], Any]
- pubsub_numsub(*args, **kwargs)#
Return a list of (channel, number of subscribers) tuples for each channel given in
*args
For more information see https://redis.io/commands/pubsub-numsub
- Parameters
args (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_shardchannels(pattern='*', **kwargs)#
Return a list of shard_channels that have at least one subscriber
For more information see https://redis.io/commands/pubsub-shardchannels
- Parameters
pattern (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- pubsub_shardnumsub(*args, **kwargs)#
Return a list of (shard_channel, number of subscribers) tuples for each channel given in
*args
For more information see https://redis.io/commands/pubsub-shardnumsub
- Parameters
args (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- quit(**kwargs)#
Ask the server to close the connection.
For more information see https://redis.io/commands/quit
- Return type
Union[Awaitable[Any], Any]
- randomkey(**kwargs)#
Returns the name of a random key
For more information see https://redis.io/commands/randomkey
- Return type
Union[Awaitable[Any], Any]
- readonly(target_nodes=None)#
Enables read queries. The command will be sent to the default cluster node if target_nodes is not specified.
For more information see https://redis.io/commands/readonly
- Parameters
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- readwrite(target_nodes=None)#
Disables read queries. The command will be sent to the default cluster node if target_nodes is not specified.
For more information see https://redis.io/commands/readwrite
- Parameters
target_nodes (Optional[TargetNodesT]) –
- Return type
Union[Awaitable[Any], Any]
- 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.- Parameters
self (redis.client.Redis) –
script (Union[bytes, str, memoryview]) –
- Return type
Script
- rename(src, dst)#
Rename key
src
todst
For more information see https://redis.io/commands/rename
- Parameters
src (Union[bytes, str, memoryview]) –
dst (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- renamenx(src, dst)#
Rename key
src
todst
ifdst
doesn’t already existFor more information see https://redis.io/commands/renamenx
- Parameters
src (Union[bytes, str, memoryview]) –
dst (Union[bytes, str, memoryview]) –
- replicaof(*args, **kwargs)#
Make the server a replica of another instance, or promote it as master.
For more information see https://redis.io/commands/replicaof
- Return type
NoReturn
- reset()#
Perform a full reset on the connection’s server side contenxt.
See: https://redis.io/commands/reset
- Return type
Union[Awaitable[Any], Any]
- restore(name, ttl, value, replace=False, absttl=False, idletime=None, frequency=None)#
Create a key using the provided serialized value, previously obtained using DUMP.
replace
allows an existing key onname
to be overridden. If it’s not specified an error is raised on collision.absttl
if True, specifiedttl
should represent an absolute Unix timestamp in milliseconds in which the key will expire. (Redis 5.0 or greater).idletime
Used for eviction, this is the number of seconds the key must be idle, prior to execution.frequency
Used for eviction, this is the frequency counter of the object stored at the key, prior to execution.For more information see https://redis.io/commands/restore
- Parameters
name (Union[bytes, str, memoryview]) –
ttl (float) –
value (Union[bytes, memoryview, str, int, float]) –
replace (bool) –
absttl (bool) –
idletime (Optional[int]) –
frequency (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- role()#
Provide information on the role of a Redis instance in the context of replication, by returning if the instance is currently a master, slave, or sentinel.
For more information see https://redis.io/commands/role
- Return type
Union[Awaitable[Any], Any]
- rpop(name, count=None)#
Removes and returns the last elements of the list
name
.By default, the command pops a single element from the end of the list. When provided with the optional
count
argument, the reply will consist of up to count elements, depending on the list’s length.For more information see https://redis.io/commands/rpop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[Awaitable[Optional[Union[str, List]]], str, List]]
- rpoplpush(src, dst)#
RPOP a value off of the
src
list and atomically LPUSH it on to thedst
list. Returns the value.For more information see https://redis.io/commands/rpoplpush
- Parameters
src (str) –
dst (str) –
- Return type
Union[Awaitable[str], str]
- rpush(name, *values)#
Push
values
onto the tail of the listname
For more information see https://redis.io/commands/rpush
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- rpushx(name, *values)#
Push
value
onto the tail of the listname
ifname
existsFor more information see https://redis.io/commands/rpushx
- Parameters
name (str) –
values (str) –
- Return type
Union[Awaitable[int], int]
- sadd(name, *values)#
Add
value(s)
to setname
For more information see https://redis.io/commands/sadd
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- save(**kwargs)#
Tell the Redis server to save its data to disk, blocking until the save is complete
For more information see https://redis.io/commands/save
- Return type
Union[Awaitable[Any], Any]
- scan(cursor=0, match=None, count=None, _type=None, **kwargs)#
Incrementally return lists of key names. Also return a cursor indicating the scan position.
match
allows for filtering the keys by patterncount
provides a hint to Redis about the number of keys toreturn per batch.
_type
filters the returned values by a particular Redis type.Stock Redis instances allow for the following types: HASH, LIST, SET, STREAM, STRING, ZSET Additionally, Redis modules can expose other types as well.
For more information see https://redis.io/commands/scan
- Parameters
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
_type (Optional[str]) –
- Return type
Union[Awaitable[Any], Any]
- scan_iter(match=None, count=None, _type=None, **kwargs)#
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
provides a hint to Redis about the number of keys toreturn per batch.
_type
filters the returned values by a particular Redis type.Stock Redis instances allow for the following types: HASH, LIST, SET, STREAM, STRING, ZSET Additionally, Redis modules can expose other types as well.
- Parameters
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
_type (Optional[str]) –
- Return type
Iterator
- scard(name)#
Return the number of elements in set
name
For more information see https://redis.io/commands/scard
- Parameters
name (str) –
- Return type
Union[Awaitable[int], int]
- 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_data.For more information see https://redis.io/commands/script-exists
- Parameters
args (str) –
- Return type
Union[Awaitable[Any], Any]
- script_flush(sync_type=None)#
Flush all scripts from the script cache_data.
sync_type
is by default SYNC (synchronous) but it can also beASYNC.
For more information see https://redis.io/commands/script-flush
- Parameters
sync_type (Optional[Union[Literal['SYNC'], ~typing.Literal['ASYNC']]]) –
- Return type
Union[Awaitable[Any], Any]
- script_kill()#
Kill the currently executing Lua script
For more information see https://redis.io/commands/script-kill
- Return type
Union[Awaitable[Any], Any]
- script_load(script)#
Load a Lua
script
into the script cache_data. Returns the SHA.For more information see https://redis.io/commands/script-load
- Parameters
script (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- sdiff(keys, *args)#
Return the difference of sets specified by
keys
For more information see https://redis.io/commands/sdiff
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[list], list]
- 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.For more information see https://redis.io/commands/sdiffstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- select(index, **kwargs)#
Select the Redis logical database at index.
See: https://redis.io/commands/select
- Parameters
index (int) –
- Return type
Union[Awaitable[Any], Any]
- set(name, value, ex=None, px=None, nx=False, xx=False, keepttl=False, get=False, exat=None, pxat=None)#
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
onlyif it does not exist.
xx
if set to True, set the value at keyname
tovalue
onlyif it already exists.
keepttl
if True, retain the time to live associated with the key.(Available since Redis 6.0)
get
if True, set the value at keyname
tovalue
and returnthe old value stored at key, or None if the key did not exist. (Available since Redis 6.2)
exat
sets an expire flag on keyname
forex
seconds,specified in unix time.
pxat
sets an expire flag on keyname
forex
milliseconds,specified in unix time.
For more information see https://redis.io/commands/set
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
ex (Optional[Union[int, timedelta]]) –
px (Optional[Union[int, timedelta]]) –
nx (bool) –
xx (bool) –
keepttl (bool) –
get (bool) –
exat (Optional[Union[int, datetime]]) –
pxat (Optional[Union[int, datetime]]) –
- Return type
Union[Awaitable[Any], Any]
- setbit(name, offset, value)#
Flag the
offset
inname
asvalue
. Returns an integer indicating the previous value ofoffset
.For more information see https://redis.io/commands/setbit
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
value (int) –
- Return type
Union[Awaitable[Any], Any]
- setex(name, time, value)#
Set the value of key
name
tovalue
that expires intime
seconds.time
can be represented by an integer or a Python timedelta object.For more information see https://redis.io/commands/setex
- Parameters
name (Union[bytes, str, memoryview]) –
time (Union[int, timedelta]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- setnx(name, value)#
Set the value of key
name
tovalue
if key doesn’t existFor more information see https://redis.io/commands/setnx
- Parameters
name (Union[bytes, str, memoryview]) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- 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.
For more information see https://redis.io/commands/setrange
- Parameters
name (Union[bytes, str, memoryview]) –
offset (int) –
value (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- shutdown(save=False, nosave=False, now=False, force=False, abort=False, **kwargs)#
Shutdown the Redis server. If Redis has persistence configured, data will be flushed before shutdown. It is possible to specify modifiers to alter the behavior of the command:
save
will force a DB saving operation even if no save points are configured.nosave
will prevent a DB saving operation even if one or more save points are configured.now
skips waiting for lagging replicas, i.e. it bypasses the first step in the shutdown sequence.force
ignores any errors that would normally prevent the server from exitingabort
cancels an ongoing shutdown and cannot be combined with other flags.For more information see https://redis.io/commands/shutdown
- Parameters
save (bool) –
nosave (bool) –
now (bool) –
force (bool) –
abort (bool) –
- Return type
None
- sinter(keys, *args)#
Return the intersection of sets specified by
keys
For more information see https://redis.io/commands/sinter
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[list], list]
- sintercard(numkeys, keys, limit=0)#
Return the cardinality of the intersect of multiple sets specified by
keys
.When LIMIT provided (defaults to 0 and means unlimited), if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality
For more information see https://redis.io/commands/sintercard
- Parameters
numkeys (int) –
keys (List[str]) –
limit (int) –
- Return type
Union[Awaitable[int], int]
- 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.For more information see https://redis.io/commands/sinterstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- sismember(name, value)#
Return whether
value
is a member of setname
: - 1 if the value is a member of the set. - 0 if the value is not a member of the set or if key does not exist.For more information see https://redis.io/commands/sismember
- Parameters
name (str) –
value (str) –
- Return type
Union[Awaitable[Union[Literal[0], ~typing.Literal[1]]], ~typing.Literal[0], ~typing.Literal[1]]
- slaveof(*args, **kwargs)#
Make the server a replica of another instance, or promote it as master.
For more information see https://redis.io/commands/slaveof
- Return type
NoReturn
- slowlog_get(num=None, **kwargs)#
Get the entries from the slowlog. If
num
is specified, get the most recentnum
items.For more information see https://redis.io/commands/slowlog-get
- Parameters
num (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- slowlog_len(**kwargs)#
Get the number of items in the slowlog
For more information see https://redis.io/commands/slowlog-len
- Return type
Union[Awaitable[Any], Any]
- slowlog_reset(**kwargs)#
Remove all items in the slowlog
For more information see https://redis.io/commands/slowlog-reset
- Return type
Union[Awaitable[Any], Any]
- smembers(name)#
Return all members of the set
name
For more information see https://redis.io/commands/smembers
- Parameters
name (str) –
- Return type
Union[Awaitable[Set], Set]
- smismember(name, values, *args)#
Return whether each value in
values
is a member of the setname
as a list ofint
in the order ofvalues
: - 1 if the value is a member of the set. - 0 if the value is not a member of the set or if key does not exist.For more information see https://redis.io/commands/smismember
- Parameters
name (str) –
values (List) –
args (List) –
- Return type
Union[Awaitable[List[Union[Literal[0], ~typing.Literal[1]]]], ~typing.List[~typing.Union[~typing.Literal[0], ~typing.Literal[1]]]]
- smove(src, dst, value)#
Move
value
from setsrc
to setdst
atomicallyFor more information see https://redis.io/commands/smove
- Parameters
src (str) –
dst (str) –
value (str) –
- Return type
Union[Awaitable[bool], bool]
- 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 thesorted data itself. Use an “*” to indicate where in the 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 intothe key
store
groups
if set to True and ifget
contains at least twoelements, sort will return a list of tuples, each containing the values fetched from the arguments to
get
.
For more information see https://redis.io/commands/sort
- Parameters
name (str) –
start (Optional[int]) –
num (Optional[int]) –
by (Optional[str]) –
get (Optional[List[str]]) –
desc (bool) –
alpha (bool) –
store (Optional[str]) –
groups (Optional[bool]) –
- Return type
Union[List, int]
- sort_ro(key, start=None, num=None, by=None, get=None, desc=False, alpha=False)#
Returns the elements contained in the list, set or sorted set at key. (read-only variant of the SORT command)
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 thesorted data itself. Use an “*” to indicate where in the key the item value is located
desc
allows for reversing the sortalpha
allows for sorting lexicographically rather than numericallyFor more information see https://redis.io/commands/sort_ro
- Parameters
key (str) –
start (Optional[int]) –
num (Optional[int]) –
by (Optional[str]) –
get (Optional[List[str]]) –
desc (bool) –
alpha (bool) –
- Return type
list
- spop(name, count=None)#
Remove and return a random member of set
name
For more information see https://redis.io/commands/spop
- Parameters
name (str) –
count (Optional[int]) –
- Return type
Optional[Union[str, List]]
- spublish(shard_channel, message)#
Posts a message to the given shard channel. Returns the number of clients that received the message
For more information see https://redis.io/commands/spublish
- Parameters
shard_channel (Union[bytes, str, memoryview]) –
message (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[Any], Any]
- srandmember(name, number=None)#
If
number
is None, returns a random member of setname
.If
number
is supplied, returns a list ofnumber
random members of setname
. Note this is only available when running Redis 2.6+.For more information see https://redis.io/commands/srandmember
- Parameters
name (str) –
number (Optional[int]) –
- Return type
Optional[Union[str, List]]
- srem(name, *values)#
Remove
values
from setname
For more information see https://redis.io/commands/srem
- Parameters
name (str) –
values (Union[bytes, memoryview, str, int, float]) –
- Return type
Union[Awaitable[int], int]
- 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 returnsFor more information see https://redis.io/commands/sscan
- Parameters
name (Union[bytes, str, memoryview]) –
cursor (int) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
- Return type
Union[Awaitable[Any], Any]
- 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- Parameters
name (Union[bytes, str, memoryview]) –
match (Optional[Union[bytes, str, memoryview]]) –
count (Optional[int]) –
- Return type
Iterator
- stralgo(algo, value1, value2, specific_argument='strings', len=False, idx=False, minmatchlen=None, withmatchlen=False, **kwargs)#
Implements complex algorithms that operate on strings. Right now the only algorithm implemented is the LCS algorithm (longest common substring). However new algorithms could be implemented in the future.
algo
Right now must be LCSvalue1
andvalue2
Can be two strings or two keysspecific_argument
Specifying if the arguments to the algorithm will be keys or strings. strings is the default.len
Returns just the len of the match.idx
Returns the match positions in each string.minmatchlen
Restrict the list of matches to the ones of a given minimal length. Can be provided only whenidx
set to True.withmatchlen
Returns the matches with the len of the match. Can be provided only whenidx
set to True.For more information see https://redis.io/commands/stralgo
- Parameters
algo (Literal['LCS']) –
value1 (Union[bytes, str, memoryview]) –
value2 (Union[bytes, str, memoryview]) –
specific_argument (Union[Literal['strings'], ~typing.Literal['keys']]) –
len (bool) –
idx (bool) –
minmatchlen (Optional[int]) –
withmatchlen (bool) –
- Return type
Union[Awaitable[Any], Any]
- strlen(name)#
Return the number of bytes stored in the value of
name
For more information see https://redis.io/commands/strlen
- Parameters
name (Union[bytes, str, memoryview]) –
- Return type
Union[Awaitable[Any], Any]
- 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.- Parameters
name (Union[bytes, str, memoryview]) –
start (int) –
end (int) –
- Return type
Union[Awaitable[Any], Any]
- sunion(keys, *args)#
Return the union of sets specified by
keys
For more information see https://redis.io/commands/sunion
- Parameters
keys (List) –
args (List) –
- Return type
Union[Awaitable[List], List]
- 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.For more information see https://redis.io/commands/sunionstore
- Parameters
dest (str) –
keys (List) –
args (List) –
- Return type
Union[Awaitable[int], int]
- swapdb(*args, **kwargs)#
Swaps two Redis databases.
For more information see https://redis.io/commands/swapdb
- Return type
NoReturn
- sync()#
Initiates a replication stream from the master.
For more information see https://redis.io/commands/sync
- Return type
Union[Awaitable[Any], Any]
- tdigest()#
Access the bloom namespace.
- tfcall(lib_name, func_name, keys=None, *args)#
Invoke a function.
lib_name
- the library name contains the function.func_name
- the function name to run.keys
- the keys that will be touched by the function.args
- Additional argument to pass to the function.For more information see https://redis.io/commands/tfc