sabbey37 commented on a change in pull request #6239: URL: https://github.com/apache/geode/pull/6239#discussion_r605962580
##########
File path: geode-redis/README.md
##########
@@ -128,210 +128,61 @@ not connected>
```
### <a name="redis-commands"></a>Redis Commands
-The Geode APIs compatible with Redis currently implements a subset of the full
Redis command set. Some commands
-are **unsupported** (see table below). Unsupported commands are available to
use, but have not been
-fully tested. There is no guarantee they will work exactly as expected.
-
-#### <a name="enable-unsupported-commands"></a>Enabling Unsupported Commands
-
-If you already have Geode servers running with Redis enabled, you can execute
the following
-command with gfsh to enable unsupported commands:
-
-```pre
-redis --enable-unsupported-commands
-```
-
-You can also enable unsupported commands when you start the Geode server by
setting the Java property `enable-redis-unsupported-commands=true`:
-
-```pre
-start server \
- --J=-Denable-redis-unsupported-commands=true \
- --name=<serverName> \
- --locators=<locatorPort> \
- --compatible-with-redis-port=<redisPort> \
- --compatible-with-redis-bind-address=<redisBindAddress> \
- --compatible-with-redis-password=<redisPassword>
-```
-
-#### <a name="redis-command-status"></a>Redis Command Status [Return to
top](#introduction)
-
-| Supported Commands | Unsupported Commands<br>(Implemented - not tested)
| Commands Not Implemented |
-|-----------------------|-------------------------------------------------------|-----------------------------------|
-| APPEND | BITCOUNT
| ACL CAT |
-| AUTH | BITOP
| ACL DELUSER |
-| DECRBY | BITPOS
| ACL GENPASS |
-| DEL | DBSIZE
| ACL GETUSER |
-| EXISTS | DECR
| ACL HELP |
-| EXPIRE | ECHO
| ACL LIST |
-| EXPIREAT | FLUSHALL
| ACL LOAD |
-| GET | FLUSHDB
| ACL LOG |
-| HGETALL | GETBIT
| ACL SAVE |
-| HMGET | GETRANGE
| ACL SETUSER |
-| HMSET | GETSET
| ACL USERS |
-| HSET | HDEL
| ACL WHOAMI |
-| HSETNX | HEXISTS
| BGREWRITEAOF |
-| HSTRLEN | HGET
| BGSAVE |
-| HLEN | HINCRBY
| BITFIELD |
-| HVALS | HINCRBYFLOAT
| BLPOP |
-| INFO | HKEYS
| BRPOP |
-| KEYS | HSCAN
| BRPOPLPUSH |
-| PERSIST | INCR
| BZPOPMAX |
-| PEXPIRE | INCRBY
| BZPOPMIN |
-| PEXPIREAT | INCRBYFLOAT
| CLIENT CACHING |
-| PING | MGET
| CLIENT GETNAME |
-| PSUBSCRIBE | MSET
| CLIENT ID |
-| PTTL | MSETNX
| CLIENT KILL |
-| PUNSUBSCRIBE | PSETEX
| CLIENT LIST |
-| QUIT | SCAN
| CLIENT PAUSE |
-| RENAME | SCARD
| CLIENT REPLY |
-| SADD | SDIFF
| CLIENT SETNAME |
-| SET | SDIFFSTORE
| CLIENT TRACKING |
-| SLOWLOG[2] | SELECT
| CLIENT UNBLOCK |
-| SMEMBERS | SETBIT
| CLUSTER ADDSLOTS |
-| SREM | SETEX
| CLUSTER BUMPEPOCH |
-| SUBSCRIBE | SETNX
| CLUSTER COUNT-FAILURE-REPORTS |
-| TTL | SETRANGE
| CLUSTER COUNTKEYSINSLOT |
-| TYPE | SHUTDOWN
| CLUSTER DELSLOTS |
-| UNSUBSCRIBE | SINTER
| CLUSTER FAILOVER |
-| PUBLISH | SINTERSTORE
| CLUSTER FLUSHSLOTS |
-| | SISMEMBER
| CLUSTER FORGET |
-| | SLOWLOG
| CLUSTER GETKEYSINSLOT |
-| | SMOVE
| CLUSTER INFO |
-| | SPOP
| CLUSTER KEYSLOT |
-| | SRANDMEMBER
| CLUSTER MEET |
-| | SSCAN
| CLUSTER MYID |
-| | STRLEN
| CLUSTER NODES |
-| | SUNION
| CLUSTER REPLICAS |
-| | SUNIONSTORE
| CLUSTER REPLICATE |
-| | TIME
| CLUSTER RESET |
-| | UNLINK [1]
| CLUSTER SAVECONFIG |
-| |
| CLUSTER SET-CONFIG-EPOCH |
-| |
| CLUSTER SETSLOT |
-| |
| CLIENT GETREDIR |
-| |
| CLUSTER SLAVES |
-| |
| CLUSTER SLOTS |
-| |
| COMMAND |
-| |
| COMMAND COUNT |
-| |
| COMMAND GETKEYS |
-| |
| COMMAND INFO |
-| |
| CONFIG GET |
-| |
| CONFIG RESETSTAT |
-| |
| CONFIG REWRITE |
-| |
| CONFIG SET |
-| |
| DEBUG OBJECT |
-| |
| DEBUG SEGFAULT |
-| |
| DISCARD |
-| |
| DUMP |
-| |
| EVAL |
-| |
| EVALSHA |
-| |
| EXEC |
-| |
| GEOADD |
-| |
| GEODIST |
-| |
| GEOHASH |
-| |
| GEOPOS |
-| |
| GEORADIUS |
-| |
| GEORADIUSBYMEMBER |
-| |
| LASTSAVE |
-| |
| LATENCY DOCTOR |
-| |
| LATENCY GRAPH |
-| |
| LATENCY HELP |
-| |
| LATENCY HISTORY |
-| |
| LATENCY LATEST |
-| |
| LATENCY RESET |
-| |
| LINDEX |
-| |
| LINSERT |
-| |
| LLEN |
-| |
| LOLWUT |
-| |
| LPOP |
-| |
| LPOS |
-| |
| LPUSH |
-| |
| LPUSHX |
-| |
| LRANGE |
-| |
| LREM |
-| |
| LSET |
-| |
| LTRIM |
-| |
| MEMORY DOCTOR |
-| |
| MEMORY HELP |
-| |
| MEMORY MALLOC-STATS |
-| |
| MEMORY PURGE |
-| |
| MEMORY STATS |
-| |
| MEMORY USAGE |
-| |
| MIGRATE |
-| |
| MODULE LIST |
-| |
| MODULE LOAD |
-| |
| MODULE UNLOAD |
-| |
| MONITOR |
-| |
| MOVE |
-| |
| MULTI |
-| |
| OBJECT |
-| |
| PFADD |
-| |
| PFCOUNT |
-| |
| PFMERGE |
-| |
| PSYNC |
-| |
| PUBSUB |
-| |
| RANDOMKEY |
-| |
| READONLY |
-| |
| READWRITE |
-| |
| RENAMENX |
-| |
| REPLICAOF |
-| |
| RESTORE |
-| |
| ROLE |
-| |
| RPOP |
-| |
| RPOPLPUSH |
-| |
| RPUSH |
-| |
| RPUSHX |
-| |
| SAVE |
-| |
| SCRIPT DEBUG |
-| |
| SCRIPT EXISTS |
-| |
| SCRIPT FLUSH |
-| |
| SCRIPT KILL |
-| |
| SCRIPT LOAD |
-| |
| SLAVEOF |
-| |
| SORT |
-| |
| STRALGO LCS |
-| |
| SWAPDB |
-| |
| SYNC |
-| |
| TOUCH |
-| |
| UNWATCH |
-| |
| WAIT |
-| |
| WATCH |
-| |
| XACK |
-| |
| XADD |
-| |
| XCLAIM |
-| |
| XDEL |
-| |
| XGROUP |
-| |
| XINFO |
-| |
| XLEN |
-| |
| XPENDING |
-| |
| XRANGE |
-| |
| XREAD |
-| |
| XREADGROUP GROUP |
-| |
| XREVRANGE |
-| |
| XTRIM |
-| |
| ZADD |
-| |
| ZCARD |
-| |
| ZCOUNT |
-| |
| ZINCRBY |
-| |
| ZINTERSTORE |
-| |
| ZLEXCOUNT |
-| |
| ZPOPMAX |
-| |
| ZPOPMIN |
-| |
| ZRANGE |
-| |
| ZRANGEBYLEX |
-| |
| ZRANGEBYSCORE |
-| |
| ZRANK |
-| |
| ZREM |
-| |
| ZREMRANGEBYLEX |
-| |
| ZREMRANGEBYRANK |
-| |
| ZREMRANGEBYSCORE |
-| |
| ZREVRANGE |
-| |
| ZREVRANGEBYSCORE |
-| |
| ZREVRANK |
-| |
| ZSCAN |
-| |
| ZSCORE |
-| |
| ZUNIONSTORE | |
-
-**NOTES:**
-
-[1] - UNLINK is implemented as a synonym to DEL and does not unlink
asynchronously.
-[2] - SLOWLOG is implemented as a NoOp.
+The Geode APIs compatible with Redis currently implement a subset of the full
Redis command set.
+
Review comment:
There are also a couple notes we have in the docs around supported
commands. I am not sure if we want to add them here (or maybe remove them from
the docs?) Specifically these two:
- `Commands not listed above are **not implemented**.` (this is at the end
of the Supported Commands section)
- `**Note**: These commands are supported for Redis 5.` (at the beginning of
the Supported Commands section)
##########
File path: geode-redis/README.md
##########
@@ -128,210 +128,61 @@ not connected>
```
### <a name="redis-commands"></a>Redis Commands
-The Geode APIs compatible with Redis currently implements a subset of the full
Redis command set. Some commands
-are **unsupported** (see table below). Unsupported commands are available to
use, but have not been
-fully tested. There is no guarantee they will work exactly as expected.
-
-#### <a name="enable-unsupported-commands"></a>Enabling Unsupported Commands
-
-If you already have Geode servers running with Redis enabled, you can execute
the following
-command with gfsh to enable unsupported commands:
-
-```pre
-redis --enable-unsupported-commands
-```
-
-You can also enable unsupported commands when you start the Geode server by
setting the Java property `enable-redis-unsupported-commands=true`:
-
-```pre
-start server \
- --J=-Denable-redis-unsupported-commands=true \
- --name=<serverName> \
- --locators=<locatorPort> \
- --compatible-with-redis-port=<redisPort> \
- --compatible-with-redis-bind-address=<redisBindAddress> \
- --compatible-with-redis-password=<redisPassword>
-```
-
-#### <a name="redis-command-status"></a>Redis Command Status [Return to
top](#introduction)
-
-| Supported Commands | Unsupported Commands<br>(Implemented - not tested)
| Commands Not Implemented |
-|-----------------------|-------------------------------------------------------|-----------------------------------|
-| APPEND | BITCOUNT
| ACL CAT |
-| AUTH | BITOP
| ACL DELUSER |
-| DECRBY | BITPOS
| ACL GENPASS |
-| DEL | DBSIZE
| ACL GETUSER |
-| EXISTS | DECR
| ACL HELP |
-| EXPIRE | ECHO
| ACL LIST |
-| EXPIREAT | FLUSHALL
| ACL LOAD |
-| GET | FLUSHDB
| ACL LOG |
-| HGETALL | GETBIT
| ACL SAVE |
-| HMGET | GETRANGE
| ACL SETUSER |
-| HMSET | GETSET
| ACL USERS |
-| HSET | HDEL
| ACL WHOAMI |
-| HSETNX | HEXISTS
| BGREWRITEAOF |
-| HSTRLEN | HGET
| BGSAVE |
-| HLEN | HINCRBY
| BITFIELD |
-| HVALS | HINCRBYFLOAT
| BLPOP |
-| INFO | HKEYS
| BRPOP |
-| KEYS | HSCAN
| BRPOPLPUSH |
-| PERSIST | INCR
| BZPOPMAX |
-| PEXPIRE | INCRBY
| BZPOPMIN |
-| PEXPIREAT | INCRBYFLOAT
| CLIENT CACHING |
-| PING | MGET
| CLIENT GETNAME |
-| PSUBSCRIBE | MSET
| CLIENT ID |
-| PTTL | MSETNX
| CLIENT KILL |
-| PUNSUBSCRIBE | PSETEX
| CLIENT LIST |
-| QUIT | SCAN
| CLIENT PAUSE |
-| RENAME | SCARD
| CLIENT REPLY |
-| SADD | SDIFF
| CLIENT SETNAME |
-| SET | SDIFFSTORE
| CLIENT TRACKING |
-| SLOWLOG[2] | SELECT
| CLIENT UNBLOCK |
-| SMEMBERS | SETBIT
| CLUSTER ADDSLOTS |
-| SREM | SETEX
| CLUSTER BUMPEPOCH |
-| SUBSCRIBE | SETNX
| CLUSTER COUNT-FAILURE-REPORTS |
-| TTL | SETRANGE
| CLUSTER COUNTKEYSINSLOT |
-| TYPE | SHUTDOWN
| CLUSTER DELSLOTS |
-| UNSUBSCRIBE | SINTER
| CLUSTER FAILOVER |
-| PUBLISH | SINTERSTORE
| CLUSTER FLUSHSLOTS |
-| | SISMEMBER
| CLUSTER FORGET |
-| | SLOWLOG
| CLUSTER GETKEYSINSLOT |
-| | SMOVE
| CLUSTER INFO |
-| | SPOP
| CLUSTER KEYSLOT |
-| | SRANDMEMBER
| CLUSTER MEET |
-| | SSCAN
| CLUSTER MYID |
-| | STRLEN
| CLUSTER NODES |
-| | SUNION
| CLUSTER REPLICAS |
-| | SUNIONSTORE
| CLUSTER REPLICATE |
-| | TIME
| CLUSTER RESET |
-| | UNLINK [1]
| CLUSTER SAVECONFIG |
-| |
| CLUSTER SET-CONFIG-EPOCH |
-| |
| CLUSTER SETSLOT |
-| |
| CLIENT GETREDIR |
-| |
| CLUSTER SLAVES |
-| |
| CLUSTER SLOTS |
-| |
| COMMAND |
-| |
| COMMAND COUNT |
-| |
| COMMAND GETKEYS |
-| |
| COMMAND INFO |
-| |
| CONFIG GET |
-| |
| CONFIG RESETSTAT |
-| |
| CONFIG REWRITE |
-| |
| CONFIG SET |
-| |
| DEBUG OBJECT |
-| |
| DEBUG SEGFAULT |
-| |
| DISCARD |
-| |
| DUMP |
-| |
| EVAL |
-| |
| EVALSHA |
-| |
| EXEC |
-| |
| GEOADD |
-| |
| GEODIST |
-| |
| GEOHASH |
-| |
| GEOPOS |
-| |
| GEORADIUS |
-| |
| GEORADIUSBYMEMBER |
-| |
| LASTSAVE |
-| |
| LATENCY DOCTOR |
-| |
| LATENCY GRAPH |
-| |
| LATENCY HELP |
-| |
| LATENCY HISTORY |
-| |
| LATENCY LATEST |
-| |
| LATENCY RESET |
-| |
| LINDEX |
-| |
| LINSERT |
-| |
| LLEN |
-| |
| LOLWUT |
-| |
| LPOP |
-| |
| LPOS |
-| |
| LPUSH |
-| |
| LPUSHX |
-| |
| LRANGE |
-| |
| LREM |
-| |
| LSET |
-| |
| LTRIM |
-| |
| MEMORY DOCTOR |
-| |
| MEMORY HELP |
-| |
| MEMORY MALLOC-STATS |
-| |
| MEMORY PURGE |
-| |
| MEMORY STATS |
-| |
| MEMORY USAGE |
-| |
| MIGRATE |
-| |
| MODULE LIST |
-| |
| MODULE LOAD |
-| |
| MODULE UNLOAD |
-| |
| MONITOR |
-| |
| MOVE |
-| |
| MULTI |
-| |
| OBJECT |
-| |
| PFADD |
-| |
| PFCOUNT |
-| |
| PFMERGE |
-| |
| PSYNC |
-| |
| PUBSUB |
-| |
| RANDOMKEY |
-| |
| READONLY |
-| |
| READWRITE |
-| |
| RENAMENX |
-| |
| REPLICAOF |
-| |
| RESTORE |
-| |
| ROLE |
-| |
| RPOP |
-| |
| RPOPLPUSH |
-| |
| RPUSH |
-| |
| RPUSHX |
-| |
| SAVE |
-| |
| SCRIPT DEBUG |
-| |
| SCRIPT EXISTS |
-| |
| SCRIPT FLUSH |
-| |
| SCRIPT KILL |
-| |
| SCRIPT LOAD |
-| |
| SLAVEOF |
-| |
| SORT |
-| |
| STRALGO LCS |
-| |
| SWAPDB |
-| |
| SYNC |
-| |
| TOUCH |
-| |
| UNWATCH |
-| |
| WAIT |
-| |
| WATCH |
-| |
| XACK |
-| |
| XADD |
-| |
| XCLAIM |
-| |
| XDEL |
-| |
| XGROUP |
-| |
| XINFO |
-| |
| XLEN |
-| |
| XPENDING |
-| |
| XRANGE |
-| |
| XREAD |
-| |
| XREADGROUP GROUP |
-| |
| XREVRANGE |
-| |
| XTRIM |
-| |
| ZADD |
-| |
| ZCARD |
-| |
| ZCOUNT |
-| |
| ZINCRBY |
-| |
| ZINTERSTORE |
-| |
| ZLEXCOUNT |
-| |
| ZPOPMAX |
-| |
| ZPOPMIN |
-| |
| ZRANGE |
-| |
| ZRANGEBYLEX |
-| |
| ZRANGEBYSCORE |
-| |
| ZRANK |
-| |
| ZREM |
-| |
| ZREMRANGEBYLEX |
-| |
| ZREMRANGEBYRANK |
-| |
| ZREMRANGEBYSCORE |
-| |
| ZREVRANGE |
-| |
| ZREVRANGEBYSCORE |
-| |
| ZREVRANK |
-| |
| ZSCAN |
-| |
| ZSCORE |
-| |
| ZUNIONSTORE | |
-
-**NOTES:**
-
-[1] - UNLINK is implemented as a synonym to DEL and does not unlink
asynchronously.
-[2] - SLOWLOG is implemented as a NoOp.
+The Geode APIs compatible with Redis currently implement a subset of the full
Redis command set.
+
+#### <a name="redis-command-status"></a> Supported Commands Compatable With
Redis [Return to top](#introduction)
Review comment:
I apologize, I thought I made this comment in the previous review, but
it looks like it wasn't made somehow. Could we make this title `Supported
Redis Commands` to be consistent with the docs and since we are talking about
actual Redis commands vs. something we created (a decision we made in [this
PR](https://github.com/apache/geode/pull/6150). Then the link name could
potentially change from `redis-command-status` to `supported-commands` (there
is a reference to this section in a prior section of the README that will also
need to change).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
