section 3valkey · Library functions 📚

A

• acl(3valkey)A container for Access List Control commands.✨
• acl-cat(3valkey)Lists the ACL categories, or the commands inside a category.✨
• acl-deluser(3valkey)Deletes ACL users, and terminates their connections.✨
• acl-dryrun(3valkey)Simulates the execution of a command by a user, without executing the command.✨
• acl-genpass(3valkey)Generates a pseudorandom, secure password that can be used to identify ACL users.✨
• acl-getuser(3valkey)Lists the ACL rules of a user.✨
• acl-help(3valkey)Returns helpful text about the different subcommands.✨
• acl-list(3valkey)Dumps the effective rules in ACL file format.✨
• acl-load(3valkey)Reloads the rules from the configured ACL file.✨
• acl-log(3valkey)Lists recent security events generated due to ACL rules.✨
• acl-save(3valkey)Saves the effective ACL rules in the configured ACL file.✨
• acl-setuser(3valkey)Creates and modifies an ACL user and its rules.✨
• acl-users(3valkey)Lists all ACL users.✨
• acl-whoami(3valkey)Returns the authenticated username of the current connection.✨
• append(3valkey)Appends a string to the value of a key. Creates the key if it doesn’t exist.✨
• asking(3valkey)Signals that a cluster client is following an -ASK redirect.✨
• auth(3valkey)Authenticates the connection.✨

B

• bgrewriteaof(3valkey)Asynchronously rewrites the append-only file to disk.✨
• bgsave(3valkey)Asynchronously saves the database(s) to disk.✨
• bitcount(3valkey)Counts the number of set bits (population counting) in a string.✨
• bitfield(3valkey)Performs arbitrary bitfield integer operations on strings.✨
• bitfield_ro(3valkey)Performs arbitrary read-only bitfield integer operations on strings.✨
• bitop(3valkey)Performs bitwise operations on multiple strings, and stores the result.✨
• bitpos(3valkey)Finds the first set (1) or clear (0) bit in a string.✨
• blmove(3valkey)Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.✨
• blmpop(3valkey)Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.✨
• blpop(3valkey)Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.✨
• brpop(3valkey)Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.✨
• brpoplpush(3valkey)Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.✨
• bzmpop(3valkey)Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.✨
• bzpopmax(3valkey)Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.✨
• bzpopmin(3valkey)Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.✨

C

