redis v0.1.0 Redis

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

xadd(key, id, field_string)

Appends a new entry to a stream

xclaim(key, group, consumer, min_idle_time, id, opts \\ [])

Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer

xdel(key, id)

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

xgroup(opts \\ [])

Create, destroy, and manage consumer groups

xinfo(opts \\ [])

Get information on streams and consumer groups

xlen(key)

Return the number of entires in a stream

xpending(key, group, opts \\ [])

Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged

xrange(key, start, end_, opts \\ [])

Return a range of elements in a stream, with IDs matching the specified IDs interval

xread(key, id, opts \\ [])

Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block

xreadgroup(group, key, id, opts \\ [])

Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block

xrevrange(key, end_, start, opts \\ [])

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

xtrim(key, count, opts \\ [])

Trims the stream to (approximately if ‘~’ is passed) a certain size

zadd(key, score_member, opts \\ [])

Add one or more members to a sorted set, or update its score if it already exists

zcard(key)

Get the number of members in a sorted set

zcount(key, min, max)

Count the members in a sorted set with scores within the given values

zincrby(key, increment, member)

Increment the score of a member in a sorted set

zinterstore(destination, numkeys, key, opts \\ [])

Intersect multiple sorted sets and store the resulting sorted set in a new key

zlexcount(key, min, max)

Count the number of members in a sorted set between a given lexicographical range

zpopmax(key, opts \\ [])

Remove and return members with the highest scores in a sorted set

zpopmin(key, opts \\ [])

Remove and return members with the lowest scores in a sorted set

zrange(key, start, stop, opts \\ [])

Return a range of members in a sorted set, by index

zrangebylex(key, min, max, opts \\ [])

Return a range of members in a sorted set, by lexicographical range

zrangebyscore(key, min, max, opts \\ [])

Return a range of members in a sorted set, by score

zrank(key, member)

Determine the index of a member in a sorted set

zrem(key, member)

Remove one or more members from a sorted set

zremrangebylex(key, min, max)

Remove all members in a sorted set between the given lexicographical range

zremrangebyrank(key, start, stop)

Remove all members in a sorted set within the given indexes

zremrangebyscore(key, min, max)

Remove all members in a sorted set within the given scores

zrevrange(key, start, stop, opts \\ [])

Return a range of members in a sorted set, by index, with scores ordered from high to low

zrevrangebylex(key, max, min, opts \\ [])

Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings

zrevrangebyscore(key, max, min, opts \\ [])

Return a range of members in a sorted set, by score, with scores ordered from high to low

zrevrank(key, member)

Determine the index of a member in a sorted set, with scores ordered from high to low

zscan(key, cursor, opts \\ [])

Incrementally iterate sorted sets elements and associated scores

zscore(key, member)

Get the score associated with the given member in a sorted set

zunionstore(destination, numkeys, key, opts \\ [])

Add multiple sorted sets and store the resulting sorted set in a new key

Link to this section Types

key()

key() :: String.t()

Redis key, extracted into separate type to support variadic arguments

pattern()

pattern() :: String.t()

Redis pattern

posix_time()

posix_time() :: non_neg_integer()

Unix timestamp in seconds

variadic(value)

variadic(value) :: [value]

Variadic argument, when argument values count should equals key/0 count in command

Link to this section Functions

append(key, value) (since 2.0.0)

append(key :: key(), value :: String.t()) :: iolist()

Append a value to a key

Group: string.

auth(password) (since 1.0.0)

auth(password :: String.t()) :: iolist()

Authenticate to the server

Group: connection.

bgrewriteaof() (since 1.0.0)

bgrewriteaof() :: iolist()

Asynchronously rewrite the append-only file

Group: server.

bgsave() (since 1.0.0)

bgsave() :: iolist()

Asynchronously save the dataset to disk

Group: server.

bitcount(key, opts \\ []) (since 2.6.0)

bitcount(key :: key(), opts :: [{:start_end, {integer(), integer()}}]) ::
  iolist()

Count set bits in a string

Group: string.

bitfield(key, opts \\ []) (since 3.2.0)

bitfield(
  key :: key(),
  opts :: [
    get: {String.t(), integer()},
    set: {String.t(), integer(), integer()},
    incrby: {String.t(), integer(), integer()},
    overflow: :wrap | :sat | :fail
  ]
) :: iolist()

Perform arbitrary bitfield integer operations on strings

Group: string.

bitop(operation, destkey, key) (since 2.6.0)

bitop(operation :: String.t(), destkey :: key(), key :: key()) :: iolist()

Perform bitwise operations between strings

Group: string.

bitpos(key, bit, opts \\ []) (since 2.8.7)

bitpos(
  key :: key(),
  bit :: integer(),
  opts :: [start: integer(), end: integer()]
) :: iolist()

Find first bit set or clear in a string

Group: string.

blpop(key, timeout) (since 2.0.0)

blpop(key :: key(), timeout :: integer()) :: iolist()

Remove and get the first element in a list, or block until one is available

Group: list.

brpop(key, timeout) (since 2.0.0)

brpop(key :: key(), timeout :: integer()) :: iolist()

Remove and get the last element in a list, or block until one is available

Group: list.

brpoplpush(source, destination, timeout) (since 2.2.0)

brpoplpush(source :: key(), destination :: key(), timeout :: integer()) ::
  iolist()

Pop a value from a list, push it to another list and return it; or block until one is available

Group: list.

bzpopmax(key, timeout) (since 5.0.0)

bzpopmax(key :: key(), timeout :: integer()) :: iolist()

Remove and return the member with the highest score from one or more sorted sets, or block until one is available

Group: sorted_set.

bzpopmin(key, timeout) (since 5.0.0)

