section 3valkey · Library functions 📚

L (continued)

• linsert(3valkey)Inserts an element before or after another element in a list.✨
• llen(3valkey)Returns the length of a list.✨
• lmove(3valkey)Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.✨
• lmpop(3valkey)Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.✨
• lolwut(3valkey)Displays computer art and the server version✨
• lpop(3valkey)Returns and removes one or more elements from the beginning of a list. Deletes the list if the last element was popped.✨
• lpos(3valkey)Returns the index of matching elements in a list.✨
• lpush(3valkey)Prepends one or more elements to a list. Creates the key if it doesn’t exist.✨
• lpushx(3valkey)Prepends one or more elements to a list only when the list exists.✨
• lrange(3valkey)Returns a range of elements from a list.✨
• lrem(3valkey)Removes elements from a list. Deletes the list if the last element was removed.✨
• lset(3valkey)Sets the value of an element in a list by its index.✨
• ltrim(3valkey)Removes elements from both ends a list. Deletes the list if all elements were trimmed.✨

M

• memory(3valkey)A container for memory diagnostics commands.✨
• memory-doctor(3valkey)Outputs a memory problems report.✨
• memory-help(3valkey)Returns helpful text about the different subcommands.✨
• memory-malloc-stats(3valkey)Returns the allocator statistics.✨
• memory-purge(3valkey)Asks the allocator to release memory.✨
• memory-stats(3valkey)Returns details about memory usage.✨
• memory-usage(3valkey)Estimates the memory usage of a key.✨
• mget(3valkey)Atomically returns the string values of one or more keys.✨
• migrate(3valkey)Atomically transfers a key from one instance to another.✨
• module(3valkey)A container for module commands.✨
• module-help(3valkey)Returns helpful text about the different subcommands.✨
• module-list(3valkey)Returns all loaded modules.✨
• module-load(3valkey)Loads a module.✨
• module-loadex(3valkey)Loads a module using extended parameters.✨
• module-unload(3valkey)Unloads a module.✨
• monitor(3valkey)Listens for all requests received by the server in real-time.✨
• move(3valkey)Moves a key to another database.✨
• mset(3valkey)Atomically creates or modifies the string values of one or more keys.✨
• msetnx(3valkey)Atomically modifies the string values of one or more keys only when all keys don’t exist.✨
• multi(3valkey)Starts a transaction.✨

O

• object(3valkey)A container for object introspection commands.✨
• object-encoding(3valkey)Returns the internal encoding of an object.✨
• object-freq(3valkey)Returns the logarithmic access frequency counter of an object.✨
• object-help(3valkey)Returns helpful text about the different subcommands.✨
• object-idletime(3valkey)Returns the time since the last access to an object.✨
• object-refcount(3valkey)Returns the reference count of a value of a key.✨

P

• persist(3valkey)Removes the expiration time of a key.✨
• pexpire(3valkey)Sets the expiration time of a key in milliseconds.✨
• pexpireat(3valkey)Sets the expiration time of a key to a Unix milliseconds timestamp.✨
• pexpiretime(3valkey)Returns the expiration time of a key as a Unix milliseconds timestamp.✨
• pfadd(3valkey)Adds elements to a HyperLogLog key. Creates the key if it doesn’t exist.✨
• pfcount(3valkey)Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).✨
• pfdebug(3valkey)Internal commands for debugging HyperLogLog values.✨
• pfmerge(3valkey)Merges one or more HyperLogLog values into a single key.✨
• pfselftest(3valkey)An internal command for testing HyperLogLog values.✨
• ping(3valkey)Returns the server’s liveliness response.✨
• psetex(3valkey)Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn’t exist.✨
• psubscribe(3valkey)Listens for messages published to channels that match one or more patterns.✨
• psync(3valkey)An internal command used in replication.✨
• pttl(3valkey)Returns the expiration time in milliseconds of a key.✨
• publish(3valkey)Posts a message to a channel.✨
• pubsub(3valkey)A container for Pub/Sub commands.✨
• pubsub-channels(3valkey)Returns the active channels.✨
• pubsub-help(3valkey)Returns helpful text about the different subcommands.✨
• pubsub-numpat(3valkey)Returns a count of unique pattern subscriptions.✨
• pubsub-numsub(3valkey)Returns a count of subscribers to channels.✨
• pubsub-shardchannels(3valkey)Returns the active shard channels.✨
• pubsub-shardnumsub(3valkey)Returns the count of subscribers of shard channels.✨
• punsubscribe(3valkey)Stops listening to messages published to channels that match one or more patterns.✨

Q

• quit(3valkey)Closes the connection.✨

R

