API compatibility
Below is the full list of API commands and their implementation status in Garnet.
Note that this list is subject to change as we continue to expand our API command support with the help of our growing community.
Command Categories
- ACL
- BITMAP
- CLIENT
- CLUSTER
- COMMAND
- CONNECTION
- FUNCTIONS
- GENERIC
- GEO
- HASH
- HYPERLOGLOG
- KEYS
- LATENCY
- LIST
- MEMORY
- MODULE
- OBJECT
- PUB/SUB
- SCRIPTING
- SERVER
- SET
- SLOWLOG
- SORTED SET
- STREAM
- STRING
- TRANSACTIONS
Full Commands List
Legend: ➕ = supported, ➖ = not supported.
| Category | Command | Implemented in Garnet | Notes |
|---|---|---|---|
| ACL | CAT | ➕ | |
| DELUSER | ➕ | ||
| DRYRUN | ➖ | ||
| GENPASS | ➕ | ||
| GETUSER | ➕ | ||
| LIST | ➕ | ||
| LOAD | ➕ | ||
| HELP | ➖ | ||
| LOG | ➖ | ||
| SAVE | ➕ | ||
| SETUSER | ➕ | ||
| USERS | ➕ | ||
| WHOAMI | ➕ | ||
| BITMAP | BITCOUNT | ➕ | |
| BITFIELD | ➕ | ||
| BITFIELD_RO | ➕ | ||
| BITOP AND | ➕ | ||
| BITOP NOT | ➕ | ||
| BITPOS | ➕ | ||
| GETBIT | ➕ | ||
| SETBIT | ➕ | ||
| CLIENT | CACHING | ➖ | |
| GETNAME | ➕ | ||
| GETREDIR | ➖ | ||
| HELP | ➖ | ||
| ID | ➕ | ||
| INFO | ➕ | ||
| KILL | ➕ | ||
| LIST | ➕ | ||
| NO-EVICT | ➖ | ||
| NO-TOUCH | ➖ | ||
| PAUSE | ➖ | ||
| REPLY | ➖ | ||
| SETINFO | ➕ | ||
| SETNAME | ➕ | ||
| TRACKING | ➖ | ||
| TRACKINGINFO | ➖ | ||
| UNBLOCK | ➕ | ||
| UNPAUSE | ➖ | ||
| CLUSTER | ADDSLOTS | ➕ | |
| ADDSLOTSRANGE | ➕ | ||
| ASKING | ➕ | ||
| BUMPEPOCH | ➕ | ||
| COUNT-FAILURE-REPORTS | ➖ | ||
| COUNTKEYSINSLOT | ➕ | ||
| DELSLOTS | ➕ | ||
| DELSLOTSRANGE | ➕ | ||
| FAILOVER | ➕ | ||
| FLUSHSLOTS | ➖ | ||
| FORGET | ➕ | ||
| GETKEYSINSLOT | ➕ | ||
| HELP | ➕ | ||
| INFO | ➕ | ||
| KEYSLOT | ➕ | ||
| LINKS | ➖ | ||
| MEET | ➕ | ||
| MYID | ➕ | ||
| MYSHARDID | ➖ | ||
| NODES | ➕ | ||
| READONLY | ➕ | ||
| READWRITE | ➕ | ||
| REPLICAS | ➕ | ||
| REPLICATE | ➕ | ||
| RESET | ➕ | ||
| SAVECONFIG | ➖ | ||
| SET-CONFIG-EPOCH | ➕ | ||
| SETSLOT | ➕ | ||
| SHARDS | ➕ | ||
| SLAVES | ➕ | (Deprecated) | |
| SLOTS | ➕ | (deprecated) | |
| SPUBLISH | ➕ | ||
| COMMAND | COMMAND | ➕ | |
| COUNT | ➕ | ||
| DOCS | ➕ | ||
| GETKEYS | ➕ | ||
| GETKEYSANDFLAGS | ➕ | ||
| HELP | ➖ | ||
| INFO | ➕ | ||
| LIST | ➖ | ||
| CONNECTION | AUTH | ➕ | |
| ECHO | ➕ | ||
| HELLO | ➕ | ||
| PING | ➕ | ||
| QUIT | ➕ | (Deprecated) | |
| SELECT | ➕ | ||
| FUNCTIONS | FCALL | ➖ | |
| FCALL_RO | ➖ | ||
| DELETE | ➖ | ||
| DUMP | ➖ | ||
| FLUSH | ➖ | ||
| HELP | ➖ | ||
| KILL | ➖ | ||
| LIST | ➖ | ||
| LOAD | ➖ | ||
| RESTORE | ➖ | ||
| STATS | ➖ | ||
| GENERIC | PERSIST | ➕ | |
| PEXPIRE | ➕ | ||
| PEXPIREAT | ➕ | ||
| PEXPIRETIME | ➕ | ||
| PTTL | ➕ | ||
| RANDOMKEY | ➖ | ||
| RENAME | ➕ | ||
| RENAMENX | ➕ | ||
| RESTORE | ➕ | ||
| SCAN | ➕ | ||
| SORT | ➖ | ||
| SORT_RO | ➖ | ||
| TOUCH | ➕ | No per-key access-time tracking. | |
| TTL | ➕ | ||
| TYPE | ➕ | ||
| UNLINK | ➕ | ||
| WAIT | ➖ | ||
| WAITAOF | ➖ | ||
| GEO | GEOADD | ➕ | |
| GEODIST | ➕ | ||
| GEOHASH | ➕ | ||
| GEOPOS | ➕ | ||
| GEORADIUS | ➕ | (Deprecated) | |
| GEORADIUS_RO | ➕ | (Deprecated) | |
| GEORADIUSBYMEMBER | ➕ | (Deprecated) | |
| GEORADIUSBYMEMBER_RO | ➕ | (Deprecated) | |
| GEOSEARCH | ➕ | ||
| GEOSEARCHSTORE | ➕ | ||
| HASH | HDEL | ➕ | |
| HEXISTS | ➕ | ||
| HEXPIRE | ➕ | ||
| HEXPIREAT | ➕ | ||
| HEXPIRETIME | ➕ | ||
| HGET | ➕ | ||
| HGETALL | ➕ | ||
| HINCRBY | ➕ | ||
| HINCRBYFLOAT | ➕ | ||
| HKEYS | ➕ | ||
| HLEN | ➕ | ||
| HMGET | ➕ | ||
| HMSET | ➕ | (Deprecated) | |
| HPERSIST | ➕ | ||
| HPEXPIRE | ➕ | ||
| HPEXPIREAT | ➕ | ||
| HPEXPIRETIME | ➕ | ||
| HPTTL | ➕ | ||
| HRANDFIELD | ➕ | ||
| HSCAN | ➕ | ||
| HSET | ➕ | ||
| HSETNX | ➕ | ||
| HSTRLEN | ➕ | ||
| HTTL | ➕ | ||
| HVALS | ➕ | ||
| HYPERLOGLOG | PFADD | ➕ | |
| PFCOUNT | ➕ | ||
| PFDEBUG | ➖ | Internal command | |
| PFMERGE | ➕ | ||
| PFSELFTEST | ➖ | Internal command | |
| KEYS | COPY | ➖ | |
| DEL | ➕ | ||
| DUMP | ➕ | ||
| EXISTS | ➕ | ||
| EXPIRE | ➕ | ||
| EXPIREAT | ➕ | ||
| EXPIRETIME | ➕ | ||
| KEYS | ➕ | ||
| MIGRATE | ➕ | ||
| MOVE | ➖ | ||
| LATENCY | DOCTOR | ➖ | |
| GRAPH | ➖ | ||
| HELP | ➕ | ||
| HISTOGRAM | ➕ | ||
| HISTORY | ➖ | ||
| LATEST | ➖ | ||
| RESET | ➕ | ||
| LIST | BLMOVE | ➕ | |
| BLMPOP | ➕ | ||
| BLPOP | ➕ | ||
| BRPOP | ➕ | ||
| BRPOPLPUSH | ➕ | (Deprecated) | |
| LINDEX | ➕ | ||
| LINSERT | ➕ | ||
| LLEN | ➕ | ||
| LMOVE | ➕ | ||
| LMPOP | ➕ | ||
| LPOP | ➕ | ||
| LPOS | ➕ | ||
| LPUSH | ➕ | ||
| LPUSHX | ➕ | ||
| LRANGE | ➕ | ||
| LREM | ➕ | ||
| LSET | ➕ | ||
| LTRIM | ➕ | ||
| RPOP | ➕ | ||
| RPOPLPUSH | ➕ | (Deprecated) | |
| RPUSH | ➕ | ||
| RPUSHX | ➕ | ||
| MEMORY | DOCTOR | ➖ | |
| HELP | ➖ | ||
| MALLOC-STATS | ➖ | ||
| PURGE | ➖ | ||
| STATS | ➖ | ||
| USAGE | ➕ | ||
| MODULE | HELP | ➖ | |
| LIST | ➖ | ||
| LOAD | ➖ | ||
| LOADEX | ➖ | ||
| UNLOAD | ➖ | ||
| OBJECT | ENCODING | ➕ | |
| FREQ | ➕ | Always returns an error; Garnet does not track access frequency (LFU) | |
| HELP | ➕ | ||
| IDLETIME | ➕ | Always returns 0; Garnet does not track per-key idle time | |
| REFCOUNT | ➕ | Always returns 1; Garnet does not share value objects | |
| PUB/SUB | PSUBSCRIBE | ➕ | |
| PUBLISH | ➕ | ||
| PUBSUB CHANNELS | ➕ | ||
| PUBSUB HELP | ➖ | ||
| PUBSUB NUMPAT | ➕ | ||
| PUBSUB NUMSUB | ➕ | ||
| PUBSUB SHARDCHANNELS | ➖ | ||
| PUBSUB SHARDNUMSUB | ➖ | ||
| PUNSUBSCRIBE | ➕ | ||
| SUBSCRIBE | ➕ | ||
| UNSUBSCRIBE | ➕ | ||
| SCRIPTING | EVAL | ➕ | |
| EVAL_RO | ➖ | ||
| EVALSHA | ➕ | ||
| EVALSHA_RO | ➖ | ||
| SCRIPT DEBUG | ➖ | ||
| SCRIPT EXISTS | ➕ | ||
| SCRIPT FLUSH | ➕ | ||
| SCRIPT HELP | ➖ | ||
| SCRIPT KILL | ➖ | ||
| SCRIPT LOAD | ➕ | ||
| SERVER | BGREWRITEAOF | ➖ | |
| BGSAVE | ➕ | ||
| COMMITAOF | ➕ | ||
| CONFIG GET | ➕ | ||
| CONFIG HELP | ➖ | ||
| CONFIG RESETSTAT | ➖ | ||
| CONFIG REWRITE | ➕ | ||
| CONFIG SET | ➕ | ||
| DBSIZE | ➕ | ||
| DEBUG | ➕ | Internal command | |
| FLUSHALL | ➕ | ||
| FLUSHDB | ➕ | ||
| INFO | ➕ | ||
| LASTSAVE | ➕ | ||
| LOLWUT | ➖ | ||
| MONITOR | ➖ | Always returns an error; Garnet does not stream commands because of the impact on critical paths | |
| PSYNC | ➖ | ||
| REPLCONF | ➖ | ||
| REPLICAOF | ➕ | ||
| RESTORE-ASKING | ➖ | ||
| ROLE | ➕ | ||
| SAVE | ➕ | ||
| SHUTDOWN | ➖ | ||
| SLAVEOF | ➕ | (Deprecated) | |
| SWAPDB | ➕ | ||
| SYNC | ➖ | ||
| TIME | ➕ | ||
| SET | SADD | ➕ | |
| SCARD | ➕ | ||
| SDIFF | ➕ | ||
| SDIFFSTORE | ➕ | ||
| SINTER | ➕ | ||
| SINTERSTORE | ➕ | ||
| SINTERCARD | ➕ | ||
| SISMEMBER | ➕ | ||
| SMEMBERS | ➕ | ||
| SMISMEMBER | ➕ | ||
| SMOVE | ➕ | ||
| SPOP | ➕ | ||
| SPUBLISH | ➕ | ||
| SRANDMEMBER | ➕ | ||
| SREM | ➕ | ||
| SSCAN | ➕ | ||
| SSUBSCRIBE | ➕ | ||
| SUNION | ➕ | ||
| SUNIONSTORE | ➕ | ||
| SUNSUBSCRIBE | ➖ | ||
| SLOWLOG | GET | ➕ | |
| HELP | ➕ | ||
| LEN | ➕ | ||
| RESET | ➕ | ||
| SORTED SET | BZMPOP | ➕ | |
| BZPOPMAX | ➕ | ||
| BZPOPMIN | ➕ | ||
| ZADD | ➕ | ||
| ZCARD | ➕ | ||
| ZCOUNT | ➕ | ||
| ZDIFF | ➕ | ||
| ZDIFFSTORE | ➕ | ||
| ZEXPIRE | ➕ | ||
| ZEXPIREAT | ➕ | ||
| ZEXPIRETIME | ➕ | ||
| ZINCRBY | ➕ | ||
| ZINTER | ➕ | ||
| ZINTERCARD | ➕ | ||
| ZINTERSTORE | ➕ | ||
| ZLEXCOUNT | ➕ | ||
| ZMPOP | ➕ | ||
| ZMSCORE | ➕ | ||
| ZPERSIST | ➕ | ||
| ZPEXPIRE | ➕ | ||
| ZPEXPIREAT | ➕ | ||
| ZPEXPIRETIME | ➕ | ||
| ZPOPMAX | ➕ | ||
| ZPOPMIN | ➕ | ||
| ZPTTL | ➕ | ||
| ZRANDMEMBER | ➕ | ||
| ZRANGE | ➕ | ||
| ZRANGEBYLEX | ➕ | (Deprecated) | |
| ZRANGEBYSCORE | ➕ | (Deprecated) | |
| ZRANGESTORE | ➕ | ||
| ZRANK | ➕ | ||
| ZREM | ➕ | ||
| ZREMRANGEBYLEX | ➕ | ||
| ZREMRANGEBYRANK | ➕ | ||
| ZREMRANGEBYSCORE | ➕ | ||
| ZREVRANGE | ➕ | (Deprecated) | |
| ZREVRANGEBYLEX | ➕ | (Deprecated) | |
| ZREVRANGEBYSCORE | ➕ | (Deprecated) | |
| ZREVRANK | ➕ | ||
| ZSCAN | ➕ | ||
| ZSCORE | ➕ | ||
| ZTTL | ➕ | ||
| ZUNION | ➕ | ||
| ZUNIONSTORE | ➕ | ||
| STREAM | XACK | ➖ | |
| XADD | ➖ | ||
| XAUTOCLAIM | ➖ | ||
| XCLAIM | ➖ | ||
| XDEL | ➖ | ||
| XGROUP CREATE | ➖ | ||
| XGROUP CREATECONSUMER | ➖ | ||
| XGROUP DELCONSUMER | ➖ | ||
| XGROUP DESTROY | ➖ | ||
| XGROUP HELP | ➖ | ||
| XGROUP SETID | ➖ | ||
| XINFO CONSUMERS | ➖ | ||
| XINFO GROUPS | ➖ | ||
| XINFO HELP | ➖ | ||
| XINFO STREAM | ➖ | ||
| XLEN | ➖ | ||
| XPENDING | ➖ | ||
| XRANGE | ➖ | ||
| XREAD | ➖ | ||
| XREADGROUP | ➖ | ||
| XREVRANGE | ➖ | ||
| XSETID | ➖ | ||
| XTRIM | ➖ | ||
| STRING | APPEND | ➕ | |
| DECR | ➕ | ||
| DECRBY | ➕ | ||
| DELEX | ➕ | Supports unconditional, IFEQ, IFNE, IFDEQ, and IFDNE. | |
| DELIFEQ | ➕ | ||
| DIGEST | ➕ | On-demand XXH3-64 digest. | |
| GET | ➕ | ||
| GETDEL | ➕ | ||
| GETEX | ➕ | ||
| GETRANGE | ➕ | ||
| GETSET | ➕ | ||
| INCR | ➕ | ||
| INCRBY | ➕ | ||
| INCRBYFLOAT | ➕ | ||
| LCS | ➕ | ||
| MGET | ➕ | ||
| MSET | ➕ | ||
| MSETNX | ➕ | ||
| PSETEX | ➕ | (Deprecated) | |
| SET | ➕ | Supports IFEQ, IFNE, IFDEQ, and IFDNE. | |
| SETEX | ➕ | (Deprecated) | |
| SETNX | ➕ | ||
| SETRANGE | ➕ | ||
| STRLEN | ➕ | ||
| SUBSTR | ➕ | (Deprecated) | |
| TRANSACTIONS | DISCARD | ➕ | |
| EXEC | ➕ | ||
| MULTI | ➕ | ||
| UNWATCH | ➕ | ||
| WATCH | ➕ | ||
| JSON Module | JSON Module | ➕ | Partially Implemented |
| RANGE INDEX (Preview) | RI.CREATE | ➕ | Preview |
| RI.SET | ➕ | Preview | |
| RI.GET | ➕ | Preview | |
| RI.DEL | ➕ | Preview | |
| RI.SCAN | ➕ | Preview | |
| RI.RANGE | ➕ | Preview | |
| RI.EXISTS | ➕ | Preview | |
| RI.CONFIG | ➕ | Preview | |
| RI.METRICS | ➕ | Preview | |
| VECTOR SET (Preview) | VADD | ➕ | Preview |
| VSIM | ➕ | Preview | |
| VREM | ➕ | Preview | |
| VEMB | ➕ | Preview (no RAW) | |
| VDIM | ➕ | Preview | |
| VINFO | ➕ | Preview | |
| VGETATTR | ➕ | Preview | |
| VCARD | ➖ | Not yet implemented | |
| VISMEMBER | ➖ | Not yet implemented | |
| VLINKS | ➖ | Not yet implemented | |
| VRANDMEMBER | ➖ | Not yet implemented | |
| VSETATTR | ➖ | Not yet implemented |