bzpopmin(key :: key(), timeout :: integer()) :: iolist()

Remove and return the member with the lowest score from one or more sorted sets, or block until one is available

Group: sorted_set.

client_getname() (since 2.6.9)

client_getname() :: iolist()

Get the current connection name

Group: server.

client_id() (since 5.0.0)

client_id() :: iolist()

Returns the client ID for the current connection

Group: server.

client_kill(opts \\ []) (since 2.4.0)

client_kill(
  opts :: [
    ip_port: String.t(),
    id: integer(),
    type: :normal | :master | :slave | :pubsub,
    addr: String.t(),
    skipme: String.t()
  ]
) :: iolist()

Kill the connection of a client

Group: server.

client_list(opts \\ []) (since 2.4.0)

client_list(opts :: [{:type, :normal | :master | :replica | :pubsub}]) ::
  iolist()

Get the list of client connections

Group: server.

client_pause(timeout) (since 2.9.50)

client_pause(timeout :: integer()) :: iolist()

Stop processing commands from clients for some time

Group: server.

client_reply(reply_mode) (since 3.2)

client_reply(reply_mode :: :on | :off | :skip) :: iolist()

Instruct the server whether to reply to commands

Group: server.

client_setname(connection_name) (since 2.6.9)

client_setname(connection_name :: String.t()) :: iolist()

Set the current connection name

Group: server.

client_unblock(client_id, opts \\ []) (since 5.0.0)

client_unblock(
  client_id :: String.t(),
  opts :: [(:timeout | :error) | {:unblock_type, :timeout | :error}]
) :: iolist()

Unblock a client blocked in a blocking command from a different connection

Group: server.

cluster_addslots(slot) (since 3.0.0)

cluster_addslots(slot :: integer()) :: iolist()

Assign new hash slots to receiving node

Group: cluster.

cluster_count_failure_reports(node_id) (since 3.0.0)

cluster_count_failure_reports(node_id :: String.t()) :: iolist()

Return the number of failure reports active for a given node

Group: cluster.

cluster_countkeysinslot(slot) (since 3.0.0)

cluster_countkeysinslot(slot :: integer()) :: iolist()

Return the number of local keys in the specified hash slot

Group: cluster.

cluster_delslots(slot) (since 3.0.0)

cluster_delslots(slot :: integer()) :: iolist()

Set hash slots as unbound in receiving node

Group: cluster.

cluster_failover(opts \\ []) (since 3.0.0)

cluster_failover(
  opts :: [(:force | :takeover) | {:options, :force | :takeover}]
) :: iolist()

Forces a replica to perform a manual failover of its master.

Group: cluster.

cluster_forget(node_id) (since 3.0.0)

cluster_forget(node_id :: String.t()) :: iolist()

Remove a node from the nodes table

Group: cluster.

cluster_getkeysinslot(slot, count) (since 3.0.0)

cluster_getkeysinslot(slot :: integer(), count :: integer()) :: iolist()

Return local key names in the specified hash slot

Group: cluster.

cluster_info() (since 3.0.0)

cluster_info() :: iolist()

Provides info about Redis Cluster node state

Group: cluster.

cluster_keyslot(key) (since 3.0.0)

cluster_keyslot(key :: String.t()) :: iolist()

Returns the hash slot of the specified key

Group: cluster.

cluster_meet(ip, port) (since 3.0.0)

cluster_meet(ip :: String.t(), port :: integer()) :: iolist()

Force a node cluster to handshake with another node

Group: cluster.

cluster_nodes() (since 3.0.0)

cluster_nodes() :: iolist()

Get Cluster config for the node

Group: cluster.

cluster_replicas(node_id) (since 5.0.0)

cluster_replicas(node_id :: String.t()) :: iolist()

List replica nodes of the specified master node

Group: cluster.

cluster_replicate(node_id) (since 3.0.0)

cluster_replicate(node_id :: String.t()) :: iolist()

Reconfigure a node as a replica of the specified master node

Group: cluster.

cluster_reset(opts \\ []) (since 3.0.0)

cluster_reset(opts :: [(:hard | :soft) | {:reset_type, :hard | :soft}]) ::
  iolist()

Reset a Redis Cluster node

Group: cluster.

cluster_saveconfig() (since 3.0.0)

cluster_saveconfig() :: iolist()

Forces the node to save cluster state on disk

Group: cluster.

cluster_set_config_epoch(config_epoch) (since 3.0.0)

cluster_set_config_epoch(config_epoch :: integer()) :: iolist()

Set the configuration epoch in a new node

Group: cluster.

cluster_setslot(slot, subcommand, opts \\ []) (since 3.0.0)

cluster_setslot(
  slot :: integer(),
  subcommand :: :importing | :migrating | :stable | :node,
  opts :: [{:node_id, String.t()}]
) :: iolist()

Bind a hash slot to a specific node

Group: cluster.

cluster_slaves(node_id) (since 3.0.0)

cluster_slaves(node_id :: String.t()) :: iolist()

List replica nodes of the specified master node

Group: cluster.

cluster_slots() (since 3.0.0)

cluster_slots() :: iolist()

Get array of Cluster slot to node mappings

Group: cluster.

command() (since 2.8.13)

command() :: iolist()

Get array of Redis command details

Group: server.

command_count() (since 2.8.13)

command_count() :: iolist()

Get total number of Redis commands

Group: server.

command_getkeys() (since 2.8.13)

command_getkeys() :: iolist()

Extract keys given a full Redis command

Group: server.

command_info(command_name) (since 2.8.13)

command_info(command_name :: String.t()) :: iolist()

Get array of specific Redis command details

Group: server.

config_get(parameter) (since 2.0.0)

