GEODE-9087: redis docs for HSCAN command (apache#6235)

(cherry picked from commit 9964531)
nonbinaryprogrammer · Apr 7, 2021 · d2c05d4 · d2c05d4
1 parent ba47d66
commit d2c05d4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/geode-apis-compatible-with-redis/README.md b/geode-apis-compatible-with-redis/README.md
@@ -174,15 +174,15 @@ start server \
 | HLEN               	| HINCRBY                                            	| BITFIELD                      	|
 | HVALS               	| HINCRBYFLOAT                                       	| BLPOP                         	|
 | INFO               	| HKEYS                                              	| BRPOP                         	|
-| KEYS               	| HSCAN                                              	| BRPOPLPUSH                    	|
+| KEYS               	| HSCAN[3]                                             	| 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                  	|
+| QUIT               	| SCAN                                              	| CLIENT PAUSE                  	|
 | RENAME             	| SCARD                                                 | CLIENT REPLY                  	|
 | SADD              	| SDIFF                                              	| CLIENT SETNAME                	|
 | SET                   | SDIFFSTORE                                         	| CLIENT TRACKING               	|
@@ -329,9 +329,10 @@ start server \
 |                    	|                                                    	| ZREVRANK                      	|
 |                    	|                                                    	| ZSCAN                         	|
 |                    	|                                                    	| ZSCORE                        	|
-|                    	|                                                    	| ZUNIONSTORE                   	|                   	|
+|                    	|                                                    	| ZUNIONSTORE                   	|
 
 **NOTES:**
 
 [1] - UNLINK is implemented as a synonym to DEL and does not unlink asynchronously.
 [2] - SLOWLOG is implemented as a NoOp.
+[3] - Redis accepts 64-bit signed integers for the HSCAN cursor and COUNT parameters. The Geode APIs compatible with Redis are limited to 32-bit integer values for these parameters.
diff --git a/geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb b/geode-docs/tools_modules/geode_apis_compatible_with_redis.html.md.erb
@@ -68,6 +68,7 @@ The <%=vars.product_name%> APIs compatible with Redis currently supports the fol
 
 **Note**: These commands are supported for Redis 5.
 **Note**: SLOWLOG is implemented as a NoOp for compatibility with some monitoring tools.
+**Note**: Redis accepts 64-bit signed integers for the HSCAN cursor and COUNT parameters. The Geode APIs compatible with Redis are limited to 32-bit integer values for these parameters.
 
 -   **Connection**: AUTH, PING, QUIT
 -   **Hashes**: HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HLEN, HMGET, HMSET, HSCAN, HSET, HSETNX, HSTRLEN, HVALS