From b588d1058de859819f59f88200654eb5b4a3ac7a Mon Sep 17 00:00:00 2001 From: Daniel M Date: Tue, 25 Apr 2023 11:58:55 -0400 Subject: [PATCH] Update doc --- docs/redis-commands/Redis.md | 752 +++++++++++++------------ docs/redis-commands/RedisBloom.md | 4 + docs/redis-commands/RedisGraph.md | 8 + docs/redis-commands/RedisSearch.md | 2 +- docs/redis-commands/RedisTimeSeries.md | 4 +- scripts/supported2.py | 19 +- 6 files changed, 403 insertions(+), 386 deletions(-) diff --git a/docs/redis-commands/Redis.md b/docs/redis-commands/Redis.md index e00f3f95..d5625b93 100644 --- a/docs/redis-commands/Redis.md +++ b/docs/redis-commands/Redis.md @@ -4,35 +4,35 @@ ### [BGSAVE](https://redis.io/commands/bgsave/) -Asynchronously save the dataset to disk +Asynchronously saves the database(s) to disk. ### [DBSIZE](https://redis.io/commands/dbsize/) -Return the number of keys in the selected database +Returns the number of keys in the database. ### [FLUSHALL](https://redis.io/commands/flushall/) -Remove all keys from all databases +Removes all keys from all databases. ### [FLUSHDB](https://redis.io/commands/flushdb/) -Remove all keys from the current database +Remove all keys from the current database. ### [LASTSAVE](https://redis.io/commands/lastsave/) -Get the UNIX time stamp of the last successful save to disk +Returns the Unix timestamp of the last successful save to disk. ### [SAVE](https://redis.io/commands/save/) -Synchronously save the dataset to disk +Synchronously saves the database(s) to disk. ### [SWAPDB](https://redis.io/commands/swapdb/) -Swaps two Redis databases +Swaps two Redis databases. ### [TIME](https://redis.io/commands/time/) -Return the current server time +Returns the server time. ### Unsupported server commands @@ -40,259 +40,259 @@ Return the current server time #### [ACL](https://redis.io/commands/acl/) (not implemented) -A container for Access List Control commands +A container for Access List Control commands. #### [ACL CAT](https://redis.io/commands/acl-cat/) (not implemented) -List the ACL categories or the commands inside a category +Lists the ACL categories, or the commands inside a category. #### [ACL DELUSER](https://redis.io/commands/acl-deluser/) (not implemented) -Remove the specified ACL users and the associated rules +Deletes ACL users, and terminates their connections. #### [ACL DRYRUN](https://redis.io/commands/acl-dryrun/) (not implemented) -Returns whether the user can execute the given command without executing the command. +Simulates the execution of a command by a user, without executing the command. #### [ACL GENPASS](https://redis.io/commands/acl-genpass/) (not implemented) -Generate a pseudorandom secure password to use for ACL users +Generates a pseudorandom, secure password that can be used to identify ACL users. #### [ACL GETUSER](https://redis.io/commands/acl-getuser/) (not implemented) -Get the rules for a specific ACL user +Lists the ACL rules of a user. #### [ACL HELP](https://redis.io/commands/acl-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [ACL LIST](https://redis.io/commands/acl-list/) (not implemented) -List the current ACL rules in ACL config file format +Dumps the effective rules in ACL file format. #### [ACL LOAD](https://redis.io/commands/acl-load/) (not implemented) -Reload the ACLs from the configured ACL file +Reloads the rules from the configured ACL file. #### [ACL LOG](https://redis.io/commands/acl-log/) (not implemented) -List latest events denied because of ACLs in place +Lists recent security events generated due to ACL rules. #### [ACL SAVE](https://redis.io/commands/acl-save/) (not implemented) -Save the current ACL rules in the configured ACL file +Saves the effective ACL rules in the configured ACL file. #### [ACL SETUSER](https://redis.io/commands/acl-setuser/) (not implemented) -Modify or create the rules for a specific ACL user +Creates and modifies an ACL user and its rules. #### [ACL USERS](https://redis.io/commands/acl-users/) (not implemented) -List the username of all the configured ACL rules +Lists all ACL users. #### [ACL WHOAMI](https://redis.io/commands/acl-whoami/) (not implemented) -Return the name of the user associated to the current connection +Returns the authenticated username of the current connection. #### [BGREWRITEAOF](https://redis.io/commands/bgrewriteaof/) (not implemented) -Asynchronously rewrite the append-only file +Asynchronously rewrites the append-only file to disk. #### [COMMAND](https://redis.io/commands/command/) (not implemented) -Get array of Redis command details +Returns detailed information about all commands. #### [COMMAND COUNT](https://redis.io/commands/command-count/) (not implemented) -Get total number of Redis commands +Returns a count of commands. #### [COMMAND DOCS](https://redis.io/commands/command-docs/) (not implemented) -Get array of specific Redis command documentation +Returns documentary information about a command. #### [COMMAND GETKEYS](https://redis.io/commands/command-getkeys/) (not implemented) -Extract keys given a full Redis command +Extracts the key names from an arbitrary command. #### [COMMAND GETKEYSANDFLAGS](https://redis.io/commands/command-getkeysandflags/) (not implemented) -Extract keys and access flags given a full Redis command +Extracts the key names and access flags for an arbitrary command. #### [COMMAND HELP](https://redis.io/commands/command-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [COMMAND INFO](https://redis.io/commands/command-info/) (not implemented) -Get array of specific Redis command details, or all when no argument is given. +Returns information about one, multiple or all commands. #### [COMMAND LIST](https://redis.io/commands/command-list/) (not implemented) -Get an array of Redis command names +Returns a list of command names. #### [CONFIG](https://redis.io/commands/config/) (not implemented) -A container for server configuration commands +A container for server configuration commands. #### [CONFIG GET](https://redis.io/commands/config-get/) (not implemented) -Get the values of configuration parameters +Returns the effective values of configuration parameters. #### [CONFIG HELP](https://redis.io/commands/config-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [CONFIG RESETSTAT](https://redis.io/commands/config-resetstat/) (not implemented) -Reset the stats returned by INFO +Resets the server's statistics. #### [CONFIG REWRITE](https://redis.io/commands/config-rewrite/) (not implemented) -Rewrite the configuration file with the in memory configuration +Persists the effective configuration to file. #### [CONFIG SET](https://redis.io/commands/config-set/) (not implemented) -Set configuration parameters to the given values +Sets configuration parameters in-flight. #### [DEBUG](https://redis.io/commands/debug/) (not implemented) -A container for debugging commands +A container for debugging commands. #### [FAILOVER](https://redis.io/commands/failover/) (not implemented) -Start a coordinated failover between this server and one of its replicas. +Starts a coordinated failover from a server to one of its replicas. #### [INFO](https://redis.io/commands/info/) (not implemented) -Get information and statistics about the server +Returns information and statistics about the server. #### [LATENCY](https://redis.io/commands/latency/) (not implemented) -A container for latency diagnostics commands +A container for latency diagnostics commands. #### [LATENCY DOCTOR](https://redis.io/commands/latency-doctor/) (not implemented) -Return a human readable latency analysis report. +Returns a human-readable latency analysis report. #### [LATENCY GRAPH](https://redis.io/commands/latency-graph/) (not implemented) -Return a latency graph for the event. +Returns a latency graph for an event. #### [LATENCY HELP](https://redis.io/commands/latency-help/) (not implemented) -Show helpful text about the different subcommands. +Returns helpful text about the different subcommands. #### [LATENCY HISTOGRAM](https://redis.io/commands/latency-histogram/) (not implemented) -Return the cumulative distribution of latencies of a subset of commands or all. +Returns the cumulative distribution of latencies of a subset or all commands. #### [LATENCY HISTORY](https://redis.io/commands/latency-history/) (not implemented) -Return timestamp-latency samples for the event. +Returns timestamp-latency samples for an event. #### [LATENCY LATEST](https://redis.io/commands/latency-latest/) (not implemented) -Return the latest latency samples for all events. +Returns the latest latency samples for all events. #### [LATENCY RESET](https://redis.io/commands/latency-reset/) (not implemented) -Reset latency data for one or more events. +Resets the latency data for one or more events. #### [LOLWUT](https://redis.io/commands/lolwut/) (not implemented) -Display some computer art and the Redis version +Displays computer art and the Redis version #### [MEMORY](https://redis.io/commands/memory/) (not implemented) -A container for memory diagnostics commands +A container for memory diagnostics commands. #### [MEMORY DOCTOR](https://redis.io/commands/memory-doctor/) (not implemented) -Outputs memory problems report +Outputs a memory problems report. #### [MEMORY HELP](https://redis.io/commands/memory-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [MEMORY MALLOC-STATS](https://redis.io/commands/memory-malloc-stats/) (not implemented) -Show allocator internal stats +Returns the allocator statistics. #### [MEMORY PURGE](https://redis.io/commands/memory-purge/) (not implemented) -Ask the allocator to release memory +Asks the allocator to release memory. #### [MEMORY STATS](https://redis.io/commands/memory-stats/) (not implemented) -Show memory usage details +Returns details about memory usage. #### [MEMORY USAGE](https://redis.io/commands/memory-usage/) (not implemented) -Estimate the memory usage of a key +Estimates the memory usage of a key. #### [MODULE](https://redis.io/commands/module/) (not implemented) -A container for module commands +A container for module commands. #### [MODULE HELP](https://redis.io/commands/module-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [MODULE LIST](https://redis.io/commands/module-list/) (not implemented) -List all modules loaded by the server +Returns all loaded modules. #### [MODULE LOAD](https://redis.io/commands/module-load/) (not implemented) -Load a module +Loads a module. #### [MODULE LOADEX](https://redis.io/commands/module-loadex/) (not implemented) -Load a module with extended parameters +Loads a module using extended parameters. #### [MODULE UNLOAD](https://redis.io/commands/module-unload/) (not implemented) -Unload a module +Unloads a module. #### [MONITOR](https://redis.io/commands/monitor/) (not implemented) -Listen for all requests received by the server in real time +Listens for all requests received by the server in real-time. #### [PSYNC](https://redis.io/commands/psync/) (not implemented) -Internal command used for replication +An internal command used in replication. #### [REPLCONF](https://redis.io/commands/replconf/) (not implemented) -An internal command for configuring the replication stream +An internal command for configuring the replication stream. #### [REPLICAOF](https://redis.io/commands/replicaof/) (not implemented) -Make the server a replica of another instance, or promote it as master. +Configures a server as replica of another, or promotes it to a master. #### [RESTORE-ASKING](https://redis.io/commands/restore-asking/) (not implemented) -An internal command for migrating keys in a cluster +An internal command for migrating keys in a cluster. #### [ROLE](https://redis.io/commands/role/) (not implemented) -Return the role of the instance in the context of replication +Returns the replication role. #### [SHUTDOWN](https://redis.io/commands/shutdown/) (not implemented) -Synchronously save the dataset to disk and then shut down the server +Synchronously saves the database(s) to disk and shuts down the Redis server. #### [SLAVEOF](https://redis.io/commands/slaveof/) (not implemented) -Make the server a replica of another instance, or promote it as master. +Sets a Redis server as a replica of another, or promotes it to being a master. #### [SLOWLOG](https://redis.io/commands/slowlog/) (not implemented) -A container for slow log commands +A container for slow log commands. #### [SLOWLOG GET](https://redis.io/commands/slowlog-get/) (not implemented) -Get the slow log's entries +Returns the slow log's entries. #### [SLOWLOG HELP](https://redis.io/commands/slowlog-help/) (not implemented) @@ -300,110 +300,107 @@ Show helpful text about the different subcommands #### [SLOWLOG LEN](https://redis.io/commands/slowlog-len/) (not implemented) -Get the slow log's length +Returns the number of entries in the slow log. #### [SLOWLOG RESET](https://redis.io/commands/slowlog-reset/) (not implemented) -Clear all entries from the slow log +Clears all entries from the slow log. #### [SYNC](https://redis.io/commands/sync/) (not implemented) -Internal command used for replication +An internal command used in replication. ## string commands ### [APPEND](https://redis.io/commands/append/) -Append a value to a key +Appends a string to the value of a key. Creates the key if it doesn't exist. ### [DECR](https://redis.io/commands/decr/) -Decrement the integer value of a key by one +Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist. ### [DECRBY](https://redis.io/commands/decrby/) -Decrement the integer value of a key by the given number +Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist. ### [GET](https://redis.io/commands/get/) -Get the value of a key +Returns the string value of a key. ### [GETDEL](https://redis.io/commands/getdel/) -Get the value of a key and delete the key +Returns the string value of a key after deleting the key. ### [GETEX](https://redis.io/commands/getex/) -Get the value of a key and optionally set its expiration +Returns the string value of a key after setting its expiration time. ### [GETRANGE](https://redis.io/commands/getrange/) -Get a substring of the string stored at a key +Returns a substring of the string stored at a key. ### [GETSET](https://redis.io/commands/getset/) -Set the string value of a key and return its old value +Returns the previous string value of a key after setting it to a new value. ### [INCR](https://redis.io/commands/incr/) -Increment the integer value of a key by one +Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist. ### [INCRBY](https://redis.io/commands/incrby/) -Increment the integer value of a key by the given amount +Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist. ### [INCRBYFLOAT](https://redis.io/commands/incrbyfloat/) -Increment the float value of a key by the given amount +Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist. ### [LCS](https://redis.io/commands/lcs/) -Find longest common substring +Finds the longest common substring. ### [MGET](https://redis.io/commands/mget/) -Get the values of all the given keys +Atomically returns the string values of one or more keys. ### [MSET](https://redis.io/commands/mset/) -Set multiple keys to multiple values +Atomically creates or modifies the string values of one or more keys. ### [MSETNX](https://redis.io/commands/msetnx/) -Set multiple keys to multiple values, only if none of the keys exist +Atomically modifies the string values of one or more keys only when all keys don't exist. ### [PSETEX](https://redis.io/commands/psetex/) -Set the value and expiration in milliseconds of a key +Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn't exist. ### [SET](https://redis.io/commands/set/) -Set the string value of a key +Sets the string value of a key, ignoring its type. The key is created if it doesn't exist. ### [SETEX](https://redis.io/commands/setex/) -Set the value and expiration of a key +Sets the string value and expiration time of a key. Creates the key if it doesn't exist. ### [SETNX](https://redis.io/commands/setnx/) -Set the value of a key, only if the key does not exist +Set the string value of a key only when the key doesn't exist. ### [SETRANGE](https://redis.io/commands/setrange/) -Overwrite part of a string at key starting at the specified offset +Overwrites a part of a string value with another by an offset. Creates the key if it doesn't exist. ### [STRLEN](https://redis.io/commands/strlen/) -Get the length of the value stored in a key +Returns the length of a string value. ### [SUBSTR](https://redis.io/commands/substr/) -Get a substring of the string stored at a key - +Returns a substring from a string value. -### Unsupported string commands -> To implement support for a command, see [here](/guides/implement-command/) @@ -412,39 +409,39 @@ Get a substring of the string stored at a key #### [ASKING](https://redis.io/commands/asking/) (not implemented) -Sent by cluster clients after an -ASK redirect +Signals that a cluster client is following an -ASK redirect. #### [CLUSTER](https://redis.io/commands/cluster/) (not implemented) -A container for cluster commands +A container for Redis Cluster commands. #### [CLUSTER ADDSLOTS](https://redis.io/commands/cluster-addslots/) (not implemented) -Assign new hash slots to receiving node +Assigns new hash slots to a node. #### [CLUSTER ADDSLOTSRANGE](https://redis.io/commands/cluster-addslotsrange/) (not implemented) -Assign new hash slots to receiving node +Assigns new hash slot ranges to a node. #### [CLUSTER BUMPEPOCH](https://redis.io/commands/cluster-bumpepoch/) (not implemented) -Advance the cluster config epoch +Advances the cluster config epoch. #### [CLUSTER COUNT-FAILURE-REPORTS](https://redis.io/commands/cluster-count-failure-reports/) (not implemented) -Return the number of failure reports active for a given node +Returns the number of active failure reports active for a node. #### [CLUSTER COUNTKEYSINSLOT](https://redis.io/commands/cluster-countkeysinslot/) (not implemented) -Return the number of local keys in the specified hash slot +Returns the number of keys in a hash slot. #### [CLUSTER DELSLOTS](https://redis.io/commands/cluster-delslots/) (not implemented) -Set hash slots as unbound in receiving node +Sets hash slots as unbound for a node. #### [CLUSTER DELSLOTSRANGE](https://redis.io/commands/cluster-delslotsrange/) (not implemented) -Set hash slots as unbound in receiving node +Sets hash slot ranges as unbound for a node. #### [CLUSTER FAILOVER](https://redis.io/commands/cluster-failover/) (not implemented) @@ -452,102 +449,106 @@ Forces a replica to perform a manual failover of its master. #### [CLUSTER FLUSHSLOTS](https://redis.io/commands/cluster-flushslots/) (not implemented) -Delete a node's own slots information +Deletes all slots information from a node. #### [CLUSTER FORGET](https://redis.io/commands/cluster-forget/) (not implemented) -Remove a node from the nodes table +Removes a node from the nodes table. #### [CLUSTER GETKEYSINSLOT](https://redis.io/commands/cluster-getkeysinslot/) (not implemented) -Return local key names in the specified hash slot +Returns the key names in a hash slot. #### [CLUSTER HELP](https://redis.io/commands/cluster-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [CLUSTER INFO](https://redis.io/commands/cluster-info/) (not implemented) -Provides info about Redis Cluster node state +Returns information about the state of a node. #### [CLUSTER KEYSLOT](https://redis.io/commands/cluster-keyslot/) (not implemented) -Returns the hash slot of the specified key +Returns the hash slot for a key. #### [CLUSTER LINKS](https://redis.io/commands/cluster-links/) (not implemented) -Returns a list of all TCP links to and from peer nodes in cluster +Returns a list of all TCP links to and from peer nodes. #### [CLUSTER MEET](https://redis.io/commands/cluster-meet/) (not implemented) -Force a node cluster to handshake with another node +Forces a node to handshake with another node. #### [CLUSTER MYID](https://redis.io/commands/cluster-myid/) (not implemented) -Return the node id +Returns the ID of a node. + +#### [CLUSTER MYSHARDID](https://redis.io/commands/cluster-myshardid/) (not implemented) + +Returns the shard ID of a node. #### [CLUSTER NODES](https://redis.io/commands/cluster-nodes/) (not implemented) -Get Cluster config for the node +Returns the cluster configuration for a node. #### [CLUSTER REPLICAS](https://redis.io/commands/cluster-replicas/) (not implemented) -List replica nodes of the specified master node +Lists the replica nodes of a master node. #### [CLUSTER REPLICATE](https://redis.io/commands/cluster-replicate/) (not implemented) -Reconfigure a node as a replica of the specified master node +Configure a node as replica of a master node. #### [CLUSTER RESET](https://redis.io/commands/cluster-reset/) (not implemented) -Reset a Redis Cluster node +Resets a node. #### [CLUSTER SAVECONFIG](https://redis.io/commands/cluster-saveconfig/) (not implemented) -Forces the node to save cluster state on disk +Forces a node to save the cluster configuration to disk. #### [CLUSTER SET-CONFIG-EPOCH](https://redis.io/commands/cluster-set-config-epoch/) (not implemented) -Set the configuration epoch in a new node +Sets the configuration epoch for a new node. #### [CLUSTER SETSLOT](https://redis.io/commands/cluster-setslot/) (not implemented) -Bind a hash slot to a specific node +Binds a hash slot to a node. #### [CLUSTER SHARDS](https://redis.io/commands/cluster-shards/) (not implemented) -Get array of cluster slots to node mappings +Returns the mapping of cluster slots to shards. #### [CLUSTER SLAVES](https://redis.io/commands/cluster-slaves/) (not implemented) -List replica nodes of the specified master node +Lists the replica nodes of a master node. #### [CLUSTER SLOTS](https://redis.io/commands/cluster-slots/) (not implemented) -Get array of Cluster slot to node mappings +Returns the mapping of cluster slots to nodes. #### [READONLY](https://redis.io/commands/readonly/) (not implemented) -Enables read queries for a connection to a cluster replica node +Enables read-only queries for a connection to a Redis Cluster replica node. #### [READWRITE](https://redis.io/commands/readwrite/) (not implemented) -Disables read queries for a connection to a cluster replica node +Enables read-write queries for a connection to a Reids Cluster replica node. ## connection commands ### [ECHO](https://redis.io/commands/echo/) -Echo the given string +Returns the given string. ### [PING](https://redis.io/commands/ping/) -Ping the server +Returns the server's liveliness response. ### [SELECT](https://redis.io/commands/select/) -Change the selected database for the current connection +Changes the selected database. ### Unsupported connection commands @@ -555,110 +556,118 @@ Change the selected database for the current connection #### [AUTH](https://redis.io/commands/auth/) (not implemented) -Authenticate to the server +Authenticates the connection. #### [CLIENT](https://redis.io/commands/client/) (not implemented) -A container for client connection commands +A container for client connection commands. #### [CLIENT CACHING](https://redis.io/commands/client-caching/) (not implemented) -Instruct the server about tracking or not keys in the next request +Instructs the server whether to track the keys in the next request. #### [CLIENT GETNAME](https://redis.io/commands/client-getname/) (not implemented) -Get the current connection name +Returns the name of the connection. #### [CLIENT GETREDIR](https://redis.io/commands/client-getredir/) (not implemented) -Get tracking notifications redirection client ID if any +Returns the client ID to which the connection's tracking notifications are redirected. #### [CLIENT HELP](https://redis.io/commands/client-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [CLIENT ID](https://redis.io/commands/client-id/) (not implemented) -Returns the client ID for the current connection +Returns the unique client ID of the connection. #### [CLIENT INFO](https://redis.io/commands/client-info/) (not implemented) -Returns information about the current client connection. +Returns information about the connection. #### [CLIENT KILL](https://redis.io/commands/client-kill/) (not implemented) -Kill the connection of a client +Terminates open connections. #### [CLIENT LIST](https://redis.io/commands/client-list/) (not implemented) -Get the list of client connections +Lists open connections. #### [CLIENT NO-EVICT](https://redis.io/commands/client-no-evict/) (not implemented) -Set client eviction mode for the current connection +Sets the client eviction mode of the connection. + +#### [CLIENT NO-TOUCH](https://redis.io/commands/client-no-touch/) (not implemented) + +Controls whether commands sent by the client affect the LRU/LFU of accessed keys. #### [CLIENT PAUSE](https://redis.io/commands/client-pause/) (not implemented) -Stop processing commands from clients for some time +Suspends commands processing. #### [CLIENT REPLY](https://redis.io/commands/client-reply/) (not implemented) -Instruct the server whether to reply to commands +Instructs the server whether to reply to commands. + +#### [CLIENT SETINFO](https://redis.io/commands/client-setinfo/) (not implemented) + +Sets information specific to the client or connection. #### [CLIENT SETNAME](https://redis.io/commands/client-setname/) (not implemented) -Set the current connection name +Sets the connection name. #### [CLIENT TRACKING](https://redis.io/commands/client-tracking/) (not implemented) -Enable or disable server assisted client side caching support +Controls server-assisted client-side caching for the connection. #### [CLIENT TRACKINGINFO](https://redis.io/commands/client-trackinginfo/) (not implemented) -Return information about server assisted client side caching for the current connection +Returns information about server-assisted client-side caching for the connection. #### [CLIENT UNBLOCK](https://redis.io/commands/client-unblock/) (not implemented) -Unblock a client blocked in a blocking command from a different connection +Unblocks a client blocked by a blocking command from a different connection. #### [CLIENT UNPAUSE](https://redis.io/commands/client-unpause/) (not implemented) -Resume processing of clients that were paused +Resumes processing commands from paused clients. #### [HELLO](https://redis.io/commands/hello/) (not implemented) -Handshake with Redis +Handshakes with the Redis server. #### [QUIT](https://redis.io/commands/quit/) (not implemented) -Close the connection +Closes the connection. #### [RESET](https://redis.io/commands/reset/) (not implemented) -Reset the connection +Resets the connection. ## bitmap commands ### [BITCOUNT](https://redis.io/commands/bitcount/) -Count set bits in a string +Counts the number of set bits (population counting) in a string. ### [BITOP](https://redis.io/commands/bitop/) -Perform bitwise operations between strings +Performs bitwise operations on multiple strings, and stores the result. ### [BITPOS](https://redis.io/commands/bitpos/) -Find first bit set or clear in a string +Finds the first set (1) or clear (0) bit in a string. ### [GETBIT](https://redis.io/commands/getbit/) -Returns the bit value at offset in the string value stored at key +Returns a bit value by offset. ### [SETBIT](https://redis.io/commands/setbit/) -Sets or clears the bit at offset in the string value stored at key +Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist. ### Unsupported bitmap commands @@ -666,86 +675,86 @@ Sets or clears the bit at offset in the string value stored at key #### [BITFIELD](https://redis.io/commands/bitfield/) (not implemented) -Perform arbitrary bitfield integer operations on strings +Performs arbitrary bitfield integer operations on strings. #### [BITFIELD_RO](https://redis.io/commands/bitfield_ro/) (not implemented) -Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD +Performs arbitrary read-only bitfield integer operations on strings. ## list commands ### [BLPOP](https://redis.io/commands/blpop/) -Remove and get the first element in a list, or block until one is available +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](https://redis.io/commands/brpop/) -Remove and get the last element in a list, or block until one is available +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](https://redis.io/commands/brpoplpush/) -Pop an element from a list, push it to another list and return it; or block until one is available +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. ### [LINDEX](https://redis.io/commands/lindex/) -Get an element from a list by its index +Returns an element from a list by its index. ### [LINSERT](https://redis.io/commands/linsert/) -Insert an element before or after another element in a list +Inserts an element before or after another element in a list. ### [LLEN](https://redis.io/commands/llen/) -Get the length of a list +Returns the length of a list. ### [LMOVE](https://redis.io/commands/lmove/) -Pop an element from a list, push it to another list and return it +Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved. ### [LPOP](https://redis.io/commands/lpop/) -Remove and get the first elements in a list +Returns the first elements in a list after removing it. Deletes the list if the last element was popped. ### [LPUSH](https://redis.io/commands/lpush/) -Prepend one or multiple elements to a list +Prepends one or more elements to a list. Creates the key if it doesn't exist. ### [LPUSHX](https://redis.io/commands/lpushx/) -Prepend an element to a list, only if the list exists +Prepends one or more elements to a list only when the list exists. ### [LRANGE](https://redis.io/commands/lrange/) -Get a range of elements from a list +Returns a range of elements from a list. ### [LREM](https://redis.io/commands/lrem/) -Remove elements from a list +Removes elements from a list. Deletes the list if the last element was removed. ### [LSET](https://redis.io/commands/lset/) -Set the value of an element in a list by its index +Sets the value of an element in a list by its index. ### [LTRIM](https://redis.io/commands/ltrim/) -Trim a list to the specified range +Removes elements from both ends a list. Deletes the list if all elements were trimmed. ### [RPOP](https://redis.io/commands/rpop/) -Remove and get the last elements in a list +Returns and removes the last elements of a list. Deletes the list if the last element was popped. ### [RPOPLPUSH](https://redis.io/commands/rpoplpush/) -Remove the last element in a list, prepend it to another list and return it +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](https://redis.io/commands/rpush/) -Append one or multiple elements to a list +Appends one or more elements to a list. Creates the key if it doesn't exist. ### [RPUSHX](https://redis.io/commands/rpushx/) -Append an element to a list, only if the list exists +Appends an element to a list only when the list exists. ### Unsupported list commands @@ -753,126 +762,126 @@ Append an element to a list, only if the list exists #### [BLMOVE](https://redis.io/commands/blmove/) (not implemented) -Pop an element from a list, push it to another list and return it; or block until one is available +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](https://redis.io/commands/blmpop/) (not implemented) -Pop elements from a list, or block until one is available +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. #### [LMPOP](https://redis.io/commands/lmpop/) (not implemented) -Pop elements from a list +Returns multiple elements from a list after removing them. Deletes the list if the last element was popped. #### [LPOS](https://redis.io/commands/lpos/) (not implemented) -Return the index of matching elements on a list +Returns the index of matching elements in a list. ## sorted-set commands ### [BZPOPMAX](https://redis.io/commands/bzpopmax/) -Remove and return the member with the highest score from one or more sorted sets, or block until one is available +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](https://redis.io/commands/bzpopmin/) -Remove and return the member with the lowest score from one or more sorted sets, or block until one is available +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. ### [ZADD](https://redis.io/commands/zadd/) -Add one or more members to a sorted set, or update its score if it already exists +Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn't exist. ### [ZCARD](https://redis.io/commands/zcard/) -Get the number of members in a sorted set +Returns the number of members in a sorted set. ### [ZCOUNT](https://redis.io/commands/zcount/) -Count the members in a sorted set with scores within the given values +Returns the count of members in a sorted set that have scores within a range. ### [ZINCRBY](https://redis.io/commands/zincrby/) -Increment the score of a member in a sorted set +Increments the score of a member in a sorted set. ### [ZINTERSTORE](https://redis.io/commands/zinterstore/) -Intersect multiple sorted sets and store the resulting sorted set in a new key +Stores the intersect of multiple sorted sets in a key. ### [ZLEXCOUNT](https://redis.io/commands/zlexcount/) -Count the number of members in a sorted set between a given lexicographical range +Returns the number of members in a sorted set within a lexicographical range. ### [ZMSCORE](https://redis.io/commands/zmscore/) -Get the score associated with the given members in a sorted set +Returns the score of one or more members in a sorted set. ### [ZPOPMAX](https://redis.io/commands/zpopmax/) -Remove and return members with the highest scores in a sorted set +Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped. ### [ZPOPMIN](https://redis.io/commands/zpopmin/) -Remove and return members with the lowest scores in a sorted set +Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped. ### [ZRANGE](https://redis.io/commands/zrange/) -Return a range of members in a sorted set +Returns members in a sorted set within a range of indexes. ### [ZRANGEBYLEX](https://redis.io/commands/zrangebylex/) -Return a range of members in a sorted set, by lexicographical range +Returns members in a sorted set within a lexicographical range. ### [ZRANGEBYSCORE](https://redis.io/commands/zrangebyscore/) -Return a range of members in a sorted set, by score +Returns members in a sorted set within a range of scores. ### [ZRANK](https://redis.io/commands/zrank/) -Determine the index of a member in a sorted set +Returns the index of a member in a sorted set ordered by ascending scores. ### [ZREM](https://redis.io/commands/zrem/) -Remove one or more members from a sorted set +Removes one or more members from a sorted set. Deletes the sorted set if all members were removed. ### [ZREMRANGEBYLEX](https://redis.io/commands/zremrangebylex/) -Remove all members in a sorted set between the given lexicographical range +Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed. ### [ZREMRANGEBYRANK](https://redis.io/commands/zremrangebyrank/) -Remove all members in a sorted set within the given indexes +Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed. ### [ZREMRANGEBYSCORE](https://redis.io/commands/zremrangebyscore/) -Remove all members in a sorted set within the given scores +Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed. ### [ZREVRANGE](https://redis.io/commands/zrevrange/) -Return a range of members in a sorted set, by index, with scores ordered from high to low +Returns members in a sorted set within a range of indexes in reverse order. ### [ZREVRANGEBYLEX](https://redis.io/commands/zrevrangebylex/) -Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings. +Returns members in a sorted set within a lexicographical range in reverse order. ### [ZREVRANGEBYSCORE](https://redis.io/commands/zrevrangebyscore/) -Return a range of members in a sorted set, by score, with scores ordered from high to low +Returns members in a sorted set within a range of scores in reverse order. ### [ZREVRANK](https://redis.io/commands/zrevrank/) -Determine the index of a member in a sorted set, with scores ordered from high to low +Returns the index of a member in a sorted set ordered by descending scores. ### [ZSCAN](https://redis.io/commands/zscan/) -Incrementally iterate sorted sets elements and associated scores +Iterates over members and scores of a sorted set. ### [ZSCORE](https://redis.io/commands/zscore/) -Get the score associated with the given member in a sorted set +Returns the score of a member in a sorted set. ### [ZUNIONSTORE](https://redis.io/commands/zunionstore/) -Add multiple sorted sets and store the resulting sorted set in a new key +Stores the union of multiple sorted sets in a key. ### Unsupported sorted-set commands @@ -880,122 +889,122 @@ Add multiple sorted sets and store the resulting sorted set in a new key #### [BZMPOP](https://redis.io/commands/bzmpop/) (not implemented) -Remove and return members with scores in a sorted set or block until one is available +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. #### [ZDIFF](https://redis.io/commands/zdiff/) (not implemented) -Subtract multiple sorted sets +Returns the difference between multiple sorted sets. #### [ZDIFFSTORE](https://redis.io/commands/zdiffstore/) (not implemented) -Subtract multiple sorted sets and store the resulting sorted set in a new key +Stores the difference of multiple sorted sets in a key. #### [ZINTER](https://redis.io/commands/zinter/) (not implemented) -Intersect multiple sorted sets +Returns the intersect of multiple sorted sets. #### [ZINTERCARD](https://redis.io/commands/zintercard/) (not implemented) -Intersect multiple sorted sets and return the cardinality of the result +Returns the number of members of the intersect of multiple sorted sets. #### [ZMPOP](https://redis.io/commands/zmpop/) (not implemented) -Remove and return members with scores in a sorted set +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. #### [ZRANDMEMBER](https://redis.io/commands/zrandmember/) (not implemented) -Get one or multiple random elements from a sorted set +Returns one or more random members from a sorted set. #### [ZRANGESTORE](https://redis.io/commands/zrangestore/) (not implemented) -Store a range of members from sorted set into another key +Stores a range of members from sorted set in a key. #### [ZUNION](https://redis.io/commands/zunion/) (not implemented) -Add multiple sorted sets +Returns the union of multiple sorted sets. ## generic commands ### [DEL](https://redis.io/commands/del/) -Delete a key +Deletes one or more keys. ### [DUMP](https://redis.io/commands/dump/) -Return a serialized version of the value stored at the specified key. +Returns a serialized representation of the value stored at a key. ### [EXISTS](https://redis.io/commands/exists/) -Determine if a key exists +Determines whether one or more keys exist. ### [EXPIRE](https://redis.io/commands/expire/) -Set a key's time to live in seconds +Sets the expiration time of a key in seconds. ### [EXPIREAT](https://redis.io/commands/expireat/) -Set the expiration for a key as a UNIX timestamp +Sets the expiration time of a key to a Unix timestamp. ### [KEYS](https://redis.io/commands/keys/) -Find all keys matching the given pattern +Returns all key names that match a pattern. ### [MOVE](https://redis.io/commands/move/) -Move a key to another database +Moves a key to another database. ### [PERSIST](https://redis.io/commands/persist/) -Remove the expiration from a key +Removes the expiration time of a key. ### [PEXPIRE](https://redis.io/commands/pexpire/) -Set a key's time to live in milliseconds +Sets the expiration time of a key in milliseconds. ### [PEXPIREAT](https://redis.io/commands/pexpireat/) -Set the expiration for a key as a UNIX timestamp specified in milliseconds +Sets the expiration time of a key to a Unix milliseconds timestamp. ### [PTTL](https://redis.io/commands/pttl/) -Get the time to live for a key in milliseconds +Returns the expiration time in milliseconds of a key. ### [RANDOMKEY](https://redis.io/commands/randomkey/) -Return a random key from the keyspace +Returns a random key name from the database. ### [RENAME](https://redis.io/commands/rename/) -Rename a key +Renames a key and overwrites the destination. ### [RENAMENX](https://redis.io/commands/renamenx/) -Rename a key, only if the new key does not exist +Renames a key only when the target key name doesn't exist. ### [RESTORE](https://redis.io/commands/restore/) -Create a key using the provided serialized value, previously obtained using DUMP. +Creates a key from the serialized representation of a value. ### [SCAN](https://redis.io/commands/scan/) -Incrementally iterate the keys space +Iterates over the key names in the database. ### [SORT](https://redis.io/commands/sort/) -Sort the elements in a list, set or sorted set +Sorts the elements in a list, a set, or a sorted set, optionally storing the result. ### [TTL](https://redis.io/commands/ttl/) -Get the time to live for a key in seconds +Returns the expiration time in seconds of a key. ### [TYPE](https://redis.io/commands/type/) -Determine the type stored at key +Determines the type of value stored at a key. ### [UNLINK](https://redis.io/commands/unlink/) -Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking. +Asynchronously deletes one or more keys. ### Unsupported generic commands @@ -1003,113 +1012,114 @@ Delete a key asynchronously in another thread. Otherwise it is just as DEL, but #### [COPY](https://redis.io/commands/copy/) (not implemented) -Copy a key +Copies the value of a key to a new key. #### [EXPIRETIME](https://redis.io/commands/expiretime/) (not implemented) -Get the expiration Unix timestamp for a key +Returns the expiration time of a key as a Unix timestamp. #### [MIGRATE](https://redis.io/commands/migrate/) (not implemented) -Atomically transfer a key from a Redis instance to another one. +Atomically transfers a key from one Redis instance to another. #### [OBJECT](https://redis.io/commands/object/) (not implemented) -A container for object introspection commands +A container for object introspection commands. #### [OBJECT ENCODING](https://redis.io/commands/object-encoding/) (not implemented) -Inspect the internal encoding of a Redis object +Returns the internal encoding of a Redis object. #### [OBJECT FREQ](https://redis.io/commands/object-freq/) (not implemented) -Get the logarithmic access frequency counter of a Redis object +Returns the logarithmic access frequency counter of a Redis object. #### [OBJECT HELP](https://redis.io/commands/object-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [OBJECT IDLETIME](https://redis.io/commands/object-idletime/) (not implemented) -Get the time since a Redis object was last accessed +Returns the time since the last access to a Redis object. #### [OBJECT REFCOUNT](https://redis.io/commands/object-refcount/) (not implemented) -Get the number of references to the value of the key +Returns the reference count of a value of a key. #### [PEXPIRETIME](https://redis.io/commands/pexpiretime/) (not implemented) -Get the expiration Unix timestamp for a key in milliseconds +Returns the expiration time of a key as a Unix milliseconds timestamp. #### [SORT_RO](https://redis.io/commands/sort_ro/) (not implemented) -Sort the elements in a list, set or sorted set. Read-only variant of SORT. +Returns the sorted elements of a list, a set, or a sorted set. #### [TOUCH](https://redis.io/commands/touch/) (not implemented) -Alters the last access time of a key(s). Returns the number of existing keys specified. +Returns the number of existing keys out of those specified after updating the time they were last accessed. #### [WAIT](https://redis.io/commands/wait/) (not implemented) -Wait for the synchronous replication of all the write commands sent in the context of the current connection +Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed. + +#### [WAITAOF](https://redis.io/commands/waitaof/) (not implemented) + +Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the master and/or replicas. ## transactions commands ### [DISCARD](https://redis.io/commands/discard/) -Discard all commands issued after MULTI +Discards a transaction. ### [EXEC](https://redis.io/commands/exec/) -Execute all commands issued after MULTI +Executes all commands in a transaction. ### [MULTI](https://redis.io/commands/multi/) -Mark the start of a transaction block +Starts a transaction. ### [UNWATCH](https://redis.io/commands/unwatch/) -Forget about all watched keys +Forgets about watched keys of a transaction. ### [WATCH](https://redis.io/commands/watch/) -Watch the given keys to determine execution of the MULTI/EXEC block +Monitors changes to keys to determine the execution of a transaction. -### Unsupported transactions commands -> To implement support for a command, see [here](/guides/implement-command/) - ## scripting commands ### [EVAL](https://redis.io/commands/eval/) -Execute a Lua script server side +Executes a server-side Lua script. ### [EVALSHA](https://redis.io/commands/evalsha/) -Execute a Lua script server side +Executes a server-side Lua script by SHA1 digest. ### [SCRIPT](https://redis.io/commands/script/) -A container for Lua scripts management commands +A container for Lua scripts management commands. ### [SCRIPT EXISTS](https://redis.io/commands/script-exists/) -Check existence of scripts in the script cache. +Determines whether server-side Lua scripts exist in the script cache. ### [SCRIPT FLUSH](https://redis.io/commands/script-flush/) -Remove all the scripts from the script cache. +Removes all server-side Lua scripts from the script cache. ### [SCRIPT HELP](https://redis.io/commands/script-help/) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. ### [SCRIPT LOAD](https://redis.io/commands/script-load/) -Load the specified Lua script into the script cache. +Loads a server-side Lua script to the script cache. ### Unsupported scripting commands @@ -1117,177 +1127,174 @@ Load the specified Lua script into the script cache. #### [EVALSHA_RO](https://redis.io/commands/evalsha_ro/) (not implemented) -Execute a read-only Lua script server side +Executes a read-only server-side Lua script by SHA1 digest. #### [EVAL_RO](https://redis.io/commands/eval_ro/) (not implemented) -Execute a read-only Lua script server side +Executes a read-only server-side Lua script. #### [FCALL](https://redis.io/commands/fcall/) (not implemented) -Invoke a function +Invokes a function. #### [FCALL_RO](https://redis.io/commands/fcall_ro/) (not implemented) -Invoke a read-only function +Invokes a read-only function. #### [FUNCTION](https://redis.io/commands/function/) (not implemented) -A container for function commands +A container for function commands. #### [FUNCTION DELETE](https://redis.io/commands/function-delete/) (not implemented) -Delete a function by name +Deletes a library and its functions. #### [FUNCTION DUMP](https://redis.io/commands/function-dump/) (not implemented) -Dump all functions into a serialized binary payload +Dumps all libraries into a serialized binary payload. #### [FUNCTION FLUSH](https://redis.io/commands/function-flush/) (not implemented) -Deleting all functions +Deletes all libraries and functions. #### [FUNCTION HELP](https://redis.io/commands/function-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [FUNCTION KILL](https://redis.io/commands/function-kill/) (not implemented) -Kill the function currently in execution. +Terminates a function during execution. #### [FUNCTION LIST](https://redis.io/commands/function-list/) (not implemented) -List information about all the functions +Returns information about all libraries. #### [FUNCTION LOAD](https://redis.io/commands/function-load/) (not implemented) -Create a function with the given arguments (name, code, description) +Creates a library. #### [FUNCTION RESTORE](https://redis.io/commands/function-restore/) (not implemented) -Restore all the functions on the given payload +Restores all libraries from a payload. #### [FUNCTION STATS](https://redis.io/commands/function-stats/) (not implemented) -Return information about the function currently running (name, description, duration) +Returns information about a function during execution. #### [SCRIPT DEBUG](https://redis.io/commands/script-debug/) (not implemented) -Set the debug mode for executed scripts. +Sets the debug mode of server-side Lua scripts. #### [SCRIPT KILL](https://redis.io/commands/script-kill/) (not implemented) -Kill the script currently in execution. +Terminates a server-side Lua script during execution. ## geo commands ### [GEOADD](https://redis.io/commands/geoadd/) -Add one or more geospatial items in the geospatial index represented using a sorted set +Adds one or more members to a geospatial index. The key is created if it doesn't exist. ### [GEODIST](https://redis.io/commands/geodist/) -Returns the distance between two members of a geospatial index +Returns the distance between two members of a geospatial index. ### [GEOHASH](https://redis.io/commands/geohash/) -Returns members of a geospatial index as standard geohash strings +Returns members from a geospatial index as geohash strings. ### [GEOPOS](https://redis.io/commands/geopos/) -Returns longitude and latitude of members of a geospatial index +Returns the longitude and latitude of members from a geospatial index. ### [GEORADIUS](https://redis.io/commands/georadius/) -Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point +Queries a geospatial index for members within a distance from a coordinate, optionally stores the result. ### [GEORADIUSBYMEMBER](https://redis.io/commands/georadiusbymember/) -Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member +Queries a geospatial index for members within a distance from a member, optionally stores the result. ### [GEORADIUSBYMEMBER_RO](https://redis.io/commands/georadiusbymember_ro/) -A read-only variant for GEORADIUSBYMEMBER +Returns members from a geospatial index that are within a distance from a member. ### [GEORADIUS_RO](https://redis.io/commands/georadius_ro/) -A read-only variant for GEORADIUS +Returns members from a geospatial index that are within a distance from a coordinate. ### [GEOSEARCH](https://redis.io/commands/geosearch/) -Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle. +Queries a geospatial index for members inside an area of a box or a circle. ### [GEOSEARCHSTORE](https://redis.io/commands/geosearchstore/) -Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key. +Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result. -### Unsupported geo commands -> To implement support for a command, see [here](/guides/implement-command/) - ## hash commands ### [HDEL](https://redis.io/commands/hdel/) -Delete one or more hash fields +Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain. ### [HEXISTS](https://redis.io/commands/hexists/) -Determine if a hash field exists +Determines whether a field exists in a hash. ### [HGET](https://redis.io/commands/hget/) -Get the value of a hash field +Returns the value of a field in a hash. ### [HGETALL](https://redis.io/commands/hgetall/) -Get all the fields and values in a hash +Returns all fields and values in a hash. ### [HINCRBY](https://redis.io/commands/hincrby/) -Increment the integer value of a hash field by the given number +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](https://redis.io/commands/hincrbyfloat/) -Increment the float value of a hash field by the given amount +Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn't exist. ### [HKEYS](https://redis.io/commands/hkeys/) -Get all the fields in a hash +Returns all fields in a hash. ### [HLEN](https://redis.io/commands/hlen/) -Get the number of fields in a hash +Returns the number of fields in a hash. ### [HMGET](https://redis.io/commands/hmget/) -Get the values of all the given hash fields +Returns the values of all fields in a hash. ### [HMSET](https://redis.io/commands/hmset/) -Set multiple hash fields to multiple values +Sets the values of multiple fields. ### [HSCAN](https://redis.io/commands/hscan/) -Incrementally iterate hash fields and associated values +Iterates over fields and values of a hash. ### [HSET](https://redis.io/commands/hset/) -Set the string value of a hash field +Creates or modifies the value of a field in a hash. ### [HSETNX](https://redis.io/commands/hsetnx/) -Set the value of a hash field, only if the field does not exist +Sets the value of a field in a hash only when the field doesn't exist. ### [HSTRLEN](https://redis.io/commands/hstrlen/) -Get the length of the value of a hash field +Returns the length of the value of a field. ### [HVALS](https://redis.io/commands/hvals/) -Get all the values in a hash +Returns all values in a hash. ### Unsupported hash commands @@ -1295,22 +1302,22 @@ Get all the values in a hash #### [HRANDFIELD](https://redis.io/commands/hrandfield/) (not implemented) -Get one or multiple random fields from a hash +Returns one or more random fields from a hash. ## hyperloglog commands ### [PFADD](https://redis.io/commands/pfadd/) -Adds the specified elements to the specified HyperLogLog. +Adds elements to a HyperLogLog key. Creates the key if it doesn't exist. ### [PFCOUNT](https://redis.io/commands/pfcount/) -Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s). +Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s). ### [PFMERGE](https://redis.io/commands/pfmerge/) -Merge N different HyperLogLogs into a single one. +Merges one or more HyperLogLog values into a single key. ### Unsupported hyperloglog commands @@ -1318,50 +1325,50 @@ Merge N different HyperLogLogs into a single one. #### [PFDEBUG](https://redis.io/commands/pfdebug/) (not implemented) -Internal commands for debugging HyperLogLog values +Internal commands for debugging HyperLogLog values. #### [PFSELFTEST](https://redis.io/commands/pfselftest/) (not implemented) -An internal command for testing HyperLogLog values +An internal command for testing HyperLogLog values. ## pubsub commands ### [PSUBSCRIBE](https://redis.io/commands/psubscribe/) -Listen for messages published to channels matching the given patterns +Listens for messages published to channels that match one or more patterns. ### [PUBLISH](https://redis.io/commands/publish/) -Post a message to a channel +Posts a message to a channel. ### [PUBSUB](https://redis.io/commands/pubsub/) -A container for Pub/Sub commands +A container for Pub/Sub commands. ### [PUBSUB CHANNELS](https://redis.io/commands/pubsub-channels/) -List active channels +Returns the active channels. ### [PUBSUB HELP](https://redis.io/commands/pubsub-help/) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. ### [PUBSUB NUMSUB](https://redis.io/commands/pubsub-numsub/) -Get the count of subscribers for channels +Returns a count of subscribers to channels. ### [PUNSUBSCRIBE](https://redis.io/commands/punsubscribe/) -Stop listening for messages posted to channels matching the given patterns +Stops listening to messages published to channels that match one or more patterns. ### [SUBSCRIBE](https://redis.io/commands/subscribe/) -Listen for messages published to the given channels +Listens for messages published to channels. ### [UNSUBSCRIBE](https://redis.io/commands/unsubscribe/) -Stop listening for messages posted to the given channels +Stops listening to messages posted to channels. ### Unsupported pubsub commands @@ -1369,15 +1376,15 @@ Stop listening for messages posted to the given channels #### [PUBSUB NUMPAT](https://redis.io/commands/pubsub-numpat/) (not implemented) -Get the count of unique patterns pattern subscriptions +Returns a count of unique pattern subscriptions. #### [PUBSUB SHARDCHANNELS](https://redis.io/commands/pubsub-shardchannels/) (not implemented) -List active shard channels +Returns the active shard channels. #### [PUBSUB SHARDNUMSUB](https://redis.io/commands/pubsub-shardnumsub/) (not implemented) -Get the count of subscribers for shard channels +Returns the count of subscribers of shard channels. #### [SPUBLISH](https://redis.io/commands/spublish/) (not implemented) @@ -1385,62 +1392,62 @@ Post a message to a shard channel #### [SSUBSCRIBE](https://redis.io/commands/ssubscribe/) (not implemented) -Listen for messages published to the given shard channels +Listens for messages published to shard channels. #### [SUNSUBSCRIBE](https://redis.io/commands/sunsubscribe/) (not implemented) -Stop listening for messages posted to the given shard channels +Stops listening to messages posted to shard channels. ## set commands ### [SADD](https://redis.io/commands/sadd/) -Add one or more members to a set +Adds one or more members to a set. Creates the key if it doesn't exist. ### [SCARD](https://redis.io/commands/scard/) -Get the number of members in a set +Returns the number of members in a set. ### [SDIFF](https://redis.io/commands/sdiff/) -Subtract multiple sets +Returns the difference of multiple sets. ### [SDIFFSTORE](https://redis.io/commands/sdiffstore/) -Subtract multiple sets and store the resulting set in a key +Stores the difference of multiple sets in a key. ### [SINTER](https://redis.io/commands/sinter/) -Intersect multiple sets +Returns the intersect of multiple sets. ### [SINTERCARD](https://redis.io/commands/sintercard/) -Intersect multiple sets and return the cardinality of the result +Returns the number of members of the intersect of multiple sets. ### [SINTERSTORE](https://redis.io/commands/sinterstore/) -Intersect multiple sets and store the resulting set in a key +Stores the intersect of multiple sets in a key. ### [SISMEMBER](https://redis.io/commands/sismember/) -Determine if a given value is a member of a set +Determines whether a member belongs to a set. ### [SMEMBERS](https://redis.io/commands/smembers/) -Get all the members in a set +Returns all members of a set. ### [SMISMEMBER](https://redis.io/commands/smismember/) -Returns the membership associated with the given elements for a set +Determines whether multiple members belong to a set. ### [SMOVE](https://redis.io/commands/smove/) -Move a member from one set to another +Moves a member from one set to another. ### [SPOP](https://redis.io/commands/spop/) -Remove and return one or multiple random members from a set +Returns one or more random members from a set after removing them. Deletes the set if the last member was popped. ### [SRANDMEMBER](https://redis.io/commands/srandmember/) @@ -1448,46 +1455,43 @@ Get one or multiple random members from a set ### [SREM](https://redis.io/commands/srem/) -Remove one or more members from a set +Removes one or more members from a set. Deletes the set if the last member was removed. ### [SSCAN](https://redis.io/commands/sscan/) -Incrementally iterate Set elements +Iterates over members of a set. ### [SUNION](https://redis.io/commands/sunion/) -Add multiple sets +Returns the union of multiple sets. ### [SUNIONSTORE](https://redis.io/commands/sunionstore/) -Add multiple sets and store the resulting set in a key +Stores the union of multiple sets in a key. -### Unsupported set commands -> To implement support for a command, see [here](/guides/implement-command/) - ## stream commands ### [XADD](https://redis.io/commands/xadd/) -Appends a new entry to a stream +Appends a new message to a stream. Creates the key if it doesn't exist. ### [XLEN](https://redis.io/commands/xlen/) -Return the number of entries in a stream +Return the number of messages in a stream. ### [XRANGE](https://redis.io/commands/xrange/) -Return a range of elements in a stream, with IDs matching the specified IDs interval +Returns the messages from a stream within a range of IDs. ### [XREVRANGE](https://redis.io/commands/xrevrange/) -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 +Returns the messages from a stream within a range of IDs in reverse order. ### [XTRIM](https://redis.io/commands/xtrim/) -Trims the stream to (approximately if '~' is passed) a certain size +Deletes messages from the beginning of a stream. ### Unsupported stream commands @@ -1495,82 +1499,82 @@ Trims the stream to (approximately if '~' is passed) a certain size #### [XACK](https://redis.io/commands/xack/) (not implemented) -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. +Returns the number of messages that were successfully acknowledged by the consumer group member of a stream. #### [XAUTOCLAIM](https://redis.io/commands/xautoclaim/) (not implemented) -Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer. +Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member. #### [XCLAIM](https://redis.io/commands/xclaim/) (not implemented) -Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer. +Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member. #### [XDEL](https://redis.io/commands/xdel/) (not implemented) -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. +Returns the number of messages after removing them from a stream. #### [XGROUP](https://redis.io/commands/xgroup/) (not implemented) -A container for consumer groups commands +A container for consumer groups commands. #### [XGROUP CREATE](https://redis.io/commands/xgroup-create/) (not implemented) -Create a consumer group. +Creates a consumer group. #### [XGROUP CREATECONSUMER](https://redis.io/commands/xgroup-createconsumer/) (not implemented) -Create a consumer in a consumer group. +Creates a consumer in a consumer group. #### [XGROUP DELCONSUMER](https://redis.io/commands/xgroup-delconsumer/) (not implemented) -Delete a consumer from a consumer group. +Deletes a consumer from a consumer group. #### [XGROUP DESTROY](https://redis.io/commands/xgroup-destroy/) (not implemented) -Destroy a consumer group. +Destroys a consumer group. #### [XGROUP HELP](https://redis.io/commands/xgroup-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [XGROUP SETID](https://redis.io/commands/xgroup-setid/) (not implemented) -Set a consumer group to an arbitrary last delivered ID value. +Sets the last-delivered ID of a consumer group. #### [XINFO](https://redis.io/commands/xinfo/) (not implemented) -A container for stream introspection commands +A container for stream introspection commands. #### [XINFO CONSUMERS](https://redis.io/commands/xinfo-consumers/) (not implemented) -List the consumers in a consumer group +Returns a list of the consumers in a consumer group. #### [XINFO GROUPS](https://redis.io/commands/xinfo-groups/) (not implemented) -List the consumer groups of a stream +Returns a list of the consumer groups of a stream. #### [XINFO HELP](https://redis.io/commands/xinfo-help/) (not implemented) -Show helpful text about the different subcommands +Returns helpful text about the different subcommands. #### [XINFO STREAM](https://redis.io/commands/xinfo-stream/) (not implemented) -Get information about a stream +Returns information about a stream. #### [XPENDING](https://redis.io/commands/xpending/) (not implemented) -Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged. +Returns the information and entries from a stream consumer group's pending entries list. #### [XREAD](https://redis.io/commands/xread/) (not implemented) -Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block. +Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise. #### [XREADGROUP](https://redis.io/commands/xreadgroup/) (not implemented) -Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block. +Returns new or historical messages from a stream for a consumer in agroup. Blocks until a message is available otherwise. #### [XSETID](https://redis.io/commands/xsetid/) (not implemented) -An internal command for replicating stream values +An internal command for replicating stream values. diff --git a/docs/redis-commands/RedisBloom.md b/docs/redis-commands/RedisBloom.md index 3c5406e0..f4f627da 100644 --- a/docs/redis-commands/RedisBloom.md +++ b/docs/redis-commands/RedisBloom.md @@ -42,6 +42,10 @@ Restores a filter previously saved using SCANDUMP Returns information about a Bloom Filter +#### [BF.CARD](https://redis.io/commands/bf.card/) (not implemented) + +Returns the cardinality of a Bloom filter + ### Unsupported cf commands diff --git a/docs/redis-commands/RedisGraph.md b/docs/redis-commands/RedisGraph.md index 61b889f9..0c726446 100644 --- a/docs/redis-commands/RedisGraph.md +++ b/docs/redis-commands/RedisGraph.md @@ -42,4 +42,12 @@ Updates a RedisGraph configuration Lists all graph keys in the keyspace +#### [GRAPH.CONSTRAINT DROP](https://redis.io/commands/graph.constraint-drop/) (not implemented) + +Deletes a constraint from specified graph + +#### [GRAPH.CONSTRAINT CREATE](https://redis.io/commands/graph.constraint-create/) (not implemented) + +Creates a constraint on specified graph + diff --git a/docs/redis-commands/RedisSearch.md b/docs/redis-commands/RedisSearch.md index fcf27054..2d407ccd 100644 --- a/docs/redis-commands/RedisSearch.md +++ b/docs/redis-commands/RedisSearch.md @@ -92,7 +92,7 @@ Searches the index with a textual query, returning either documents or just ids #### [FT.AGGREGATE](https://redis.io/commands/ft.aggregate/) (not implemented) -Adds terms to a dictionary +Run a search query on an index and perform aggregate transformations on the results #### [FT.PROFILE](https://redis.io/commands/ft.profile/) (not implemented) diff --git a/docs/redis-commands/RedisTimeSeries.md b/docs/redis-commands/RedisTimeSeries.md index bdac5d9f..3ac13f96 100644 --- a/docs/redis-commands/RedisTimeSeries.md +++ b/docs/redis-commands/RedisTimeSeries.md @@ -60,11 +60,11 @@ Query a range across multiple time-series by filters in reverse direction #### [TS.GET](https://redis.io/commands/ts.get/) (not implemented) -Get the last sample +Get the sample with the highest timestamp from a given time series #### [TS.MGET](https://redis.io/commands/ts.mget/) (not implemented) -Get the last samples matching a specific filter +Get the sample with the highest timestamp from each time series matching a specific filter #### [TS.INFO](https://redis.io/commands/ts.info/) (not implemented) diff --git a/scripts/supported2.py b/scripts/supported2.py index c7da0f20..036be0a0 100644 --- a/scripts/supported2.py +++ b/scripts/supported2.py @@ -1,7 +1,7 @@ -from collections import namedtuple - import json import os +from collections import namedtuple + import requests from fakeredis._commands import SUPPORTED_COMMANDS @@ -68,13 +68,14 @@ def generate_markdown_files(commands: dict, implemented_commands: set[str], stac f.write(f"### [{cmd.upper()}](https://redis.io/commands/{cmd.replace(' ', '-')}/)\n\n") f.write(f"{commands[cmd]['summary']}\n\n") f.write("\n") - unimplemented_in_group = filter(lambda cmd: cmd not in implemented_commands, groups[group]) - f.write(f'### Unsupported {group} commands \n') - f.write(f'> To implement support for a command, see [here](/guides/implement-command/) \n\n') - for cmd in unimplemented_in_group: - f.write(f"#### [{cmd.upper()}](https://redis.io/commands/{cmd.replace(' ', '-')}/)" - f" (not implemented)\n\n") - f.write(f"{commands[cmd]['summary']}\n\n") + unimplemented_in_group = list(filter(lambda cmd: cmd not in implemented_commands, groups[group])) + if len(unimplemented_in_group) > 0: + f.write(f'### Unsupported {group} commands \n') + f.write(f'> To implement support for a command, see [here](/guides/implement-command/) \n\n') + for cmd in unimplemented_in_group: + f.write(f"#### [{cmd.upper()}](https://redis.io/commands/{cmd.replace(' ', '-')}/)" + f" (not implemented)\n\n") + f.write(f"{commands[cmd]['summary']}\n\n") f.write("\n")