html doc updated

[redis.git] / TODO

diff --git a/TODO b/TODO
index 98398aa50e2717e6496cbc7dbc8d9ca21e67b386..59c0bb14238ed41d0897593db0e3972860676159 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,34 +1,84 @@
-VERSION 1.1 TODO
+Redis TODO and Roadmap

 
 

-* For now only the last argument gets integer encoded, so make sure that: 1) every multi bulk commands implemented will have the last arg that is indeed a value, and not used otherwise. 2) to explicitly call the function to encode the object in MSET and other commands where there are multiple "values".
-* Man pages for MSET MSETNX and SRANDMEMBER, Z-commands, ...
-* ZSETs missing stuff: ZINCRBY
-* Add all the missing symbols for the statis functions into the table. This backtrace on segfault is indeed *very* useful.
-* Use strcoll() to compare objects in sorted sets, like it already happens for SORT.
-* LMOVE, as discussed in the Redis group.
-* EXPIRE and EXPIREAT tests.
+VERSION 1.2 TODO (Zsets, Integer encoding, Append only journal)
+===============================================================

 
 

-VERSION 1.2 TODO
+Most of the features already implemented for this release. The following is a list of the missing things in order to release the first beta tar.gz:

 
 

-* Basic Redis-cluster (at least all the features of the Ruby client distribute implementation + ability to set every key in M nodes).
-* Append mode log
+* Continue adding tests accordingly to gcov output.
+
+VERSION 1.4 TODO (Hash type)
+============================
+
+* Blocking LPOP (BLPOP).

 * Hashes (HSET, HGET, HEXISTS, HLEN, ...).
 * Hashes (HSET, HGET, HEXISTS, HLEN, ...).

-* An utility able to export an .rdb file into a text-only JSON dump, we can't live anymore without such a tool. Probably an extension to redis-cli.
+* List ops like L/RPUSH L/RPOP should return the new list length.
+
+VERSION 1.6 TODO (Virtual memory)
+=================================
+
+* Redis Virtual Memory for datasets bigger than RAM (http://groups.google.com/group/redis-db/msg/752997c7b38553cd)
+
+VERSION 1.8 TODO (Fault tollerant sharding)
+===========================================
+
+* Redis-cluster, a fast intermediate layer (proxy) that implements consistent hashing and fault tollerant nodes handling.
+
+Interesting readings about this:
+
+    - http://ayende.com/Blog/archive/2009/04/06/designing-rhino-dht-a-fault-tolerant-dynamically-distributed-hash.aspx
+
+VERSION 2.0 TODO (Optimizations and latency)
+============================================
+
+* Lower the CPU usage.
+* Lower the RAM usage everywhere possible.
+* Use epool and alike to rewrite ae.c for Linux and other platforms suppporting fater-than-select() mutiplexing APIs.
+* Implement an UDP interface for low-latency GET/SET operations.
+
+VERSION 2.2 TODO (Optimizations and latency)
+============================================
+
+* JSON command able to access data serialized in JSON format. For instance if I've a key foobar with a json object I can alter the "name" file using somthing like: "JSON SET foobar name Kevin". We should have GET and INCRBY as well.
+
+OTHER IMPORTANT THINGS THAT WILL BE ADDED BUT I'M NOT SURE WHEN
+===============================================================
+
+BIG ONES:
+
+* Specially encoded memory-saving integer sets.
+* A command to export a JSON dump (there should be mostly working patch needing major reworking).
+
+SMALL ONES:
+
+* Give errors when incrementing a key that does not look like an integer, when providing as a sorted set score something can't be parsed as a double, and so forth.
+* MSADD (n keys) (n values). See this thread in the Redis google group: http://groups.google.com/group/redis-db/browse_thread/thread/e766d84eb375cd41
+
+SHORT/LONG TERM RANDOM TODO ITEMS
+=================================
+
+Most of this can be seen just as proposals, the fact they are in this list
+it's not a guarantee they'll ever get implemented ;)

 
 

-LONG TERM TODO
+* Move dict.c from hash table to skip list, in order to avoid the blocking resize operation needed for the hash table.
+* FORK command (fork()s executing the commands received by the current
+  client in the new process). Hint: large SORTs can use more cores,
+  copy-on-write will avoid memory problems.
+* DUP command? DUP srckey dstkey, creates an exact clone of srckey value in dstkey.
+* SORT: Don't copy the list into a vector when BY argument is constant.
+* Write the hash table size of every db in the dump, so that Redis can resize the hash table just one time when loading a big DB.
+* LOCK / TRYLOCK / UNLOCK as described many times in the google group
+* Replication automated tests
+* Byte Array type (BA prefixed commands): BASETBIT BAGETBIT BASETU8 U16 U32 U64 S8 S16 S32 S64, ability to atomically INCRBY all the base types. BARANGE to get a range of bytes as a bulk value, BASETRANGE to set a range of bytes.
+* zmalloc() should avoid to add a private header for archs where there is some other kind of libc-specific way to get the size of a malloced block. Already done for Mac OS X.
+* Read-only mode.
+* Pattern-matching replication.
+* Don't save empty lists / sets / zsets on disk with snapshotting.
+* Remove keys when a list / set / zset reaches length of 0.

 
 

-* Expiring algorithm should be adaptive, if there are a lot of keys with an expire set and many of this happen to be already expired it should be, proportionally, more aggressive.
- * Add a command to inspect the currently selected DB index
- * Consistent hashing implemented in all the client libraries having an user base
- * SORT: Don't copy the list into a vector when BY argument is constant.
- * Profiling and optimization in order to limit the CPU usage at minimum
- * Write the hash table size of every db in the dump, so that Redis can resize the hash table just one time when loading a big DB.
- * Elapsed time in logs for SAVE when saving is going to take more than 2 seconds
- * LOCK / TRYLOCK / UNLOCK as described many times in the google group
- * Replication automated tests
- * BITMAP / BYTEARRAY type?
- * zmalloc() should avoid to add a private header for archs where there is some other kind of libc-specific way to get the size of a malloced block.
+DOCUMENTATION WISHLIST
+======================

 
 

-FUTURE HINTS
+* Page explaining tips to reduce memory usage.
+* A Sorted sets HOWTO

 
 

-- In memory compression: if in-memory values compression will be implemented, make sure to implement this so that addReply() is able to handle compressed objects, just creating an uncompressed version on the fly and adding this to the output queue instead of the original one. When insetad we need to look at the object string value (SORT BY for example), call a function that will turn the object into an uncompresed one. (Note, Redis 1.1 beta already has this feature actually, but is for now only used to compress strings representing integers)