• client(3valkey)A container for client connection commands.✨
• client-caching(3valkey)Instructs the server whether to track the keys in the next request.✨
• client-capa(3valkey)A client claims its capability.✨
• client-getname(3valkey)Returns the name of the connection.✨
• client-getredir(3valkey)Returns the client ID to which the connection’s tracking notifications are redirected.✨
• client-help(3valkey)Returns helpful text about the different subcommands.✨
• client-id(3valkey)Returns the unique client ID of the connection.✨
• client-import-source(3valkey)Mark this client as an import source when server is in import mode.✨
• client-info(3valkey)Returns information about the connection.✨
• client-kill(3valkey)Terminates open connections.✨
• client-list(3valkey)Lists open connections.✨
• client-no-evict(3valkey)Sets the client eviction mode of the connection.✨
• client-no-touch(3valkey)Controls whether commands sent by the client affect the LRU/LFU of accessed keys.✨
• client-pause(3valkey)Suspends commands processing.✨
• client-reply(3valkey)Instructs the server whether to reply to commands.✨
• client-setinfo(3valkey)Sets information specific to the client or connection.✨
• client-setname(3valkey)Sets the connection name.✨
• client-tracking(3valkey)Controls server-assisted client-side caching for the connection.✨
• client-trackinginfo(3valkey)Returns information about server-assisted client-side caching for the connection.✨
• client-unblock(3valkey)Unblocks a client blocked by a blocking command from a different connection.✨
• client-unpause(3valkey)Resumes processing commands from paused clients.✨
• cluster(3valkey)A container for Cluster commands.✨
• cluster-addslots(3valkey)Assigns new hash slots to a node.✨
• cluster-addslotsrange(3valkey)Assigns new hash slot ranges to a node.✨
• cluster-bumpepoch(3valkey)Advances the cluster config epoch.✨
• cluster-cancelslotmigrations(3valkey)Cancel all current ongoing slot migration operations.✨
• cluster-count-failure-reports(3valkey)Returns the number of active failure reports for a node. No new reports are created once the node is marked as failed.✨
• cluster-countkeysinslot(3valkey)Returns the number of keys in a hash slot.✨
• cluster-delslots(3valkey)Sets hash slots as unbound for a node.✨
• cluster-delslotsrange(3valkey)Sets hash slot ranges as unbound for a node.✨
• cluster-failover(3valkey)Forces a replica to perform a manual failover of its primary.✨
• cluster-flushslots(3valkey)Deletes all slots information from a node.✨
• cluster-forget(3valkey)Removes a node from the nodes table.✨
• cluster-getkeysinslot(3valkey)Returns the key names in a hash slot.✨
• cluster-getslotmigrations(3valkey)Get the status of ongoing and recently finished slot import and export operations.✨
• cluster-help(3valkey)Returns helpful text about the different subcommands.✨
• cluster-info(3valkey)Returns information about the state of a node.✨
• cluster-keyslot(3valkey)Returns the hash slot for a key.✨
• cluster-links(3valkey)Returns a list of all TCP links to and from peer nodes.✨
• cluster-meet(3valkey)Forces a node to handshake with another node.✨
• cluster-migrateslots(3valkey)Migrate the given slots from this node to the specified nodes.✨
• cluster-myid(3valkey)Returns the ID of a node.✨
• cluster-myshardid(3valkey)Returns the shard ID of a node.✨
• cluster-nodes(3valkey)Returns the cluster configuration for a node.✨
• cluster-replicas(3valkey)Lists the replica nodes of a primary node.✨
• cluster-replicate(3valkey)Configure a node as replica of a primary node or detach a replica from its primary.✨
• cluster-reset(3valkey)Resets a node.✨
• cluster-saveconfig(3valkey)Forces a node to save the cluster configuration to disk.✨
• cluster-set-config-epoch(3valkey)Sets the configuration epoch for a new node.✨
• cluster-setslot(3valkey)Binds a hash slot to a node.✨
• cluster-shards(3valkey)Returns the mapping of cluster slots to shards.✨
• cluster-slaves(3valkey)Lists the replica nodes of a primary node.✨
• cluster-slot-stats(3valkey)Return an array of slot usage statistics for slots assigned to the current node.✨
• cluster-slots(3valkey)Returns the mapping of cluster slots to nodes.✨
• cluster-syncslots(3valkey)A container for internal slot migration commands.✨
• command(3valkey)Returns detailed information about all commands.✨
• command-count(3valkey)Returns a count of commands.✨
• command-docs(3valkey)Returns documentary information about one, multiple or all commands.✨
• command-getkeys(3valkey)Extracts the key names from an arbitrary command.✨
• command-getkeysandflags(3valkey)Extracts the key names and access flags for an arbitrary command.✨
• command-help(3valkey)Returns helpful text about the different subcommands.✨
• command-info(3valkey)Returns information about one, multiple or all commands.✨
• command-list(3valkey)Returns a list of command names.✨
• commandlog(3valkey)A container for command log commands.✨
• commandlog-get(3valkey)Returns the specified command log’s entries.✨
• commandlog-help(3valkey)Show helpful text about the different subcommands✨
• commandlog-len(3valkey)Returns the number of entries in the specified type of command log.✨
• commandlog-reset(3valkey)Clears all entries from the specified type of command log.✨
• config(3valkey)A container for server configuration commands.✨
• config-get(3valkey)Returns the effective values of configuration parameters.✨
• config-help(3valkey)Returns helpful text about the different subcommands.✨
• config-resetstat(3valkey)Resets the server’s statistics.✨
• config-rewrite(3valkey)Persists the effective configuration to file.✨
• config-set(3valkey)Sets configuration parameters in-flight.✨
• copy(3valkey)Copies the value of a key to a new key.✨

D

• dbsize(3valkey)Returns the number of keys in the database.✨
• debug(3valkey)A container for debugging commands.✨
• decr(3valkey)Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn’t exist.✨
• decrby(3valkey)Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn’t exist.✨
• del(3valkey)Deletes one or more keys.✨
• delifeq(3valkey)Delete key if value matches string.✨
• discard(3valkey)Discards a transaction.✨
• dump(3valkey)Returns a serialized representation of the value stored at a key.✨

E

• echo(3valkey)Returns the given string.✨
• eval(3valkey)Executes a server-side Lua script.✨
• eval_ro(3valkey)Executes a read-only server-side Lua script.✨
• evalsha(3valkey)Executes a server-side Lua script by SHA1 digest.✨
• evalsha_ro(3valkey)Executes a read-only server-side Lua script by SHA1 digest.✨
• exec(3valkey)Executes all commands in a transaction.✨
• exists(3valkey)Determines whether one or more keys exist.✨
• expire(3valkey)Sets the expiration time of a key in seconds.✨
• expireat(3valkey)Sets the expiration time of a key to a Unix timestamp.✨
• expiretime(3valkey)Returns the expiration time of a key as a Unix timestamp.✨

F

• failover(3valkey)Starts a coordinated failover from a server to one of its replicas.✨
• fcall(3valkey)Invokes a function.✨
• fcall_ro(3valkey)Invokes a read-only function.✨
• flushall(3valkey)Removes all keys from all databases.✨
• flushdb(3valkey)Remove all keys from the current database.✨
• function(3valkey)A container for function commands.✨
• function-delete(3valkey)Deletes a library and its functions.✨
• function-dump(3valkey)Dumps all libraries into a serialized binary payload.✨
• function-flush(3valkey)Deletes all libraries and functions.✨
• function-help(3valkey)Returns helpful text about the different subcommands.✨
• function-kill(3valkey)Terminates a function during execution.✨
• function-list(3valkey)Returns information about all libraries.✨
• function-load(3valkey)Creates a library.✨
• function-restore(3valkey)Restores all libraries from a payload.✨
• function-stats(3valkey)Returns information about a function during execution.✨