config_get(parameter :: String.t()) :: iolist()

Get the value of a configuration parameter

Group: server.

config_resetstat() (since 2.0.0)

config_resetstat() :: iolist()

Reset the stats returned by INFO

Group: server.

config_rewrite() (since 2.8.0)

config_rewrite() :: iolist()

Rewrite the configuration file with the in memory configuration

Group: server.

config_set(parameter, value) (since 2.0.0)

config_set(parameter :: String.t(), value :: String.t()) :: iolist()

Set a configuration parameter to the given value

Group: server.

dbsize() (since 1.0.0)

dbsize() :: iolist()

Return the number of keys in the selected database

Group: server.

debug_object(key) (since 1.0.0)

debug_object(key :: key()) :: iolist()

Get debugging information about a key

Group: server.

debug_segfault() (since 1.0.0)

debug_segfault() :: iolist()

Make the server crash

Group: server.

decr(key) (since 1.0.0)

decr(key :: key()) :: iolist()

Decrement the integer value of a key by one

Group: string.

decrby(key, decrement) (since 1.0.0)

decrby(key :: key(), decrement :: integer()) :: iolist()

Decrement the integer value of a key by the given number

Group: string.

del(key) (since 1.0.0)

del(key :: key()) :: iolist()

Delete a key

Group: generic.

discard() (since 2.0.0)

discard() :: iolist()

Discard all commands issued after MULTI

Group: transactions.

dump(key) (since 2.6.0)

dump(key :: key()) :: iolist()

Return a serialized version of the value stored at the specified key.

Group: generic.

echo(message) (since 1.0.0)

echo(message :: String.t()) :: iolist()

Echo the given string

Group: connection.

eval(script, numkeys, key, arg) (since 2.6.0)

eval(
  script :: String.t(),
  numkeys :: integer(),
  key :: key(),
  arg :: String.t()
) :: iolist()

Execute a Lua script server side

Group: scripting.

evalsha(sha1, numkeys, key, arg) (since 2.6.0)

evalsha(
  sha1 :: String.t(),
  numkeys :: integer(),
  key :: key(),
  arg :: String.t()
) :: iolist()

Execute a Lua script server side

Group: scripting.

exec() (since 1.2.0)

exec() :: iolist()

Execute all commands issued after MULTI

Group: transactions.

exists(key) (since 1.0.0)

exists(key :: key()) :: iolist()

Determine if a key exists

Group: generic.

expire(key, seconds) (since 1.0.0)

expire(key :: key(), seconds :: integer()) :: iolist()

Set a key’s time to live in seconds

Group: generic.

expireat(key, timestamp) (since 1.2.0)

expireat(key :: key(), timestamp :: posix_time()) :: iolist()

Set the expiration for a key as a UNIX timestamp

Group: generic.

flushall(opts \\ []) (since 1.0.0)

flushall(opts :: [:async]) :: iolist()

Remove all keys from all databases

Group: server.

flushdb(opts \\ []) (since 1.0.0)

flushdb(opts :: [:async]) :: iolist()

Remove all keys from the current database

Group: server.

geoadd(key, longitude_latitude_member) (since 3.2.0)

geoadd(
  key :: key(),
  longitude_latitude_member :: {float(), float(), String.t()}
) :: iolist()

Add one or more geospatial items in the geospatial index represented using a sorted set

Group: geo.

geodist(key, member1, member2, opts \\ []) (since 3.2.0)

geodist(
  key :: key(),
  member1 :: String.t(),
  member2 :: String.t(),
  opts :: [{:unit, String.t()}]
) :: iolist()

Returns the distance between two members of a geospatial index

Group: geo.

geohash(key, member) (since 3.2.0)

geohash(key :: key(), member :: String.t()) :: iolist()

Returns members of a geospatial index as standard geohash strings

Group: geo.

geopos(key, member) (since 3.2.0)

geopos(key :: key(), member :: String.t()) :: iolist()

Returns longitude and latitude of members of a geospatial index

Group: geo.

georadius(key, longitude, latitude, radius, unit, opts \\ []) (since 3.2.0)

georadius(
  key :: key(),
  longitude :: float(),
  latitude :: float(),
  radius :: float(),
  unit :: :m | :km | :ft | :mi,
  opts :: [
    :withcoord
    | :withdist
    | :withhash
    | {:count, integer()}
    | ((:asc | :desc) | {:order, :asc | :desc})
    | {:store, key()}
    | {:storedist, key()}
  ]
) :: iolist()

Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point

Group: geo.

georadiusbymember(key, member, radius, unit, opts \\ []) (since 3.2.0)

georadiusbymember(
  key :: key(),
  member :: String.t(),
  radius :: float(),
  unit :: :m | :km | :ft | :mi,
  opts :: [
    :withcoord
    | :withdist
    | :withhash
    | {:count, integer()}
    | ((:asc | :desc) | {:order, :asc | :desc})
    | {:store, key()}
    | {:storedist, key()}
  ]
) :: iolist()

Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member

Group: geo.

get(key) (since 1.0.0)

get(key :: key()) :: iolist()

Get the value of a key

Group: string.

getbit(key, offset) (since 2.2.0)

getbit(key :: key(), offset :: integer()) :: iolist()

Returns the bit value at offset in the string value stored at key

Group: string.

getrange(key, start, end_) (since 2.4.0)

getrange(key :: key(), start :: integer(), end_ :: integer()) :: iolist()

Get a substring of the string stored at a key

Group: string.

getset(key, value) (since 1.0.0)

getset(key :: key(), value :: String.t()) :: iolist()

Set the string value of a key and return its old value

Group: string.

hdel(key, field) (since 2.0.0)