• randomkey(3valkey)Returns a random key name from the database.✨
• readonly(3valkey)Enables read-only queries for a connection to a Valkey replica node.✨
• readwrite(3valkey)Enables read-write queries for a connection to a Valkey replica node.✨
• rename(3valkey)Renames a key and overwrites the destination.✨
• renamenx(3valkey)Renames a key only when the target key name doesn’t exist.✨
• replconf(3valkey)An internal command for configuring the replication stream.✨
• replicaof(3valkey)Configures a server as replica of another, or promotes it to a primary.✨
• reset(3valkey)Resets the connection.✨
• restore(3valkey)Creates a key from the serialized representation of a value.✨
• restore-asking(3valkey)An internal command for migrating keys in a cluster.✨
• role(3valkey)Returns the replication role.✨
• rpop(3valkey)Returns and removes one or more elements from the end of a list. Deletes the list if the last element was popped.✨
• rpoplpush(3valkey)Returns the last element of a list after removing and pushing it to another list. Deletes the list if the last element was popped.✨
• rpush(3valkey)Appends one or more elements to a list. Creates the key if it doesn’t exist.✨
• rpushx(3valkey)Appends one or more elements to a list only when the list exists.✨

S

• sadd(3valkey)Adds one or more members to a set. Creates the key if it doesn’t exist.✨
• save(3valkey)Synchronously saves the database(s) to disk.✨
• scan(3valkey)Iterates over the key names in the database.✨
• scard(3valkey)Returns the number of members in a set.✨
• script(3valkey)A container for Lua scripts management commands.✨
• script-debug(3valkey)Sets the debug mode of server-side Lua scripts.✨
• script-exists(3valkey)Determines whether server-side Lua scripts exist in the script cache.✨
• script-flush(3valkey)Removes all server-side Lua scripts from the script cache.✨
• script-help(3valkey)Returns helpful text about the different subcommands.✨
• script-kill(3valkey)Terminates a server-side Lua script during execution.✨
• script-load(3valkey)Loads a server-side Lua script to the script cache.✨
• script-show(3valkey)Show server-side Lua script in the script cache.✨
• sdiff(3valkey)Returns the difference of multiple sets.✨
• sdiffstore(3valkey)Stores the difference of multiple sets in a key.✨
• select(3valkey)Changes the selected database.✨
• set(3valkey)Sets the string value of a key, ignoring its type. The key is created if it doesn’t exist.✨
• setbit(3valkey)Sets or clears the bit at offset of the string value. Creates the key if it doesn’t exist.✨
• setex(3valkey)Sets the string value and expiration time of a key. Creates the key if it doesn’t exist.✨
• setnx(3valkey)Set the string value of a key only when the key doesn’t exist.✨
• setrange(3valkey)Overwrites a part of a string value with another by an offset. Creates the key if it doesn’t exist.✨
• shutdown(3valkey)Synchronously saves the database(s) to disk and shuts down the server.✨
• sinter(3valkey)Returns the intersect of multiple sets.✨
• sintercard(3valkey)Returns the number of members of the intersect of multiple sets.✨
• sinterstore(3valkey)Stores the intersect of multiple sets in a key.✨
• sismember(3valkey)Determines whether a member belongs to a set.✨
• slaveof(3valkey)Sets a server as a replica of another, or promotes it to being a primary.✨
• slowlog(3valkey)A container for slow log commands.✨
• slowlog-get(3valkey)Returns the slow log’s entries.✨
• slowlog-help(3valkey)Show helpful text about the different subcommands✨
• slowlog-len(3valkey)Returns the number of entries in the slow log.✨
• slowlog-reset(3valkey)Clears all entries from the slow log.✨
• smembers(3valkey)Returns all members of a set.✨
• smismember(3valkey)Determines whether multiple members belong to a set.✨
• smove(3valkey)Moves a member from one set to another.✨
• sort(3valkey)Sorts the elements in a list, a set, or a sorted set, optionally storing the result.✨
• sort_ro(3valkey)Returns the sorted elements of a list, a set, or a sorted set.✨
• spop(3valkey)Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.✨
• spublish(3valkey)Post a message to a shard channel✨
• srandmember(3valkey)Get one or multiple random members from a set✨
• srem(3valkey)Removes one or more members from a set. Deletes the set if the last member was removed.✨
• sscan(3valkey)Iterates over members of a set.✨
• ssubscribe(3valkey)Listens for messages published to shard channels.✨
• strlen(3valkey)Returns the length of a string value.✨
• subscribe(3valkey)Listens for messages published to channels.✨
• substr(3valkey)Returns a substring from a string value.✨
• sunion(3valkey)Returns the union of multiple sets.✨
• sunionstore(3valkey)Stores the union of multiple sets in a key.✨
• sunsubscribe(3valkey)Stops listening to messages posted to shard channels.✨
• swapdb(3valkey)Swaps two databases.✨
• sync(3valkey)An internal command used in replication.✨

T

• time(3valkey)Returns the server time.✨
• touch(3valkey)Returns the number of existing keys out of those specified after updating the time they were last accessed.✨
• ttl(3valkey)Returns the expiration time in seconds of a key.✨
• type(3valkey)Determines the type of value stored at a key.✨

