diff --git a/README.md b/README.md index 8dcf0e212..3f371f202 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ For dragonfly-native replication, we are designing a distributed log format that After the replication feature we will continue with other Redis missing commands from APIs 3-6. -Please see [API readiness doc](docs/api_status.md) for the current status of Dragonfly. +Please see [The Command Reference](https://dragonflydb.io/docs/category/command-reference) for the current commands supported by Dragonfly. ## Design decisions diff --git a/docs/README.md b/docs/README.md index 43a18b637..d67bec3a8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ The easiest way to get started with Dragonfly is with Docker. ## Deployment Method -First, choose a deployment method. +First, choose a deployment method. If you are new to Dragonfly, we recommend the [DragonflyDB Docker Quick Start Guide](/docs/quick-start/) @@ -28,6 +28,4 @@ Other options: ## [Differences Between DragonflyDB and Redis](/docs/differences.md) -## [API Command Status](/docs/api_status.md) - - +## [API Commands Reference](https://dragonflydb.io/docs/category/command-reference) diff --git a/docs/api_status.md b/docs/api_status.md deleted file mode 100644 index 7ebd17abe..000000000 --- a/docs/api_status.md +++ /dev/null @@ -1,273 +0,0 @@ -The following document describes the current API status -with respect to Memcached and Redis APIs. - -## Memcache API -- [X] set -- [X] get -- [X] replace -- [X] add -- [X] stats (partial) -- [x] append -- [x] prepend -- [x] delete -- [x] flush_all -- [x] incr -- [x] decr -- [x] version -- [x] quit - - -## Redis API - -### API 1 -- [X] String family - - [X] SET - - [X] SETNX - - [X] GET - - [X] DECR - - [X] INCR - - [X] DECRBY - - [X] GETSET - - [X] INCRBY - - [X] MGET - - [X] MSET - - [X] MSETNX - - [X] SUBSTR -- [x] Generic family - - [X] DEL - - [X] ECHO - - [X] EXISTS - - [X] EXPIRE - - [X] EXPIREAT - - [X] KEYS - - [X] MOVE - - [X] PING - - [X] RENAME - - [X] RENAMENX - - [X] SELECT - - [X] TTL - - [X] TYPE - - [X] SORT -- [X] Server Family - - [X] AUTH - - [X] QUIT - - [X] DBSIZE - - [ ] BGSAVE - - [X] SAVE - - [X] DEBUG - - [X] EXEC - - [X] FLUSHALL - - [X] FLUSHDB - - [X] HELLO - - [X] INFO - - [X] MULTI - - [X] SHUTDOWN - - [X] LASTSAVE - - [X] SLAVEOF/REPLICAOF - - [ ] SYNC -- [X] Set Family - - [x] SADD - - [x] SCARD - - [X] SDIFF - - [X] SDIFFSTORE - - [X] SINTER - - [X] SINTERSTORE - - [X] SISMEMBER - - [X] SMOVE - - [X] SPOP - - [ ] SRANDMEMBER - - [X] SREM - - [X] SMEMBERS - - [X] SUNION - - [X] SUNIONSTORE -- [X] List Family - - [X] LINDEX - - [X] LLEN - - [X] LPOP - - [X] LPUSH - - [X] LRANGE - - [X] LREM - - [X] LSET - - [X] LTRIM - - [X] RPOP - - [X] RPOPLPUSH - - [X] RPUSH -- [X] SortedSet Family - - [X] ZADD - - [X] ZCARD - - [X] ZINCRBY - - [X] ZRANGE - - [X] ZRANGEBYSCORE - - [X] ZREM - - [X] ZREMRANGEBYSCORE - - [X] ZREVRANGE - - [X] ZSCORE -- [ ] Other - - [ ] BGREWRITEAOF - - [x] MONITOR - - [ ] RANDOMKEY - -### API 2 -- [X] List Family - - [X] BLPOP - - [X] BRPOP - - [X] BRPOPLPUSH - - [X] LINSERT - - [X] LPUSHX - - [X] RPUSHX -- [X] String Family - - [X] SETEX - - [X] APPEND - - [X] PREPEND (dragonfly specific) - - [x] BITCOUNT - - [ ] BITFIELD - - [x] BITOP - - [x] BITPOS - - [x] GETBIT - - [X] GETRANGE - - [X] INCRBYFLOAT - - [X] PSETEX - - [x] SETBIT - - [X] SETRANGE - - [X] STRLEN -- [X] HashSet Family - - [X] HSET - - [X] HMSET - - [X] HDEL - - [X] HEXISTS - - [X] HGET - - [X] HMGET - - [X] HLEN - - [X] HINCRBY - - [X] HINCRBYFLOAT - - [X] HGETALL - - [X] HKEYS - - [X] HSETNX - - [X] HVALS - - [X] HSCAN -- [X] PubSub family - - [X] PUBLISH - - [X] PUBSUB - - [X] PUBSUB CHANNELS - - [X] SUBSCRIBE - - [X] UNSUBSCRIBE - - [X] PSUBSCRIBE - - [X] PUNSUBSCRIBE -- [X] Server Family - - [X] WATCH - - [X] UNWATCH - - [X] DISCARD - - [X] CLIENT LIST/SETNAME/GETNAME - - [ ] CLIENT KILL/UNPAUSE/PAUSE/GETNAME/REPLY/TRACKINGINFO - - [X] COMMAND - - [X] COMMAND COUNT - - [ ] COMMAND GETKEYS/INFO - - [ ] CONFIG GET/REWRITE/SET/RESETSTAT - - [ ] MIGRATE - - [ ] ROLE - - [ ] SLOWLOG - - [ ] PSYNC - - [ ] TIME - - [ ] LATENCY... -- [X] Generic Family - - [X] SCAN - - [X] PEXPIREAT - - [X] PEXPIRE - - [x] DUMP - - [X] EVAL - - [X] EVALSHA - - [ ] OBJECT - - [x] PERSIST - - [X] PTTL - - [x] RESTORE - - [X] SCRIPT LOAD/EXISTS - - [ ] SCRIPT DEBUG/KILL/FLUSH -- [X] Set Family - - [X] SSCAN -- [X] Sorted Set Family - - [X] ZCOUNT - - [X] ZINTERSTORE - - [X] ZLEXCOUNT - - [X] ZRANGEBYLEX - - [X] ZRANK - - [X] ZREMRANGEBYLEX - - [X] ZREMRANGEBYRANK - - [X] ZREVRANGEBYSCORE - - [X] ZREVRANK - - [X] ZUNIONSTORE - - [X] ZSCAN -- [ ] HYPERLOGLOG Family - - [ ] PFADD - - [ ] PFCOUNT - - [ ] PFMERGE - -### API 3 -- [X] Generic Family - - [X] TOUCH -- [X] HashSet Family - - [X] HSTRLEN -- [X] Server Family - - [ ] CLIENT REPLY - - [X] REPLCONF - - [ ] WAIT - - [X] CLUSTER SLOTS - - [X] CLUSTER NODES - - [X] CLUSTER INFO - -### API 4 -- [X] Generic Family - - [X] UNLINK -- [ ] Server Family - - [ ] MEMORY USAGE/STATS/PURGE/DOCTOR - - [ ] SWAPDB - -### API 5 -- [X] Stream Family - - [X] XADD - - [ ] XCLAIM - - [X] XDEL - - [X] XGROUP CREATE/DELCONSUMER/DESTROY/HELP/SETID - - [ ] XGROUP CREATECONSUMER - - [X] XINFO GROUPS/HELP - - [ ] XINFO CONSUMERS/GROUPS/STREAM - - [X] XLEN - - [ ] XPENDING - - [X] XRANGE - - [ ] XREAD - - [ ] XREADGROUP - - [X] XREVRANGE - - [X] XSETID - - [ ] XTRIM - -- [X] Sorted Set Family - - [X] ZPOPMIN - - [X] ZPOPMAX - -### API 6 -- [X] String Family - - [X] GETEX - -- [X] Set Family - - [X] SMISMEMBER - -- [X] List Family - - [X] LMOVE - - [X] LPOS - - [X] BLMOVE - -- [ ] Stream Family - - [ ] XAUTOCLAIM - -- [X] Sorted Set Family - - [X] ZUNION - -### API 7 -- [ ] Server Family - - [ ] CLUSTER SHARDS - -## Notes -Some commands were implemented as decorators along the way: - - - [X] ROLE (2.8) decorator as master. - - [X] BGSAVE (decorator for save) - - [X] FUNCTION FLUSH (does nothing)