hdel(key :: key(), field :: String.t()) :: iolist()

Delete one or more hash fields

Group: hash.

hexists(key, field) (since 2.0.0)

hexists(key :: key(), field :: String.t()) :: iolist()

Determine if a hash field exists

Group: hash.

hget(key, field) (since 2.0.0)

hget(key :: key(), field :: String.t()) :: iolist()

Get the value of a hash field

Group: hash.

hgetall(key) (since 2.0.0)

hgetall(key :: key()) :: iolist()

Get all the fields and values in a hash

Group: hash.

hincrby(key, field, increment) (since 2.0.0)

hincrby(key :: key(), field :: String.t(), increment :: integer()) :: iolist()

Increment the integer value of a hash field by the given number

Group: hash.

hincrbyfloat(key, field, increment) (since 2.6.0)

hincrbyfloat(key :: key(), field :: String.t(), increment :: float()) ::
  iolist()

Increment the float value of a hash field by the given amount

Group: hash.

hkeys(key) (since 2.0.0)

hkeys(key :: key()) :: iolist()

Get all the fields in a hash

Group: hash.

hlen(key) (since 2.0.0)

hlen(key :: key()) :: iolist()

Get the number of fields in a hash

Group: hash.

hmget(key, field) (since 2.0.0)

hmget(key :: key(), field :: String.t()) :: iolist()

Get the values of all the given hash fields

Group: hash.

hmset(key, field_value) (since 2.0.0)

hmset(key :: key(), field_value :: {String.t(), String.t()}) :: iolist()

Set multiple hash fields to multiple values

Group: hash.

hscan(key, cursor, opts \\ []) (since 2.8.0)

hscan(
  key :: key(),
  cursor :: integer(),
  opts :: [match: pattern(), count: integer()]
) :: iolist()

Incrementally iterate hash fields and associated values

Group: hash.

hset(key, field, value) (since 2.0.0)

hset(key :: key(), field :: String.t(), value :: String.t()) :: iolist()

Set the string value of a hash field

Group: hash.

hsetnx(key, field, value) (since 2.0.0)

hsetnx(key :: key(), field :: String.t(), value :: String.t()) :: iolist()

Set the value of a hash field, only if the field does not exist

Group: hash.

hstrlen(key, field) (since 3.2.0)

hstrlen(key :: key(), field :: String.t()) :: iolist()

Get the length of the value of a hash field

Group: hash.

hvals(key) (since 2.0.0)

hvals(key :: key()) :: iolist()

Get all the values in a hash

Group: hash.

incr(key) (since 1.0.0)

incr(key :: key()) :: iolist()

Increment the integer value of a key by one

Group: string.

incrby(key, increment) (since 1.0.0)

incrby(key :: key(), increment :: integer()) :: iolist()

Increment the integer value of a key by the given amount

Group: string.

incrbyfloat(key, increment) (since 2.6.0)

incrbyfloat(key :: key(), increment :: float()) :: iolist()

Increment the float value of a key by the given amount

Group: string.

info(opts \\ []) (since 1.0.0)

info(opts :: [{:section, String.t()}]) :: iolist()

Get information and statistics about the server

Group: server.

keys(pattern) (since 1.0.0)

keys(pattern :: pattern()) :: iolist()

Find all keys matching the given pattern

Group: generic.

lastsave() (since 1.0.0)

lastsave() :: iolist()

Get the UNIX time stamp of the last successful save to disk

Group: server.

lindex(key, index) (since 1.0.0)

lindex(key :: key(), index :: integer()) :: iolist()

Get an element from a list by its index

Group: list.

linsert(key, where, pivot, value) (since 2.2.0)

linsert(
  key :: key(),
  where :: :before | :after,
  pivot :: String.t(),
  value :: String.t()
) :: iolist()

Insert an element before or after another element in a list

Group: list.

llen(key) (since 1.0.0)

llen(key :: key()) :: iolist()

Get the length of a list

Group: list.

lpop(key) (since 1.0.0)

lpop(key :: key()) :: iolist()

Remove and get the first element in a list

Group: list.

lpush(key, value) (since 1.0.0)

lpush(key :: key(), value :: String.t()) :: iolist()

Prepend one or multiple values to a list

Group: list.

lpushx(key, value) (since 2.2.0)

lpushx(key :: key(), value :: String.t()) :: iolist()

Prepend a value to a list, only if the list exists

Group: list.

lrange(key, start, stop) (since 1.0.0)

lrange(key :: key(), start :: integer(), stop :: integer()) :: iolist()

Get a range of elements from a list

Group: list.

lrem(key, count, value) (since 1.0.0)

lrem(key :: key(), count :: integer(), value :: String.t()) :: iolist()

Remove elements from a list

Group: list.

lset(key, index, value) (since 1.0.0)

lset(key :: key(), index :: integer(), value :: String.t()) :: iolist()

Set the value of an element in a list by its index

Group: list.

ltrim(key, start, stop) (since 1.0.0)

ltrim(key :: key(), start :: integer(), stop :: integer()) :: iolist()

Trim a list to the specified range

Group: list.

memory_doctor() (since 4.0.0)

memory_doctor() :: iolist()

Outputs memory problems report

Group: server.

memory_help() (since 4.0.0)

memory_help() :: iolist()

Show helpful text about the different subcommands

Group: server.

memory_malloc_stats() (since 4.0.0)

memory_malloc_stats() :: iolist()

Show allocator internal stats

Group: server.

memory_purge() (since 4.0.0)

memory_purge() :: iolist()

Ask the allocator to release memory

Group: server.

memory_stats() (since 4.0.0)

memory_stats() :: iolist()

Show memory usage details

Group: server.

memory_usage(key, opts \\ []) (since 4.0.0)