U

• unlink(3valkey)Asynchronously deletes one or more keys.✨
• unsubscribe(3valkey)Stops listening to messages posted to channels.✨
• unwatch(3valkey)Forgets about watched keys of a transaction.✨

W

• wait(3valkey)Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.✨
• waitaof(3valkey)Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the primary and/or replicas.✨
• watch(3valkey)Monitors changes to keys to determine the execution of a transaction.✨

X

• xack(3valkey)Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.✨
• xadd(3valkey)Appends a new message to a stream. Creates the key if it doesn’t exist.✨
• xautoclaim(3valkey)Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.✨
• xclaim(3valkey)Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.✨
• xdel(3valkey)Returns the number of messages after removing them from a stream.✨
• xgroup(3valkey)A container for consumer groups commands.✨
• xgroup-create(3valkey)Creates a consumer group.✨
• xgroup-createconsumer(3valkey)Creates a consumer in a consumer group.✨
• xgroup-delconsumer(3valkey)Deletes a consumer from a consumer group.✨
• xgroup-destroy(3valkey)Destroys a consumer group.✨
• xgroup-help(3valkey)Returns helpful text about the different subcommands.✨
• xgroup-setid(3valkey)Sets the last-delivered ID of a consumer group.✨
• xinfo(3valkey)A container for stream introspection commands.✨
• xinfo-consumers(3valkey)Returns a list of the consumers in a consumer group.✨
• xinfo-groups(3valkey)Returns a list of the consumer groups of a stream.✨
• xinfo-help(3valkey)Returns helpful text about the different subcommands.✨
• xinfo-stream(3valkey)Returns information about a stream.✨
• xlen(3valkey)Return the number of messages in a stream.✨
• xpending(3valkey)Returns the information and entries from a stream consumer group’s pending entries list.✨
• xrange(3valkey)Returns the messages from a stream within a range of IDs.✨
• xread(3valkey)Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise.✨
• xreadgroup(3valkey)Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.✨
• xrevrange(3valkey)Returns the messages from a stream within a range of IDs in reverse order.✨
• xsetid(3valkey)An internal command for replicating stream values.✨
• xtrim(3valkey)Deletes messages from the beginning of a stream.✨

Z

• zadd(3valkey)Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn’t exist.✨
• zcard(3valkey)Returns the number of members in a sorted set.✨
• zcount(3valkey)Returns the count of members in a sorted set that have scores within a range.✨
• zdiff(3valkey)Returns the difference between multiple sorted sets.✨
• zdiffstore(3valkey)Stores the difference of multiple sorted sets in a key.✨
• zincrby(3valkey)Increments the score of a member in a sorted set.✨
• zinter(3valkey)Returns the intersect of multiple sorted sets.✨
• zintercard(3valkey)Returns the number of members of the intersect of multiple sorted sets.✨
• zinterstore(3valkey)Stores the intersect of multiple sorted sets in a key.✨
• zlexcount(3valkey)Returns the number of members in a sorted set within a lexicographical range.✨
• zmpop(3valkey)Returns the highest- or lowest-scoring members from one or more sorted sets after removing them. Deletes the sorted set if the last member was popped.✨
• zmscore(3valkey)Returns the score of one or more members in a sorted set.✨
• zpopmax(3valkey)Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.✨
• zpopmin(3valkey)Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.✨
• zrandmember(3valkey)Returns one or more random members from a sorted set.✨
• zrange(3valkey)Returns members in a sorted set within a range of indexes.✨
• zrangebylex(3valkey)Returns members in a sorted set within a lexicographical range.✨
• zrangebyscore(3valkey)Returns members in a sorted set within a range of scores.✨
• zrangestore(3valkey)Stores a range of members from sorted set in a key.✨
• zrank(3valkey)Returns the index of a member in a sorted set ordered by ascending scores.✨
• zrem(3valkey)Removes one or more members from a sorted set. Deletes the sorted set if all members were removed.✨
• zremrangebylex(3valkey)Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed.✨
• zremrangebyrank(3valkey)Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.✨
• zremrangebyscore(3valkey)Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed.✨
• zrevrange(3valkey)Returns members in a sorted set within a range of indexes in reverse order.✨
• zrevrangebylex(3valkey)Returns members in a sorted set within a lexicographical range in reverse order.✨
• zrevrangebyscore(3valkey)Returns members in a sorted set within a range of scores in reverse order.✨
• zrevrank(3valkey)Returns the index of a member in a sorted set ordered by descending scores.✨
• zscan(3valkey)Iterates over members and scores of a sorted set.✨
• zscore(3valkey)Returns the score of a member in a sorted set.✨
• zunion(3valkey)Returns the union of multiple sorted sets.✨
• zunionstore(3valkey)Stores the union of multiple sorted sets in a key.✨