Net::Async::Redis::Commands - mixin that defines the Redis commands available
This is autogenerated from the list of commands available in https://redis.io/commands.
It is intended to be loaded by Net::Async::Redis to provide methods for each available Redis command.
Assign new hash slots to receiving node.
slot [slot ...]
https://redis.io/commands/cluster-addslots
Return the number of failure reports active for a given node.
node-id
https://redis.io/commands/cluster-count-failure-reports
Return the number of local keys in the specified hash slot.
slot
https://redis.io/commands/cluster-countkeysinslot
Set hash slots as unbound in receiving node.
https://redis.io/commands/cluster-delslots
Forces a replica to perform a manual failover of its master.
[FORCE|TAKEOVER]
https://redis.io/commands/cluster-failover
Remove a node from the nodes table.
https://redis.io/commands/cluster-forget
Return local key names in the specified hash slot.
count
https://redis.io/commands/cluster-getkeysinslot
Provides info about Redis Cluster node state.
https://redis.io/commands/cluster-info
Returns the hash slot of the specified key.
key
https://redis.io/commands/cluster-keyslot
Force a node cluster to handshake with another node.
ip
port
https://redis.io/commands/cluster-meet
Get Cluster config for the node.
https://redis.io/commands/cluster-nodes
Reconfigure a node as a replica of the specified master node.
https://redis.io/commands/cluster-replicate
Reset a Redis Cluster node.
[HARD|SOFT]
https://redis.io/commands/cluster-reset
Forces the node to save cluster state on disk.
https://redis.io/commands/cluster-saveconfig
Set the configuration epoch in a new node.
config-epoch
https://redis.io/commands/cluster-set-config-epoch
Bind a hash slot to a specific node.
IMPORTING|MIGRATING|STABLE|NODE
[node-id]
https://redis.io/commands/cluster-setslot
List replica nodes of the specified master node.
https://redis.io/commands/cluster-slaves
https://redis.io/commands/cluster-replicas
Get array of Cluster slot to node mappings.
https://redis.io/commands/cluster-slots
Enables read queries for a connection to a cluster replica node.
https://redis.io/commands/readonly
Disables read queries for a connection to a cluster replica node.
https://redis.io/commands/readwrite
Authenticate to the server.
password
https://redis.io/commands/auth
Echo the given string.
message
https://redis.io/commands/echo
Ping the server.
[message]
https://redis.io/commands/ping
Close the connection.
https://redis.io/commands/quit
Change the selected database for the current connection.
index
https://redis.io/commands/select
Swaps two Redis databases.
https://redis.io/commands/swapdb
Delete a key.
key [key ...]
https://redis.io/commands/del
Return a serialized version of the value stored at the specified key.
https://redis.io/commands/dump
Determine if a key exists.
https://redis.io/commands/exists
Set a key's time to live in seconds.
seconds
https://redis.io/commands/expire
Set the expiration for a key as a UNIX timestamp.
timestamp
https://redis.io/commands/expireat
Find all keys matching the given pattern.
pattern
https://redis.io/commands/keys
Atomically transfer a key from a Redis instance to another one.
host
key|""
destination-db
timeout
[COPY]
[REPLACE]
[KEYS key [key ...]]
https://redis.io/commands/migrate
Move a key to another database.
db
https://redis.io/commands/move
Inspect the internals of Redis objects.
subcommand
[arguments [arguments ...]]
https://redis.io/commands/object
Remove the expiration from a key.
https://redis.io/commands/persist
Set a key's time to live in milliseconds.
milliseconds
https://redis.io/commands/pexpire
Set the expiration for a key as a UNIX timestamp specified in milliseconds.
milliseconds-timestamp
https://redis.io/commands/pexpireat
Get the time to live for a key in milliseconds.
https://redis.io/commands/pttl
Return a random key from the keyspace.
https://redis.io/commands/randomkey
Rename a key.
newkey
https://redis.io/commands/rename
Rename a key, only if the new key does not exist.
https://redis.io/commands/renamenx
Create a key using the provided serialized value, previously obtained using DUMP.
ttl
serialized-value
https://redis.io/commands/restore
Sort the elements in a list, set or sorted set.
[BY pattern]
[LIMIT offset count]
[GET pattern [GET pattern ...]]
[ASC|DESC]
[ALPHA]
[STORE destination]
https://redis.io/commands/sort
Alters the last access time of a key(s). Returns the number of existing keys specified.
https://redis.io/commands/touch
Get the time to live for a key.
https://redis.io/commands/ttl
Determine the type stored at key.
https://redis.io/commands/type
Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
https://redis.io/commands/unlink
Wait for the synchronous replication of all the write commands sent in the context of the current connection.
numreplicas
https://redis.io/commands/wait
Incrementally iterate the keys space.
cursor
[MATCH pattern]
[COUNT count]
https://redis.io/commands/scan
Add one or more geospatial items in the geospatial index represented using a sorted set.
longitude latitude member [longitude latitude member ...]
https://redis.io/commands/geoadd
Returns members of a geospatial index as standard geohash strings.
member [member ...]
https://redis.io/commands/geohash
Returns longitude and latitude of members of a geospatial index.
https://redis.io/commands/geopos
Returns the distance between two members of a geospatial index.
member1
member2
[unit]
https://redis.io/commands/geodist
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point.
longitude
latitude
radius
m|km|ft|mi
[WITHCOORD]
[WITHDIST]
[WITHHASH]
[STORE key]
[STOREDIST key]
https://redis.io/commands/georadius
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member.
member
https://redis.io/commands/georadiusbymember
Delete one or more hash fields.
field [field ...]
https://redis.io/commands/hdel
Determine if a hash field exists.
field
https://redis.io/commands/hexists
Get the value of a hash field.
https://redis.io/commands/hget
Get all the fields and values in a hash.
https://redis.io/commands/hgetall
Increment the integer value of a hash field by the given number.
increment
https://redis.io/commands/hincrby
Increment the float value of a hash field by the given amount.
https://redis.io/commands/hincrbyfloat
Get all the fields in a hash.
https://redis.io/commands/hkeys
Get the number of fields in a hash.
https://redis.io/commands/hlen
Get the values of all the given hash fields.
https://redis.io/commands/hmget
Set multiple hash fields to multiple values.
field value [field value ...]
https://redis.io/commands/hmset
Set the string value of a hash field.
value
https://redis.io/commands/hset
Set the value of a hash field, only if the field does not exist.
https://redis.io/commands/hsetnx
Get the length of the value of a hash field.
https://redis.io/commands/hstrlen
Get all the values in a hash.
https://redis.io/commands/hvals
Incrementally iterate hash fields and associated values.
https://redis.io/commands/hscan
Adds the specified elements to the specified HyperLogLog.
element [element ...]
https://redis.io/commands/pfadd
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
https://redis.io/commands/pfcount
Merge N different HyperLogLogs into a single one.
destkey
sourcekey [sourcekey ...]
https://redis.io/commands/pfmerge
Remove and get the first element in a list, or block until one is available.
https://redis.io/commands/blpop
Remove and get the last element in a list, or block until one is available.
https://redis.io/commands/brpop
Pop a value from a list, push it to another list and return it; or block until one is available.
source
destination
https://redis.io/commands/brpoplpush
Get an element from a list by its index.
https://redis.io/commands/lindex
Insert an element before or after another element in a list.
BEFORE|AFTER
pivot
https://redis.io/commands/linsert
Get the length of a list.
https://redis.io/commands/llen
Remove and get the first element in a list.
https://redis.io/commands/lpop
Prepend one or multiple values to a list.
value [value ...]
https://redis.io/commands/lpush
Prepend a value to a list, only if the list exists.
https://redis.io/commands/lpushx
Get a range of elements from a list.
start
stop
https://redis.io/commands/lrange
Remove elements from a list.
https://redis.io/commands/lrem
Set the value of an element in a list by its index.
https://redis.io/commands/lset
Trim a list to the specified range.
https://redis.io/commands/ltrim
Remove and get the last element in a list.
https://redis.io/commands/rpop
Remove the last element in a list, prepend it to another list and return it.
https://redis.io/commands/rpoplpush
Append one or multiple values to a list.
https://redis.io/commands/rpush
Append a value to a list, only if the list exists.
https://redis.io/commands/rpushx
Listen for messages published to channels matching the given patterns.
pattern [pattern ...]
https://redis.io/commands/psubscribe
Inspect the state of the Pub/Sub subsystem.
[argument [argument ...]]
https://redis.io/commands/pubsub
Post a message to a channel.
channel
https://redis.io/commands/publish
Stop listening for messages posted to channels matching the given patterns.
[pattern [pattern ...]]
https://redis.io/commands/punsubscribe
Listen for messages published to the given channels.
channel [channel ...]
https://redis.io/commands/subscribe
Stop listening for messages posted to the given channels.
[channel [channel ...]]
https://redis.io/commands/unsubscribe
Execute a Lua script server side.
script
numkeys
arg [arg ...]
https://redis.io/commands/eval
sha1
https://redis.io/commands/evalsha
Set the debug mode for executed scripts.
YES|SYNC|NO
https://redis.io/commands/script-debug
Check existence of scripts in the script cache.
sha1 [sha1 ...]
https://redis.io/commands/script-exists
Remove all the scripts from the script cache.
https://redis.io/commands/script-flush
Kill the script currently in execution.
https://redis.io/commands/script-kill
Load the specified Lua script into the script cache.
https://redis.io/commands/script-load
Asynchronously rewrite the append-only file.
https://redis.io/commands/bgrewriteaof
Asynchronously save the dataset to disk.
https://redis.io/commands/bgsave
Returns the client ID for the current connection.
https://redis.io/commands/client-id
Kill the connection of a client.
[ip:port]
[ID client-id]
[TYPE normal|master|slave|pubsub]
[ADDR ip:port]
[SKIPME yes/no]
https://redis.io/commands/client-kill
Get the list of client connections.
https://redis.io/commands/client-list
Get the current connection name.
https://redis.io/commands/client-getname
Stop processing commands from clients for some time.
https://redis.io/commands/client-pause
Instruct the server whether to reply to commands.
ON|OFF|SKIP
https://redis.io/commands/client-reply
Set the current connection name.
connection-name
https://redis.io/commands/client-setname
Unblock a client blocked in a blocking command from a different connection.
client-id
[TIMEOUT|ERROR]
https://redis.io/commands/client-unblock
Get array of Redis command details.
https://redis.io/commands/command
Get total number of Redis commands.
https://redis.io/commands/command-count
Extract keys given a full Redis command.
https://redis.io/commands/command-getkeys
Get array of specific Redis command details.
command-name [command-name ...]
https://redis.io/commands/command-info
Get the value of a configuration parameter.
parameter
https://redis.io/commands/config-get
Rewrite the configuration file with the in memory configuration.
https://redis.io/commands/config-rewrite
Set a configuration parameter to the given value.
https://redis.io/commands/config-set
Reset the stats returned by INFO.
https://redis.io/commands/config-resetstat
Return the number of keys in the selected database.
https://redis.io/commands/dbsize
Get debugging information about a key.
https://redis.io/commands/debug-object
Make the server crash.
https://redis.io/commands/debug-segfault
Remove all keys from all databases.
[ASYNC]
https://redis.io/commands/flushall
Remove all keys from the current database.
https://redis.io/commands/flushdb
Get information and statistics about the server.
[section]
https://redis.io/commands/info
Get the UNIX time stamp of the last successful save to disk.
https://redis.io/commands/lastsave
Outputs memory problems report.
https://redis.io/commands/memory-doctor
Show helpful text about the different subcommands.
https://redis.io/commands/memory-help
Show allocator internal stats.
https://redis.io/commands/memory-malloc-stats
Ask the allocator to release memory.
https://redis.io/commands/memory-purge
Show memory usage details.
https://redis.io/commands/memory-stats
Estimate the memory usage of a key.
[SAMPLES count]
https://redis.io/commands/memory-usage
Listen for all requests received by the server in real time.
https://redis.io/commands/monitor
Return the role of the instance in the context of replication.
https://redis.io/commands/role
Synchronously save the dataset to disk.
https://redis.io/commands/save
Synchronously save the dataset to disk and then shut down the server.
[NOSAVE|SAVE]
https://redis.io/commands/shutdown
Make the server a replica of another instance, or promote it as master. Deprecated starting with Redis 5. Use REPLICAOF instead.
https://redis.io/commands/slaveof
Make the server a replica of another instance, or promote it as master.
https://redis.io/commands/replicaof
Manages the Redis slow queries log.
[argument]
https://redis.io/commands/slowlog
Internal command used for replication.
https://redis.io/commands/sync
Return the current server time.
https://redis.io/commands/time
Add one or more members to a set.
https://redis.io/commands/sadd
Get the number of members in a set.
https://redis.io/commands/scard
Subtract multiple sets.
https://redis.io/commands/sdiff
Subtract multiple sets and store the resulting set in a key.
https://redis.io/commands/sdiffstore
Intersect multiple sets.
https://redis.io/commands/sinter
Intersect multiple sets and store the resulting set in a key.
https://redis.io/commands/sinterstore
Determine if a given value is a member of a set.
https://redis.io/commands/sismember
Get all the members in a set.
https://redis.io/commands/smembers
Move a member from one set to another.
https://redis.io/commands/smove
Remove and return one or multiple random members from a set.
[count]
https://redis.io/commands/spop
Get one or multiple random members from a set.
https://redis.io/commands/srandmember
Remove one or more members from a set.
https://redis.io/commands/srem
Add multiple sets.
https://redis.io/commands/sunion
Add multiple sets and store the resulting set in a key.
https://redis.io/commands/sunionstore
Incrementally iterate Set elements.
https://redis.io/commands/sscan
Remove and return the member with the lowest score from one or more sorted sets, or block until one is available.
https://redis.io/commands/bzpopmin
Remove and return the member with the highest score from one or more sorted sets, or block until one is available.
https://redis.io/commands/bzpopmax
Add one or more members to a sorted set, or update its score if it already exists.
[NX|XX]
[CH]
[INCR]
score member [score member ...]
https://redis.io/commands/zadd
Get the number of members in a sorted set.
https://redis.io/commands/zcard
Count the members in a sorted set with scores within the given values.
min
max
https://redis.io/commands/zcount
Increment the score of a member in a sorted set.
https://redis.io/commands/zincrby
Intersect multiple sorted sets and store the resulting sorted set in a new key.
[WEIGHTS weight [weight ...]]
[AGGREGATE SUM|MIN|MAX]
https://redis.io/commands/zinterstore
Count the number of members in a sorted set between a given lexicographical range.
https://redis.io/commands/zlexcount
Remove and return members with the highest scores in a sorted set.
https://redis.io/commands/zpopmax
Remove and return members with the lowest scores in a sorted set.
https://redis.io/commands/zpopmin
Return a range of members in a sorted set, by index.
[WITHSCORES]
https://redis.io/commands/zrange
Return a range of members in a sorted set, by lexicographical range.
https://redis.io/commands/zrangebylex
Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.
https://redis.io/commands/zrevrangebylex
Return a range of members in a sorted set, by score.
https://redis.io/commands/zrangebyscore
Determine the index of a member in a sorted set.
https://redis.io/commands/zrank
Remove one or more members from a sorted set.
https://redis.io/commands/zrem
Remove all members in a sorted set between the given lexicographical range.
https://redis.io/commands/zremrangebylex
Remove all members in a sorted set within the given indexes.
https://redis.io/commands/zremrangebyrank
Remove all members in a sorted set within the given scores.
https://redis.io/commands/zremrangebyscore
Return a range of members in a sorted set, by index, with scores ordered from high to low.
https://redis.io/commands/zrevrange
Return a range of members in a sorted set, by score, with scores ordered from high to low.
https://redis.io/commands/zrevrangebyscore
Determine the index of a member in a sorted set, with scores ordered from high to low.
https://redis.io/commands/zrevrank
Get the score associated with the given member in a sorted set.
https://redis.io/commands/zscore
Add multiple sorted sets and store the resulting sorted set in a new key.
https://redis.io/commands/zunionstore
Incrementally iterate sorted sets elements and associated scores.
https://redis.io/commands/zscan
Get information on streams and consumer groups.
[CONSUMERS key groupname]
[GROUPS key]
[STREAM key]
[HELP]
https://redis.io/commands/xinfo
Appends a new entry to a stream.
ID
field string [field string ...]
https://redis.io/commands/xadd
Trims the stream to (approximately if '~' is passed) a certain size.
MAXLEN
[~]
https://redis.io/commands/xtrim
Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
ID [ID ...]
https://redis.io/commands/xdel
Return a range of elements in a stream, with IDs matching the specified IDs interval.
end
https://redis.io/commands/xrange
Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE.
https://redis.io/commands/xrevrange
Return the number of entires in a stream.
https://redis.io/commands/xlen
Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.
[BLOCK milliseconds]
STREAMS
https://redis.io/commands/xread
Create, destroy, and manage consumer groups.
[CREATE key groupname id-or-$]
[SETID key id-or-$]
[DESTROY key groupname]
[DELCONSUMER key groupname consumername]
https://redis.io/commands/xgroup
Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.
GROUP group consumer
https://redis.io/commands/xreadgroup
Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.
group
https://redis.io/commands/xack
Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.
consumer
min-idle-time
[IDLE ms]
[TIME ms-unix-time]
[RETRYCOUNT count]
[FORCE]
[JUSTID]
https://redis.io/commands/xclaim
Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.
[start end count]
[consumer]
https://redis.io/commands/xpending
Append a value to a key.
https://redis.io/commands/append
Count set bits in a string.
[start end]
https://redis.io/commands/bitcount
Perform arbitrary bitfield integer operations on strings.
[GET type offset]
[SET type offset value]
[INCRBY type offset increment]
[OVERFLOW WRAP|SAT|FAIL]
https://redis.io/commands/bitfield
Perform bitwise operations between strings.
operation
https://redis.io/commands/bitop
Find first bit set or clear in a string.
bit
[start]
[end]
https://redis.io/commands/bitpos
Decrement the integer value of a key by one.
https://redis.io/commands/decr
Decrement the integer value of a key by the given number.
decrement
https://redis.io/commands/decrby
Get the value of a key.
https://redis.io/commands/get
Returns the bit value at offset in the string value stored at key.
offset
https://redis.io/commands/getbit
Get a substring of the string stored at a key.
https://redis.io/commands/getrange
Set the string value of a key and return its old value.
https://redis.io/commands/getset
Increment the integer value of a key by one.
https://redis.io/commands/incr
Increment the integer value of a key by the given amount.
https://redis.io/commands/incrby
Increment the float value of a key by the given amount.
https://redis.io/commands/incrbyfloat
Get the values of all the given keys.
https://redis.io/commands/mget
Set multiple keys to multiple values.
key value [key value ...]
https://redis.io/commands/mset
Set multiple keys to multiple values, only if none of the keys exist.
https://redis.io/commands/msetnx
Set the value and expiration in milliseconds of a key.
https://redis.io/commands/psetex
Set the string value of a key.
[expiration EX seconds|PX milliseconds]
https://redis.io/commands/set
Sets or clears the bit at offset in the string value stored at key.
https://redis.io/commands/setbit
Set the value and expiration of a key.
https://redis.io/commands/setex
Set the value of a key, only if the key does not exist.
https://redis.io/commands/setnx
Overwrite part of a string at key starting at the specified offset.
https://redis.io/commands/setrange
Get the length of the value stored in a key.
https://redis.io/commands/strlen
Discard all commands issued after MULTI.
https://redis.io/commands/discard
Execute all commands issued after MULTI.
https://redis.io/commands/exec
Mark the start of a transaction block.
https://redis.io/commands/multi
Forget about all watched keys.
https://redis.io/commands/unwatch
Watch the given keys to determine execution of the MULTI/EXEC block.
https://redis.io/commands/watch
Tom Molesworth <TEAM@cpan.org>
Copyright Tom Molesworth 2015-2017. Licensed under the same terms as Perl itself.
To install Net::Async::Redis, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Async::Redis
CPAN shell
perl -MCPAN -e shell install Net::Async::Redis
For more information on module installation, please visit the detailed CPAN module installation guide.