memory_usage(key :: key(), opts :: [{:samples, integer()}]) :: iolist()

Estimate the memory usage of a key

Group: server.

mget(key) (since 1.0.0)

mget(key :: key()) :: iolist()

Get the values of all the given keys

Group: string.

migrate(host, port, key, destination_db, timeout, opts \\ []) (since 2.6.0)

migrate(
  host :: String.t(),
  port :: String.t(),
  key :: key(),
  destination_db :: integer(),
  timeout :: integer(),
  opts :: [:copy | :replace | {:keys, variadic(key())}]
) :: iolist()

Atomically transfer a key from a Redis instance to another one.

Group: generic.

monitor() (since 1.0.0)

monitor() :: iolist()

Listen for all requests received by the server in real time

Group: server.

move(key, db) (since 1.0.0)

move(key :: key(), db :: integer()) :: iolist()

Move a key to another database

Group: generic.

mset(key_value) (since 1.0.1)

mset(key_value :: {key(), String.t()}) :: iolist()

Set multiple keys to multiple values

Group: string.

msetnx(key_value) (since 1.0.1)

msetnx(key_value :: {key(), String.t()}) :: iolist()

Set multiple keys to multiple values, only if none of the keys exist

Group: string.

multi() (since 1.2.0)

multi() :: iolist()

Mark the start of a transaction block

Group: transactions.

object(subcommand, opts \\ []) (since 2.2.3)

object(subcommand :: String.t(), opts :: [{:arguments, String.t()}]) :: iolist()

Inspect the internals of Redis objects

Group: generic.

persist(key) (since 2.2.0)

persist(key :: key()) :: iolist()

Remove the expiration from a key

Group: generic.

pexpire(key, milliseconds) (since 2.6.0)

pexpire(key :: key(), milliseconds :: integer()) :: iolist()

Set a key’s time to live in milliseconds

Group: generic.

pexpireat(key, milliseconds_timestamp) (since 2.6.0)

pexpireat(key :: key(), milliseconds_timestamp :: posix_time()) :: iolist()

Set the expiration for a key as a UNIX timestamp specified in milliseconds

Group: generic.

pfadd(key, element) (since 2.8.9)

pfadd(key :: key(), element :: String.t()) :: iolist()

Adds the specified elements to the specified HyperLogLog.

Group: hyperloglog.

pfcount(key) (since 2.8.9)

pfcount(key :: key()) :: iolist()

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

Group: hyperloglog.

pfmerge(destkey, sourcekey) (since 2.8.9)

pfmerge(destkey :: key(), sourcekey :: key()) :: iolist()

Merge N different HyperLogLogs into a single one.

Group: hyperloglog.

ping(opts \\ []) (since 1.0.0)

ping(opts :: [{:message, String.t()}]) :: iolist()

Ping the server

Group: connection.

psetex(key, milliseconds, value) (since 2.6.0)

psetex(key :: key(), milliseconds :: integer(), value :: String.t()) ::
  iolist()

Set the value and expiration in milliseconds of a key

Group: string.

psubscribe(pattern) (since 2.0.0)

psubscribe(pattern :: [pattern()]) :: iolist()

Listen for messages published to channels matching the given patterns

Group: pubsub.

pttl(key) (since 2.6.0)

pttl(key :: key()) :: iolist()

Get the time to live for a key in milliseconds

Group: generic.

publish(channel, message) (since 2.0.0)

publish(channel :: String.t(), message :: String.t()) :: iolist()

Post a message to a channel

Group: pubsub.

pubsub(subcommand, opts \\ []) (since 2.8.0)

pubsub(subcommand :: String.t(), opts :: [{:argument, String.t()}]) :: iolist()

Inspect the state of the Pub/Sub subsystem

Group: pubsub.

punsubscribe(opts \\ []) (since 2.0.0)

punsubscribe(opts :: [{:pattern, pattern()}]) :: iolist()

Stop listening for messages posted to channels matching the given patterns

Group: pubsub.

quit() (since 1.0.0)

quit() :: iolist()

Close the connection

Group: connection.

randomkey() (since 1.0.0)

randomkey() :: iolist()

Return a random key from the keyspace

Group: generic.

readonly() (since 3.0.0)

readonly() :: iolist()

Enables read queries for a connection to a cluster replica node

Group: cluster.

readwrite() (since 3.0.0)

readwrite() :: iolist()

Disables read queries for a connection to a cluster replica node

Group: cluster.

rename(key, newkey) (since 1.0.0)

rename(key :: key(), newkey :: key()) :: iolist()

Rename a key

Group: generic.

renamenx(key, newkey) (since 1.0.0)

renamenx(key :: key(), newkey :: key()) :: iolist()

Rename a key, only if the new key does not exist

Group: generic.

replicaof(host, port) (since 5.0.0)

replicaof(host :: String.t(), port :: String.t()) :: iolist()

Make the server a replica of another instance, or promote it as master.

Group: server.

restore(key, ttl, serialized_value, opts \\ []) (since 2.6.0)

restore(
  key :: key(),
  ttl :: integer(),
  serialized_value :: String.t(),
  opts :: [:replace]
) :: iolist()

Create a key using the provided serialized value, previously obtained using DUMP.

Group: generic.

role() (since 2.8.12)

role() :: iolist()

Return the role of the instance in the context of replication

Group: server.

rpop(key) (since 1.0.0)

rpop(key :: key()) :: iolist()

Remove and get the last element in a list

Group: list.

rpoplpush(source, destination) (since 1.2.0)

rpoplpush(source :: key(), destination :: key()) :: iolist()

Remove the last element in a list, prepend it to another list and return it

Group: list.

