You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@geode.apache.org by GitBox <gi...@apache.org> on 2021/04/05 17:59:09 UTC
[GitHub] [geode] nonbinaryprogrammer commented on a change in pull request #6239: GEODE-9068: Update documents to show removal of unsupported commands category
nonbinaryprogrammer commented on a change in pull request #6239:
URL: https://github.com/apache/geode/pull/6239#discussion_r607195192
##########
File path: geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
##########
@@ -64,52 +64,65 @@ If the server is functioning properly, you should see a response of `PONG`.
## <a id="supported-commands" class="no-quick-link"></a>Supported Redis Commands
-The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands. See [Redis commands](https://redis.io/commands/) for a complete list of and more information on Redis commands.
+The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands.
Review comment:
since APIs is plural, supports -> support
##########
File path: geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
##########
@@ -64,52 +64,65 @@ If the server is functioning properly, you should see a response of `PONG`.
## <a id="supported-commands" class="no-quick-link"></a>Supported Redis Commands
-The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands. See [Redis commands](https://redis.io/commands/) for a complete list of and more information on Redis commands.
+The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands.
+- APPEND
+- AUTH
+- DECR
+- DECRBY
+- DEL
+- EXISTS
+- EXPIRE
+- EXPIREAT
+- GET
+- GETRANGE
+- HDEL
+- HEXISTS
+- HGET
+- HGETALL
+- HINCRBY
+- HINCRBYFLOAT
+- HLEN
+- HMGET
+- HMSET
+- HSCAN
+- HSET
+- HSETNX
+- HSTRLEN
+- HVALS
+- HKEYS
+- INCR
+- INCRBY
+- INCRBYFLOAT
+- INFO
+- KEYS
+- MGET
+- PERSIST
+- PEXPIRE
+- PEXPIREAT
+- PING
+- PSUBSCRIBE
+- PTTL
+- PUBLISH
+- PUNSUBSCRIBE
+- QUIT
+- RENAME
+- SADD
+- SET
+- SETNX
+- SLOWLOG <sup>1</sup>
+- SMEMBERS
+- SREM
+- STRLEN
+- SUBSCRIBE
+- TTL
+- TYPE
+- UNSUBSCRIBE
-**Note**: These commands are supported for Redis 5.
-**Note**: SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools.
-
-- **Connection**: AUTH, PING, QUIT
-- **Hashes**: HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HLEN, HMGET, HMSET, HSCAN, HSET, HSETNX, HSTRLEN, HVALS
-- **Keys**: DEL, EXISTS, EXPIRE, EXPIREAT, KEYS, PERSIST, PEXPIRE, PEXPIREAT, PTTL, RENAME, TTL,
- TYPE
-- **Publish/Subscribe**: PUBLISH, PSUBSCRIBE, PUNSUBSCRIBE, SUBSCRIBE, UNSUBSCRIBE
-- **Server**: SLOWLOG, INFO
-- **Sets**: SADD, SMEMBERS, SREM
-- **Strings**: APPEND, DECR, DECRBY, GET, GETRANGE, INCR, INCRBY, INCRBYFLOAT, MGET, SET, SETNX, STRLEN
-
-The following Redis commands are **unsupported** by <%=vars.produce_name%>'s APIs compatible with Redis. Unsupported
-commands are available to use, but have not been fully tested. There is no guarantee they will work
-exactly as expected.
-
-- **Connection**: ECHO, SELECT
-- **Keys**: SCAN, UNLINK
-- **Server**: DBSIZE, FLUSHALL (no async option), FLUSHDB (no async option), SHUTDOWN, TIME
-- **Sets**: SCARD, SDIFF, SDIFFSTORE, SINTER, SINTERSTORE, SISMEMBER, SMOVE, SPOP, SRANDMEMBER,
- SSCAN, SUNION, SUNIONSTORE
-- **Strings**: BITCOUNT, BITOP, BITPOS, GETBIT, GETSET, MSET, MSETNX, PSETEX, SETBIT, SETEX, SETRANGE
-
-
-If you already have some Geode servers running that are compatible with Redis, 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`:
+Commands not listed above are **not implemented**.
-```pre
-start server \
- --J=-Denable-redis-unsupported-commands=true \
- --name=<serverName> \
- --locators=<locatorPort> \
- --compatible-with-redis-port=<compatibleWithRedisPort> \
- --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
- --compatible-with-redis-password=<compatibleWithRedisPassword>
-```
+**Note**: These commands are supported for Redis 5.
-Commands not listed above are **not implemented**.
+**Note**: SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools.
Review comment:
you put 1 as a superscript for the slowlog command but didn't reference [1] here. Also @sabbey37 informed me that @karensmolermiller said in a PR:
```
If there will be more notes about specific commands, I'd like to see the notes placed next to the
command within the lists. Maybe add the note in parenthesis? I believe that documentation readers are
more likely to see the note if it is with the command, as I believe that readers will be likely to scan
this page for the commands that they use. I don't think they'll be starting at the top to do a detailed
reading.
```
so this might be a good time to move the note next to the command in the list
##########
File path: geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
##########
@@ -64,52 +64,65 @@ If the server is functioning properly, you should see a response of `PONG`.
## <a id="supported-commands" class="no-quick-link"></a>Supported Redis Commands
-The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands. See [Redis commands](https://redis.io/commands/) for a complete list of and more information on Redis commands.
+The <%=vars.product_name%> APIs compatible with Redis currently supports the following Redis commands.
+- APPEND
+- AUTH
+- DECR
+- DECRBY
+- DEL
+- EXISTS
+- EXPIRE
+- EXPIREAT
+- GET
+- GETRANGE
+- HDEL
+- HEXISTS
+- HGET
+- HGETALL
+- HINCRBY
+- HINCRBYFLOAT
+- HLEN
+- HMGET
+- HMSET
+- HSCAN
+- HSET
+- HSETNX
+- HSTRLEN
+- HVALS
+- HKEYS
+- INCR
+- INCRBY
+- INCRBYFLOAT
+- INFO
+- KEYS
+- MGET
+- PERSIST
+- PEXPIRE
+- PEXPIREAT
+- PING
+- PSUBSCRIBE
+- PTTL
+- PUBLISH
+- PUNSUBSCRIBE
+- QUIT
+- RENAME
+- SADD
+- SET
+- SETNX
+- SLOWLOG <sup>1</sup>
+- SMEMBERS
+- SREM
+- STRLEN
+- SUBSCRIBE
+- TTL
+- TYPE
+- UNSUBSCRIBE
-**Note**: These commands are supported for Redis 5.
-**Note**: SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools.
-
-- **Connection**: AUTH, PING, QUIT
-- **Hashes**: HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HLEN, HMGET, HMSET, HSCAN, HSET, HSETNX, HSTRLEN, HVALS
-- **Keys**: DEL, EXISTS, EXPIRE, EXPIREAT, KEYS, PERSIST, PEXPIRE, PEXPIREAT, PTTL, RENAME, TTL,
- TYPE
-- **Publish/Subscribe**: PUBLISH, PSUBSCRIBE, PUNSUBSCRIBE, SUBSCRIBE, UNSUBSCRIBE
-- **Server**: SLOWLOG, INFO
-- **Sets**: SADD, SMEMBERS, SREM
-- **Strings**: APPEND, DECR, DECRBY, GET, GETRANGE, INCR, INCRBY, INCRBYFLOAT, MGET, SET, SETNX, STRLEN
-
-The following Redis commands are **unsupported** by <%=vars.produce_name%>'s APIs compatible with Redis. Unsupported
-commands are available to use, but have not been fully tested. There is no guarantee they will work
-exactly as expected.
-
-- **Connection**: ECHO, SELECT
-- **Keys**: SCAN, UNLINK
-- **Server**: DBSIZE, FLUSHALL (no async option), FLUSHDB (no async option), SHUTDOWN, TIME
-- **Sets**: SCARD, SDIFF, SDIFFSTORE, SINTER, SINTERSTORE, SISMEMBER, SMOVE, SPOP, SRANDMEMBER,
- SSCAN, SUNION, SUNIONSTORE
-- **Strings**: BITCOUNT, BITOP, BITPOS, GETBIT, GETSET, MSET, MSETNX, PSETEX, SETBIT, SETEX, SETRANGE
-
-
-If you already have some Geode servers running that are compatible with Redis, 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`:
+Commands not listed above are **not implemented**.
-```pre
-start server \
- --J=-Denable-redis-unsupported-commands=true \
- --name=<serverName> \
- --locators=<locatorPort> \
- --compatible-with-redis-port=<compatibleWithRedisPort> \
- --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
- --compatible-with-redis-password=<compatibleWithRedisPassword>
-```
+**Note**: These commands are supported for Redis 5.
-Commands not listed above are **not implemented**.
+**Note**: SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools.
Review comment:
based on our synchronous discussion:
one solution that would allow us to put the notes inline with the commands would be to bold the commands and have the note as a line or paragraph after the bolded text. so it would look like:
- **SETNX**
- **SLOWLOG** - SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools
- **SMEMBERS**
--
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:
users@infra.apache.org