G

• geoadd(3valkey)Adds one or more members to a geospatial index. The key is created if it doesn’t exist.✨
• geodist(3valkey)Returns the distance between two members of a geospatial index.✨
• geohash(3valkey)Returns members from a geospatial index as geohash strings.✨
• geopos(3valkey)Returns the longitude and latitude of members from a geospatial index.✨
• georadius(3valkey)Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.✨
• georadius_ro(3valkey)Returns members from a geospatial index that are within a distance from a coordinate.✨
• georadiusbymember(3valkey)Queries a geospatial index for members within a distance from a member, optionally stores the result.✨
• georadiusbymember_ro(3valkey)Returns members from a geospatial index that are within a distance from a member.✨
• geosearch(3valkey)Queries a geospatial index for members inside an area of a box, circle, or a polygon.✨
• geosearchstore(3valkey)Queries a geospatial index for members inside an area of a box, a circle, or a polygon, optionally stores the result.✨
• get(3valkey)Returns the string value of a key.✨
• getbit(3valkey)Returns a bit value by offset.✨
• getdel(3valkey)Returns the string value of a key after deleting the key.✨
• getex(3valkey)Returns the string value of a key after setting its expiration time.✨
• getrange(3valkey)Returns a substring of the string stored at a key.✨
• getset(3valkey)Returns the previous string value of a key after setting it to a new value.✨

H

• hdel(3valkey)Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain.✨
• hello(3valkey)Handshakes with the server.✨
• hexists(3valkey)Determines whether a field exists in a hash.✨
• hexpire(3valkey)Set expiry time on hash fields.✨
• hexpireat(3valkey)Set expiry time on hash fields.✨
• hexpiretime(3valkey)Returns Unix timestamps in seconds since the epoch at which the given key’s field(s) will expire✨
• hget(3valkey)Returns the value of a field in a hash.✨
• hgetall(3valkey)Returns all fields and values in a hash.✨
• hgetex(3valkey)Get the value of one or more fields of a given hash key, and optionally set their expiration time or time-to-live (TTL).✨
• hincrby(3valkey)Increments the integer value of a field in a hash by a number. Uses 0 as initial value if the field doesn’t exist.✨
• hincrbyfloat(3valkey)Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn’t exist.✨
• hkeys(3valkey)Returns all fields in a hash.✨
• hlen(3valkey)Returns the number of fields in a hash.✨
• hmget(3valkey)Returns the values of all fields in a hash.✨
• hmset(3valkey)Sets the values of multiple fields.✨
• hpersist(3valkey)Remove the existing expiration on a hash key’s field(s).✨
• hpexpire(3valkey)Set expiry time on hash object.✨
• hpexpireat(3valkey)Set expiration time on hash field.✨
• hpexpiretime(3valkey)Returns the Unix timestamp in milliseconds since Unix epoch at which the given key’s field(s) will expire✨
• hpttl(3valkey)Returns the remaining time to live in milliseconds of a hash key’s field(s) that have an associated expiration.✨
• hrandfield(3valkey)Returns one or more random fields from a hash.✨
• hscan(3valkey)Iterates over fields and values of a hash.✨
• hset(3valkey)Creates or modifies the value of a field in a hash.✨
• hsetex(3valkey)Set the value of one or more fields of a given hash key, and optionally set their expiration time.✨
• hsetnx(3valkey)Sets the value of a field in a hash only when the field doesn’t exist.✨
• hstrlen(3valkey)Returns the length of the value of a field.✨
• httl(3valkey)Returns the remaining time to live (in seconds) of a hash key’s field(s) that have an associated expiration.✨
• hvals(3valkey)Returns all values in a hash.✨

I

• incr(3valkey)Increments the integer value of a key by one. Uses 0 as initial value if the key doesn’t exist.✨
• incrby(3valkey)Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn’t exist.✨
• incrbyfloat(3valkey)Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn’t exist.✨
• info(3valkey)Returns information and statistics about the server.✨

K

• keys(3valkey)Returns all key names that match a pattern.✨

L

• lastsave(3valkey)Returns the Unix timestamp of the last successful save to disk.✨
• latency(3valkey)A container for latency diagnostics commands.✨
• latency-doctor(3valkey)Returns a human-readable latency analysis report.✨
• latency-graph(3valkey)Returns a latency graph for an event.✨
• latency-help(3valkey)Returns helpful text about the different subcommands.✨
• latency-histogram(3valkey)Returns the cumulative distribution of latencies of a subset or all commands.✨
• latency-history(3valkey)Returns timestamp-latency samples for an event.✨
• latency-latest(3valkey)Returns the latest latency samples for all events.✨
• latency-reset(3valkey)Resets the latency data for one or more events.✨
• lcs(3valkey)Finds the longest common substring.✨
• lindex(3valkey)Returns an element from a list by its index.✨