rpush(key, value) (since 1.0.0)

rpush(key :: key(), value :: String.t()) :: iolist()

Append one or multiple values to a list

Group: list.

rpushx(key, value) (since 2.2.0)

rpushx(key :: key(), value :: String.t()) :: iolist()

Append a value to a list, only if the list exists

Group: list.

sadd(key, member) (since 1.0.0)

sadd(key :: key(), member :: String.t()) :: iolist()

Add one or more members to a set

Group: set.

save() (since 1.0.0)

save() :: iolist()

Synchronously save the dataset to disk

Group: server.

scan(cursor, opts \\ []) (since 2.8.0)

scan(cursor :: integer(), opts :: [match: pattern(), count: integer()]) ::
  iolist()

Incrementally iterate the keys space

Group: generic.

scard(key) (since 1.0.0)

scard(key :: key()) :: iolist()

Get the number of members in a set

Group: set.

script_debug(mode) (since 3.2.0)

script_debug(mode :: :yes | :sync | :no) :: iolist()

Set the debug mode for executed scripts.

Group: scripting.

script_exists(sha1) (since 2.6.0)

script_exists(sha1 :: String.t()) :: iolist()

Check existence of scripts in the script cache.

Group: scripting.

script_flush() (since 2.6.0)

script_flush() :: iolist()

Remove all the scripts from the script cache.

Group: scripting.

script_kill() (since 2.6.0)

script_kill() :: iolist()

Kill the script currently in execution.

Group: scripting.

script_load(script) (since 2.6.0)

script_load(script :: String.t()) :: iolist()

Load the specified Lua script into the script cache.

Group: scripting.

sdiff(key) (since 1.0.0)

sdiff(key :: key()) :: iolist()

Subtract multiple sets

Group: set.

sdiffstore(destination, key) (since 1.0.0)

sdiffstore(destination :: key(), key :: key()) :: iolist()

Subtract multiple sets and store the resulting set in a key

Group: set.

select(index) (since 1.0.0)

select(index :: integer()) :: iolist()

Change the selected database for the current connection

Group: connection.

set(key, value, opts \\ []) (since 1.0.0)

set(
  key :: key(),
  value :: String.t(),
  opts :: [
    {:expiration, {:ex, :integer} | {:px, :integer}}
    | (:nx | :xx)
    | {:condition, :nx | :xx}
  ]
) :: iolist()

Set the string value of a key

Group: string.

setbit(key, offset, value) (since 2.2.0)

setbit(key :: key(), offset :: integer(), value :: String.t()) :: iolist()

Sets or clears the bit at offset in the string value stored at key

Group: string.

setex(key, seconds, value) (since 2.0.0)

setex(key :: key(), seconds :: integer(), value :: String.t()) :: iolist()

Set the value and expiration of a key

Group: string.

setnx(key, value) (since 1.0.0)

setnx(key :: key(), value :: String.t()) :: iolist()

Set the value of a key, only if the key does not exist

Group: string.

setrange(key, offset, value) (since 2.2.0)

setrange(key :: key(), offset :: integer(), value :: String.t()) :: iolist()

Overwrite part of a string at key starting at the specified offset

Group: string.

shutdown(opts \\ []) (since 1.0.0)

shutdown(opts :: [(:nosave | :save) | {:save_mode, :nosave | :save}]) ::
  iolist()

Synchronously save the dataset to disk and then shut down the server

Group: server.

sinter(key) (since 1.0.0)

sinter(key :: key()) :: iolist()

Intersect multiple sets

Group: set.

sinterstore(destination, key) (since 1.0.0)

sinterstore(destination :: key(), key :: key()) :: iolist()

Intersect multiple sets and store the resulting set in a key

Group: set.

sismember(key, member) (since 1.0.0)

sismember(key :: key(), member :: String.t()) :: iolist()

Determine if a given value is a member of a set

Group: set.

slaveof(host, port) (since 1.0.0)

slaveof(host :: String.t(), port :: String.t()) :: iolist()

Make the server a replica of another instance, or promote it as master. Deprecated starting with Redis 5. Use REPLICAOF instead.

Group: server.

slowlog(subcommand, opts \\ []) (since 2.2.12)

slowlog(subcommand :: String.t(), opts :: [{:argument, String.t()}]) :: iolist()

Manages the Redis slow queries log

Group: server.

smembers(key) (since 1.0.0)

smembers(key :: key()) :: iolist()

Get all the members in a set

Group: set.

smove(source, destination, member) (since 1.0.0)

smove(source :: key(), destination :: key(), member :: String.t()) :: iolist()

Move a member from one set to another

Group: set.

sort(key, opts \\ []) (since 1.0.0)

sort(
  key :: key(),
  opts :: [
    {:by, pattern()}
    | {:limit, {integer(), integer()}}
    | {:get, String.t()}
    | ((:asc | :desc) | {:order, :asc | :desc})
    | (:alpha | {:sorting, :alpha})
    | {:store, key()}
  ]
) :: iolist()

Sort the elements in a list, set or sorted set

Group: generic.

spop(key, opts \\ []) (since 1.0.0)

spop(key :: key(), opts :: [{:count, integer()}]) :: iolist()

Remove and return one or multiple random members from a set

Group: set.

srandmember(key, opts \\ []) (since 1.0.0)

srandmember(key :: key(), opts :: [{:count, integer()}]) :: iolist()

Get one or multiple random members from a set

Group: set.

srem(key, member) (since 1.0.0)

srem(key :: key(), member :: String.t()) :: iolist()

Remove one or more members from a set

Group: set.

sscan(key, cursor, opts \\ []) (since 2.8.0)

sscan(
  key :: key(),
  cursor :: integer(),
  opts :: [match: pattern(), count: integer()]
) :: iolist()

