[Doc] Updated API Compatibility documentation with latest info (micro…

…soft#662) * Updated API Compatibility documentation with latest info * Added ZREVRANGEBYSCORE doc --------- Co-authored-by: Badrish Chandramouli <[email protected]>
babykart · Sep 20, 2024 · c34f790 · c34f790
1 parent 225ab25
commit c34f790
Show file tree

Hide file tree

Showing 9 changed files with 469 additions and 64 deletions.
diff --git a/website/docs/commands/api-compatibility.md b/website/docs/commands/api-compatibility.md
@@ -11,23 +11,29 @@ Note that this list is subject to change as we continue to expand our API comman
 ### Command Categories
 1. [ACL](#acl)
 2. [BITMAP](#bitmap)
-3. [CLUSTER](#cluster)
-4. [CONNECTION](#connection)
-5. [FUNCTIONS](#functions)
-6. [GENERIC](#generic)
-7. [GEO](#geo)
-8. [HASH](#hash)
-9. [HYPERLOGLOG](#hyperloglog)
-10. [KEYS](#keys)
-11. [LIST](#list)
-12. [PUB/SUB](#pubsub)
-13. [SCRIPTING](#scripting)
-14. [SERVER](#server)
-15. [SET](#set)
-16. [SORTED SET](#sorted-set)
-17. [STREAM](#stream)
-18. [STRING](#string)
-10. [TRANSACTIONS](#transactions)
+3. [CLIENT](#client)
+4. [CLUSTER](#cluster)
+5. [COMMAND](#command)
+6. [CONNECTION](#connection)
+7. [FUNCTIONS](#functions)
+8. [GENERIC](#generic)
+9. [GEO](#geo)
+10. [HASH](#hash)
+11. [HYPERLOGLOG](#hyperloglog)
+12. [KEYS](#keys)
+13. [LATENCY](#latency)
+14. [LIST](#list)
+15. [MEMORY](#memory)
+16. [MODULE](#module)
+17. [OBJECT](#object)
+18. [PUB/SUB](#pubsub)
+19. [SCRIPTING](#scripting)
+20. [SERVER](#server)
+21. [SET](#set)
+22. [SORTED SET](#sorted-set)
+23. [STREAM](#stream)
+24. [STRING](#string)
+25. [TRANSACTIONS](#transactions)
 
 ### Full Commands List
 
@@ -40,6 +46,7 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | GETUSER | ➖ |  |
 |  | [LIST](acl.md#acl-list) | ➕ |  |
 |  | [LOAD](acl.md#acl-load) | ➕ |  |
+|  | HELP | ➖ |  |
 |  | LOG | ➖ |  |
 |  | SAVE | ➖ |  |
 |  | [SETUSER](acl.md#acl-setuser) | ➕ |  |
@@ -53,9 +60,27 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [BITPOS](analytics.md#bitpos) | ➕ |  |
 |  | [GETBIT](analytics.md#getbit) | ➕ |  |
 |  | [SETBIT](analytics.md#setbit) | ➕ |  |
+| <span id="client">**CLIENT**</span> | CACHING | ➖ |  |
+|  | GETNAME | ➖ |  |
+|  | GETREDIR | ➖ |  |
+|  | HELP | ➖ |  |
+|  | [ID](client.md#client-id) | ➕ |  |
+|  | [INFO](client.md#client-info) | ➕ |  |
+|  | [KILL](client.md#client-kill) | ➕ |  |
+|  | [LIST](client.md#client-list) | ➕ |  |
+|  | NO-EVICT | ➖ |  |
+|  | NO-TOUCH | ➖ |  |
+|  | PAUSE | ➖ |  |
+|  | REPLY | ➖ |  |
+|  | SETINFO | ➖ |  |
+|  | SETNAME | ➖ |  |
+|  | TRACKING | ➖ |  |
+|  | TRACKINGINFO | ➖ |  |
+|  | UNBLOCK | ➖ |  |
+|  | UNPAUSE | ➖ |  |
 | <span id="cluster">**CLUSTER**</span> | [ADDSLOTS](cluster.md#cluster-addslots) | ➕ |  |
 |  | [ADDSLOTSRANGE](cluster.md#cluster-addslotsrange) | ➕ |  |
-|  | ASKING | ➕ |  |
+|  | [ASKING](cluster.md#asking) | ➕ |  |
 |  | [BUMPEPOCH](cluster.md#cluster-bumpepoch) | ➕ |  |
 |  | COUNT-FAILURE-REPORTS | ➖ |  |
 |  | [COUNTKEYSINSLOT](cluster.md#cluster-countkeysinslot) | ➕ |  |
@@ -65,34 +90,50 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | FLUSHSLOTS | ➖ |  |
 |  | [FORGET](cluster.md#cluster-forget) | ➕ |  |
 |  | [GETKEYINSLOT](cluster.md#cluster-getkeysinslot) | ➕ |  |
-|  | INFO | ➕ |  |
+|  | [INFO](cluster.md#cluster-info) | ➕ |  |
 |  | [KEYSLOT](cluster.md#cluster-keyslot) | ➕ |  |
 |  | LINKS | ➖ |  |
 |  | [MEET](cluster.md#cluster-meet) | ➕ |  |
 |  | [MYID](cluster.md#cluster-myid) | ➕ |  |
+|  | MYSHARDID | ➖ |  |
 |  | [NODES](cluster.md#cluster-nodes) | ➕ |  |
-|  | READONLY | ➕ |  |
-|  | READWRITE | ➕ |  |
+|  | [READONLY](cluster.md#readonly) | ➕ |  |
+|  | [READWRITE](cluster.md#readwrite) | ➕ |  |
 |  | [REPLICAS](cluster.md#cluster-replicas) | ➕ |  |
 |  | [REPLICATE](cluster.md#cluster-replicate) | ➕ |  |
-|  | RESET | ➕ |  |
+|  | [RESET](cluster.md#reset) | ➕ |  |
 |  | SAVECONFIG | ➖ |  |
 |  | [SET-CONFIG-EPOCH](cluster.md#cluster-set-config-epoch) | ➕ |  |
 |  | [SETSLOT](cluster.md#cluster-setslot) | ➕ |  |
+|  | SHARDS | ➖ |  |
 |  | [SLAVES](cluster.md#slaves) | ➕ |  |
-|  | SLOTS | ➕ |  |
+|  | [SLOTS](cluster.md#cluster-slots) | ➕ | (deprecated) |
+| <span id="command">**COMMAND**</span> | [COMMAND](server.md#command) | ➕ |  |
+|  | [COUNT](server.md#command-count) | ➕ |  |
+|  | DOCS | ➖ |  |
+|  | GETKEYS | ➖ |  |
+|  | GETKEYSANDFLAGS | ➖ |  | 
+|  | HELP | ➖ |  | 
+|  | [INFO](server.md#command-info) | ➕ |  | 
+|  | LIST | ➖ |  | 
 | <span id="connection">**CONNECTION**</span> | [AUTH](generic-commands.md#auth) | ➕ |  |
-|  | CLIENT CACHING | ➖ |  |
 |  | [ECHO](generic-commands.md#echo) | ➕ |  |
 |  | [HELLO](generic-commands.md#hello) | ➕ |  |
 |  | [PING](generic-commands.md#ping) | ➕ |  |
 |  | [QUIT](generic-commands.md#quit) | ➕ |  |
-|  | SELECT | ➕ |  |
+|  | [SELECT](generic-commands.md#select) | ➕ |  |
 | <span id="functions">**FUNCTIONS**</span> | FCALL | ➖ |  |
 |  | FCALL_RO | ➖ |  |
-|  | FUNCTION | ➖ |
-| <span id="generic">**GENERIC**</span> | OBJECT | ➖ |  |
-|  | [PERSIST](generic-commands.md#persist) | ➕ |  |
+|  | DELETE | ➖ |
+|  | DUMP | ➖ |
+|  | FLUSH | ➖ |
+|  | HELP | ➖ |
+|  | KILL | ➖ |
+|  | LIST | ➖ |
+|  | LOAD | ➖ |
+|  | RESTORE | ➖ |
+|  | STATS | ➖ |
+| <span id="generic">**GENERIC**</span> | [PERSIST](generic-commands.md#persist) | ➕ |  |
 |  | [PEXPIRE](generic-commands.md#pexpire) | ➕ |  |
 |  | PEXPIREAT | ➖ |  |
 |  | PEXPIRETIME | ➖ |  |
@@ -109,17 +150,22 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [TYPE](generic-commands.md#type) | ➕ |  |
 |  | [UNLINK](generic-commands.md#unlink) | ➕ |  |
 |  | WAIT | ➖ |  |
+|  | WAITAOF | ➖ |  |
 | <span id="geo">**GEO**</span> | [GEOADD](data-structures.md#geoadd) | ➕ |  |
 |  | [GEODIST](data-structures.md#geodist) | ➕ |  |
 |  | [GEOHASH](data-structures.md#geohash) | ➕ |  |
 |  | [GEOPOS](data-structures.md#geopos) | ➕ |  |
 |  | GEORADIUS | ➖ |  |
 |  | GEORADIUS_RO | ➖ |  |
 |  | GEORADIUSBYMEMBER | ➖ |  |
+|  | GEORADIUSBYMEMBER_RO | ➖ |  |
 |  | [GEOSEARCH](data-structures.md#geosearch) | ➕ | Partially Implemented |
 |  | GEOSEARCHSTORE | ➖ |  |
 | <span id="hash">**HASH**</span> | [HDEL](data-structures.md#hdel) | ➕ |  |
 |  | [HEXISTS](data-structures.md#hexists) | ➕ |  |
+|  | HEXPIRE | ➖ |  |
+|  | HEXPIREAT | ➖ |  |
+|  | HEXPIRETIME | ➖ |  |
 |  | [HGET](data-structures.md#hget) | ➕ |  |
 |  | [HGETALL](data-structures.md#hgetall) | ➕ |  |
 |  | [HINCRBY](data-structures.md#hincrby) | ➕ |  |
@@ -128,11 +174,17 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [HLEN](data-structures.md#hlen) | ➕ |  |
 |  | [HMGET](data-structures.md#hmget) | ➕ |  |
 |  | [HMSET](data-structures.md#hmset) | ➕ |  |
+|  | HPERSIST | ➖ |  |
+|  | HPEXPIRE | ➖ |  |
+|  | HPEXPIREAT | ➖ |  |
+|  | HPEXPIRETIME | ➖ |  |
+|  | HPTTL | ➖ |  |
 |  | [HRANDFIELD](data-structures.md#hrandfield) | ➕ |  |
-|  | [HSCAN](data-structures.md#hscan) | ➕ |  |
+|  | [HSCAN](data-structures.md#hscan) | ➕ | `NOVALUES` flag not yet implemented |
 |  | [HSET](data-structures.md#hset) | ➕ |  |
 |  | [HSETNX](data-structures.md#hsetnx) | ➕ |  |
 |  | [HSTRLEN](data-structures.md#hstrlen) | ➕ |  |
+|  | HTTL | ➖ |  |
 |  | [HVALS](data-structures.md#hvals) | ➕ |  |
 | <span id="hyperloglog">**HYPERLOGLOG**</span> | [PFADD](analytics.md#pfadd) | ➕ |  |
 |  | [PFCOUNT](analytics.md#pfcount) | ➕ |  |
@@ -149,6 +201,13 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [KEYS](generic-commands.md#keys) | ➕ |  |
 |  | [MIGRATE](generic-commands.md#migrate) | ➕ |  |
 |  | MOVE | ➖ |  |
+| <span id="latency">**LATENCY**</span> | DOCTOR | ➖ |  |
+|  | GRAPH | ➖ |  |
+|  | HELP | ➖ |  |
+|  | [HISTOGRAM](server.md#latency-histogram) | ➕ |  |
+|  | HISTORY | ➖ |  |
+|  | LATEST | ➖ |  |
+|  | [RESET](server.md#latency-reset) | ➕ |  |
 | <span id="list">**LIST**</span> | [BLMOVE](data-structures.md#blmove) | ➕ |  |
 |  | BLMPOP | ➖ |  |
 |  | [BLPOP](data-structures.md#blpop) | ➕ |  |
@@ -171,54 +230,59 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [RPOPLPUSH](data-structures.md#rpoplpush) | ➕ |  |
 |  | [RPUSH](data-structures.md#rpush) | ➕ |  |
 |  | [RPUSHX](data-structures.md#rpushx) | ➕ |  |
+| <span id="memory">**MEMORY**</span> | DOCTOR | ➖ |  |
+|  | HELP | ➖ |  |
+|  | MALLOC-STATS | ➖ |  |
+|  | PURGE | ➖ |  |
+|  | STATS | ➖ |  |
+|  | [USAGE](server.md#memory-usage) | ➕ |  |
+| <span id="module">**MODULE**</span> | HELP | ➖ |  |
+|  | LIST | ➖ |  |
+|  | LOAD | ➖ |  |
+|  | LOADEX | ➖ |  |
+|  | UNLOAD | ➖ |  |
+| <span id="object">**OBJECT**</span> | ENCODING | ➖ |  |
+|  | FREQ | ➖ |  |
+|  | HELP | ➖ |  |
+|  | IDLETIME | ➖ |  |
+|  | REFCOUNT | ➖ |  |
 | <span id="pubsub">**PUB/SUB**</span> | [PSUBSCRIBE](analytics.md#psubscribe) | ➕ |  |
 |  | [PUBLISH](analytics.md#publish) | ➕ |  |
 |  | PUBSUB CHANNELS | ➖ |  |
+|  | PUBSUB HELP | ➖ |  |
 |  | PUBSUB NUMPAT | ➖ |  |
 |  | PUBSUB NUMSUB | ➖ |  |
+|  | PUBSUB SHARDCHANNELS | ➖ |  |
+|  | PUBSUB SHARDNUMSUB | ➖ |  |
 |  | [PUNSUBSCRIBE](analytics.md#punsubscribe) | ➕ |  |
 |  | [SUBSCRIBE](analytics.md#subscribe) | ➕ |  |
 |  | [UNSUBSCRIBE](analytics.md#unsubscribe) | ➕ |  |
-| <span id="scripting">**SCRIPTING**</span> | EVAL | ➕ |  |
+| <span id="scripting">**SCRIPTING**</span> | [EVAL](scripting-and-functions.md#eval) | ➕ |  |
 |  | EVAL_RO | ➖ |  |
-|  | EVALSHA | ➕ |  |
+|  | [EVALSHA](scripting-and-functions.md#evalsha) | ➕ |  |
 |  | EVALSHA_RO | ➖ |  |
 |  | SCRIPT DEBUG | ➖ |  |
-|  | SCRIPT EXISTS | ➕ |  |
-|  | SCRIPT FLUSH | ➕ |  |
+|  | [SCRIPT EXISTS](scripting-and-functions.md#script-exists) | ➕ |  |
+|  | [SCRIPT FLUSH](scripting-and-functions.md#script-flush) | ➕ |  |
+|  | SCRIPT HELP | ➖ |  |
 |  | SCRIPT KILL | ➖ |  |
-|  | SCRIPT LOAD | ➕ |  |
+|  | [SCRIPT LOAD](scripting-and-functions.md#script-load) | ➕ |  |
 | <span id="server">**SERVER**</span> | ACL | ➖ |  |
 |  | BGREWRITEAOF | ➖ |  |
 |  | [BGSAVE](checkpoint.md#bgsave) | ➕ |  |
-|  | [COMMAND](server.md#command) | ➕ |  |
-|  | [COMMAND COUNT](server.md#command-count) | ➕ |  |
-|  | COMMAND DOCS | ➖ |  |
-|  | COMMAND GETKEYS | ➖ |  |
-|  | COMMAND GETKEYSANDFLAGS | ➖ |  | 
-|  | [COMMAND INFO](server.md#command-info) | ➕ |  | 
-|  | COMMAND LIST | ➖ |  | 
 |  | [COMMITAOF](server.md#commitaof) | ➕ |  |
 |  | [CONFIG GET](server.md#config-get) | ➕ |  |
+|  | CONFIG HELP | ➖ |  |
+|  | CONFIG RESETSTAT | ➖ |  |
+|  | CONFIG REWRITE | ➖ |  |
 |  | [CONFIG SET](server.md#config-set) | ➕ |  |
 |  | [DBSIZE](server.md#dbsize) | ➕ |  |
+|  | DEBUG | ➖ | Internal command |
 |  | [FLUSHALL](server.md#flushall) | ➕ |  |
 |  | [FLUSHDB](server.md#flushdb) | ➕ |  |
 |  | [LASTSAVE](checkpoint.md#lastsave) | ➕ |  |
-|  | LATENCY DOCTOR | ➖ |  |
-|  | LATENCY GRAPH | ➖ |  |
-|  | [LATENCY HISTOGRAM](server.md#latency-histogram) | ➕ |  |
-|  | LATENCY HISTORY | ➖ |  |
-|  | LATENCY LATEST | ➖ |  |
-|  | [LATENCY RESET](server.md#latency-reset) | ➕ |  |
-|  | LOLWUT | ➕ |  |
-|  | MEMORY DOCTOR | ➖ |  |
-|  | MEMORY MALLOC-STATS | ➖ |  |
-|  | MEMORY PURGE | ➖ |  |
-|  | MEMORY STATS | ➖ |  |
-|  | [MEMORY USAGE](server.md#memory-usage) | ➕ |  |
-|  | MODULE | ➖ |  |
-|  | MONITOR | ➖ |  |
+|  | LOLWUT | ➖ |  |
+|  | [MONITOR](server.md#monitor) | ➕ |  |
 |  | PSYNC | ➖ |  |
 |  | REPLCONF | ➖ |  |
 |  | [REPLICAOF](server.md#replicaof) | ➕ |  |
@@ -227,7 +291,6 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [SAVE](checkpoint.md#save) | ➕ |  |
 |  | SHUTDOWN | ➖ |  |
 |  | SLAVEOF | ➖ |  |
-|  | SLOWLOG | ➖ |  |
 |  | SWAPDB | ➖ |  |
 |  | SYNC | ➖ |  |
 |  | [TIME](server.md#time) | ➕ |  |
@@ -238,17 +301,25 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [SINTER](data-structures.md#sinter) | ➕ |  |
 |  | [SINTERSTORE](data-structures.md#sinterstore) | ➕ |  |
 |  | SINTERCARD | ➖ |  |
-|  | SISMEMBER | ➕ |  |
+|  | [SISMEMBER](data-structures.md#sismember) | ➕ |  |
 |  | [SMEMBERS](data-structures.md#smembers) | ➕ |  |
 |  | SMISMEMBER | ➖ |  |
 |  | SMOVE | ➖ |  |
 |  | [SPOP](data-structures.md#spop) | ➕ |  |
+|  | SPUBLISH | ➖ |  |
 |  | [SRANDMEMBER](data-structures.md#srandmember) | ➕ |  |
 |  | [SREM](data-structures.md#srem) | ➕ |  |
 |  | [SSCAN](data-structures.md#sscan) | ➕ |  |
+|  | SSUBSCRIBE | ➖ |  |
 |  | [SUNION](data-structures.md#sunion) | ➕ |  |
 |  | [SUNIONSTORE](data-structures.md#sunionstore) | ➕ |  |
+|  | SUNSUBSCRIBE | ➖ |  |
+| <span id="sorted-set">**SLOWLOG**</span> | GET | ➖ |  |
+|  | HELP | ➖ |  |
+|  | LEN | ➖ |  |
+|  | RESET | ➖ |  |
 | <span id="sorted-set">**SORTED SET**</span> | BZPOP | ➖ |  |
+|  | BZMPOP | ➖ |  |
 |  | BZPOPMAX | ➖ |  |
 |  | BZPOPMIN | ➖ |  |
 |  | [ZADD](data-structures.md#zadd) | ➕ |  |
@@ -277,7 +348,7 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [ZREMRANGEBYSCORE](data-structures.md#zremrangebyscore) | ➕ |  |
 |  | [ZREVRANGE](data-structures.md#zrevrange) | ➕ |  |
 |  | ZREVRANGEBYLEX | ➖ |  |
-|  | ZREVRANGEBYSCORE | ➖ |  |
+|  | [ZREVRANGEBYSCORE](data-structures.md#zrevrangebyscore) | ➕ |  |
 |  | [ZREVRANK](data-structures.md#zrevrank) | ➕ |  |
 |  | [ZSCAN](data-structures.md#zscan) | ➕ |  |
 |  | [ZSCORE](data-structures.md#zscore) | ➕ |  |
@@ -288,8 +359,16 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | XAUTOCLAIM | ➖ |  |
 |  | XCLAIM | ➖ |  |
 |  | XDEL | ➖ |  |
-|  | XGROUP | ➖ |  |
-|  | XINFO | ➖ |  |
+|  | XGROUP CREATE | ➖ |  |
+|  | XGROUP CREATECONSUMER | ➖ |  |
+|  | XGROUP DELCONSUMER | ➖ |  |
+|  | XGROUP DESTROY | ➖ |  |
+|  | XGROUP HELP | ➖ |  |
+|  | XGROUP SETID | ➖ |  |
+|  | XINFO CONSUMERS | ➖ |  |
+|  | XINFO GROUPS | ➖ |  |
+|  | XINFO HELP | ➖ |  |
+|  | XINFO STREAM | ➖ |  |
 |  | XLEN | ➖ |  |
 |  | XPENDING | ➖ |  |
 |  | XRANGE | ➖ |  |
@@ -318,7 +397,7 @@ Note that this list is subject to change as we continue to expand our API comman
 |  | [SET ... NX](raw-string.md#set) | ➕ |  |
 |  | [SETEX](raw-string.md#setex) | ➕ |  |
 |  | SETNX | ➖ |  |
-|  | SETRANGE | ➕ |  |
+|  | [SETRANGE](raw-string.md#setrange) | ➕ |  |
 |  | [STRLEN](raw-string.md#strlen) | ➕ |  |
 |  | SUBSTR | ➖ |  |
 | <span id="transactions">**TRANSACTIONS**</span> | [DISCARD](transactions.md#discard) | ➕ |  |