Incrementally iterate Set elements

Group: set.

strlen(key) (since 2.2.0)

strlen(key :: key()) :: iolist()

Get the length of the value stored in a key

Group: string.

sunion(key) (since 1.0.0)

sunion(key :: key()) :: iolist()

Add multiple sets

Group: set.

sunionstore(destination, key) (since 1.0.0)

sunionstore(destination :: key(), key :: key()) :: iolist()

Add multiple sets and store the resulting set in a key

Group: set.

swapdb(index, index) (since 4.0.0)

swapdb(index :: integer(), index :: integer()) :: iolist()

Swaps two Redis databases

Group: connection.

sync() (since 1.0.0)

sync() :: iolist()

Internal command used for replication

Group: server.

time() (since 2.6.0)

time() :: iolist()

Return the current server time

Group: server.

touch(key) (since 3.2.1)

touch(key :: key()) :: iolist()

Alters the last access time of a key(s). Returns the number of existing keys specified.

Group: generic.

ttl(key) (since 1.0.0)

ttl(key :: key()) :: iolist()

Get the time to live for a key

Group: generic.

type(key) (since 1.0.0)

type(key :: key()) :: iolist()

Determine the type stored at key

Group: generic.

unlink(key) (since 4.0.0)

unlink(key :: key()) :: iolist()

Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

Group: generic.

unsubscribe(opts \\ []) (since 2.0.0)

unsubscribe(opts :: [{:channel, String.t()}]) :: iolist()

Stop listening for messages posted to the given channels

Group: pubsub.

unwatch() (since 2.2.0)

unwatch() :: iolist()

Forget about all watched keys

Group: transactions.

wait(numreplicas, timeout) (since 3.0.0)

wait(numreplicas :: integer(), timeout :: integer()) :: iolist()

Wait for the synchronous replication of all the write commands sent in the context of the current connection

Group: generic.

watch(key) (since 2.2.0)

watch(key :: key()) :: iolist()

Watch the given keys to determine execution of the MULTI/EXEC block

Group: transactions.

xack(key, group, id) (since 5.0.0)

xack(key :: key(), group :: String.t(), id :: String.t()) :: iolist()

Group: stream.

xadd(key, id, field_string) (since 5.0.0)

xadd(key :: key(), id :: String.t(), field_string :: {String.t(), String.t()}) ::
  iolist()

Appends a new entry to a stream

Group: stream.

xclaim(key, group, consumer, min_idle_time, id, opts \\ []) (since 5.0.0)

xclaim(
  key :: key(),
  group :: String.t(),
  consumer :: String.t(),
  min_idle_time :: String.t(),
  id :: String.t(),
  opts :: [
    {:idle, integer()}
    | {:time, integer()}
    | {:retrycount, integer()}
    | :force
    | :justid
  ]
) :: iolist()

Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.

Group: stream.

xdel(key, id) (since 5.0.0)

xdel(key :: key(), id :: String.t()) :: iolist()

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.

Group: stream.

xgroup(opts \\ []) (since 5.0.0)

xgroup(
  opts :: [
    create: {key(), String.t(), String.t()},
    setid: {key(), String.t(), String.t()},
    destroy: {key(), String.t()},
    delconsumer: {key(), String.t(), String.t()}
  ]
) :: iolist()

Create, destroy, and manage consumer groups.

Group: stream.

xinfo(opts \\ []) (since 5.0.0)

xinfo(
  opts :: [
    {:consumers, {key(), String.t()}}
    | {:groups, key()}
    | {:stream, key()}
    | :help
  ]
) :: iolist()

Get information on streams and consumer groups

Group: stream.

xlen(key) (since 5.0.0)

xlen(key :: key()) :: iolist()

Return the number of entires in a stream

Group: stream.

xpending(key, group, opts \\ []) (since 5.0.0)

xpending(
  key :: key(),
  group :: String.t(),
  opts :: [
    start_end_count: {String.t(), String.t(), integer()},
    consumer: String.t()
  ]
) :: iolist()

Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.

Group: stream.

xrange(key, start, end_, opts \\ []) (since 5.0.0)

xrange(
  key :: key(),
  start :: String.t(),
  end_ :: String.t(),
  opts :: [{:count, integer()}]
) :: iolist()

Return a range of elements in a stream, with IDs matching the specified IDs interval

Group: stream.

xread(key, id, opts \\ []) (since 5.0.0)

xread(
  key :: key(),
  id :: String.t(),
  opts :: [{:count, integer()} | {:block, integer()} | :streams]
) :: iolist()

Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.

Group: stream.

xreadgroup(group, key, id, opts \\ []) (since 5.0.0)

xreadgroup(
  group :: {String.t(), String.t()},
  key :: key(),
  id :: String.t(),
  opts :: [{:count, integer()} | {:block, integer()} | :noack | :streams]
) :: iolist()

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: stream.

xrevrange(key, end_, start, opts \\ []) (since 5.0.0)

xrevrange(
  key :: key(),
  end_ :: String.t(),
  start :: String.t(),
  opts :: [{:count, integer()}]
) :: iolist()

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

Group: stream.

xtrim(key, count, opts \\ []) (since 5.0.0)

xtrim(
  key :: key(),
  count :: integer(),
  opts :: [(:maxlen | {:strategy, :maxlen}) | :"~" | {:approx, :"~"}]
) :: iolist()

Trims the stream to (approximately if ‘~’ is passed) a certain size

Group: stream.

zadd(key, score_member, opts \\ []) (since 1.2.0)

zadd(
  key :: key(),
  score_member :: {float(), String.t()},
  opts :: [
    ((:nx | :xx) | {:condition, :nx | :xx})
    | (:ch | {:change, :ch})
    | :incr
    | {:increment, :incr}
  ]
) :: iolist()

Add one or more members to a sorted set, or update its score if it already exists

Group: sorted_set.

zcard(key) (since 1.2.0)

zcard(key :: key()) :: iolist()

Get the number of members in a sorted set

Group: sorted_set.

zcount(key, min, max) (since 2.0.0)

zcount(key :: key(), min :: float(), max :: float()) :: iolist()

Count the members in a sorted set with scores within the given values

Group: sorted_set.

zincrby(key, increment, member) (since 1.2.0)

zincrby(key :: key(), increment :: integer(), member :: String.t()) :: iolist()

Increment the score of a member in a sorted set

Group: sorted_set.

zinterstore(destination, numkeys, key, opts \\ []) (since 2.0.0)

zinterstore(
  destination :: key(),
  numkeys :: integer(),
  key :: key(),
  opts :: [weights: variadic(integer()), aggregate: :sum | :min | :max]
) :: iolist()

Intersect multiple sorted sets and store the resulting sorted set in a new key

Group: sorted_set.

zlexcount(key, min, max) (since 2.8.9)

zlexcount(key :: key(), min :: String.t(), max :: String.t()) :: iolist()

Count the number of members in a sorted set between a given lexicographical range

Group: sorted_set.

zpopmax(key, opts \\ []) (since 5.0.0)

zpopmax(key :: key(), opts :: [{:count, integer()}]) :: iolist()

Remove and return members with the highest scores in a sorted set

Group: sorted_set.

zpopmin(key, opts \\ []) (since 5.0.0)

zpopmin(key :: key(), opts :: [{:count, integer()}]) :: iolist()

Remove and return members with the lowest scores in a sorted set

Group: sorted_set.

zrange(key, start, stop, opts \\ []) (since 1.2.0)

zrange(
  key :: key(),
  start :: integer(),
  stop :: integer(),
  opts :: [:withscores]
) :: iolist()

Return a range of members in a sorted set, by index

Group: sorted_set.

zrangebylex(key, min, max, opts \\ []) (since 2.8.9)

zrangebylex(
  key :: key(),
  min :: String.t(),
  max :: String.t(),
  opts :: [{:limit, {integer(), integer()}}]
) :: iolist()

Return a range of members in a sorted set, by lexicographical range

Group: sorted_set.

zrangebyscore(key, min, max, opts \\ []) (since 1.0.5)

zrangebyscore(
  key :: key(),
  min :: float(),
  max :: float(),
  opts :: [:withscores | {:limit, {integer(), integer()}}]
) :: iolist()

Return a range of members in a sorted set, by score

Group: sorted_set.

zrank(key, member) (since 2.0.0)

zrank(key :: key(), member :: String.t()) :: iolist()

Determine the index of a member in a sorted set

Group: sorted_set.

zrem(key, member) (since 1.2.0)

zrem(key :: key(), member :: String.t()) :: iolist()

Remove one or more members from a sorted set

Group: sorted_set.

zremrangebylex(key, min, max) (since 2.8.9)

zremrangebylex(key :: key(), min :: String.t(), max :: String.t()) :: iolist()

Remove all members in a sorted set between the given lexicographical range

Group: sorted_set.

zremrangebyrank(key, start, stop) (since 2.0.0)

zremrangebyrank(key :: key(), start :: integer(), stop :: integer()) ::
  iolist()

Remove all members in a sorted set within the given indexes

Group: sorted_set.

zremrangebyscore(key, min, max) (since 1.2.0)

zremrangebyscore(key :: key(), min :: float(), max :: float()) :: iolist()

Remove all members in a sorted set within the given scores

Group: sorted_set.

zrevrange(key, start, stop, opts \\ []) (since 1.2.0)

zrevrange(
  key :: key(),
  start :: integer(),
  stop :: integer(),
  opts :: [:withscores]
) :: iolist()

Return a range of members in a sorted set, by index, with scores ordered from high to low

Group: sorted_set.

zrevrangebylex(key, max, min, opts \\ []) (since 2.8.9)

zrevrangebylex(
  key :: key(),
  max :: String.t(),
  min :: String.t(),
  opts :: [{:limit, {integer(), integer()}}]
) :: iolist()

Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.

Group: sorted_set.

zrevrangebyscore(key, max, min, opts \\ []) (since 2.2.0)

zrevrangebyscore(
  key :: key(),
  max :: float(),
  min :: float(),
  opts :: [:withscores | {:limit, {integer(), integer()}}]
) :: iolist()

Return a range of members in a sorted set, by score, with scores ordered from high to low

Group: sorted_set.

zrevrank(key, member) (since 2.0.0)

zrevrank(key :: key(), member :: String.t()) :: iolist()

Determine the index of a member in a sorted set, with scores ordered from high to low

Group: sorted_set.

zscan(key, cursor, opts \\ []) (since 2.8.0)

zscan(
  key :: key(),
  cursor :: integer(),
  opts :: [match: pattern(), count: integer()]
) :: iolist()

Incrementally iterate sorted sets elements and associated scores

Group: sorted_set.

zscore(key, member) (since 1.2.0)

zscore(key :: key(), member :: String.t()) :: iolist()

Get the score associated with the given member in a sorted set

Group: sorted_set.

zunionstore(destination, numkeys, key, opts \\ []) (since 2.0.0)

zunionstore(
  destination :: key(),
  numkeys :: integer(),
  key :: key(),
  opts :: [weights: variadic(integer()), aggregate: :sum | :min | :max]
) :: iolist()

Add multiple sorted sets and store the resulting sorted set in a new key

Group: sorted_set.