[redis.git] / TODO

Redis TODO and Roadmap

VERSION 1.4 TODO (Hash type)
============================

* BRPOPLPUSH
* RPOPLPUSH should notify blocking POP operations
* List ops like L/RPUSH L/RPOP should return the new list length.
* Save dataset / fsync() on SIGTERM
* MULTI/EXEC should support the "EXEC FSYNC" form
* Synchronous Virtual Memory
* BLPOP & C. tests (write a non blocking Tcl client as first step)

Virtual Memory sub-TODO:
* Check if the page selection algorithm is working well.
* Fix support for large files
* Divide swappability of objects by refcount
* While loading DB from snapshot or AOF, swap objects as needed if maxmemory
  is reached, calling swapOneObject().
* vm-swap-file <filename>. The swap file should go where the user wants, and if it's already there and of the right size we can avoid to create it again.

VERSION 1.6 TODO (Virtual memory)
=================================

* Asynchronous Virtual Memory
* Hashes (HSET, HGET, HEXISTS, HLEN, ...).

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).
* Specially encoded sets of integers (this includes a big refactoring providing an higher level layer for Sets manipulation)
* ZRANK: http://docs.google.com/viewer?a=v&q=cache:tCQaP3ZeN4YJ:courses.csail.mit.edu/6.046/spring04/handouts/ps5-sol.pdf+skip+list+rank+operation+augmented&hl=en&pid=bl&srcid=ADGEEShXuNjTcZyXw_1cq9OaWpSXy3PprjXqVzmM-LE0ETFznLyrDXJKQ_mBPNT10R8ErkoiXD9JbMw_FaoHmOA4yoGVrA7tZWiy393JwfCwuewuP93sjbkzZ_gnEp83jYhPYjThaIzw&sig=AHIEtbRF0GkYCdYRFtTJBE69senXZwFY0w

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
* Don't save empty lists / sets / zsets on disk with snapshotting.
* Remove keys when a list / set / zset reaches length of 0.

THE "MAYBE" TODO LIST: things that may or may not get implemented
=================================================================

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 ;)

* 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.
* Add an option to relax the delete-expiring-keys-on-write semantic *denying* replication and AOF when this is on? Can be handy sometimes, when using Redis for non persistent state, but can create problems. For instance should rename and move also "move" the timeouts? How does this affect other commands?
* Multiple BY in SORT.
Commit	Line	Data
f284d963	1	Redis TODO and Roadmap
f284d963	2
2014c437	3	VERSION 1.4 TODO (Hash type)
c35f7d5b	4	============================
23cff1a8	5
b177fd30	6	* BRPOPLPUSH
b177fd30	7	* RPOPLPUSH should notify blocking POP operations
09f6f702	8	* List ops like L/RPUSH L/RPOP should return the new list length.
b177fd30	9	* Save dataset / fsync() on SIGTERM
	10	* MULTI/EXEC should support the "EXEC FSYNC" form
	11	* Synchronous Virtual Memory
	12	* BLPOP & C. tests (write a non blocking Tcl client as first step)
f6b141c5	13
f870935d	14	Virtual Memory sub-TODO:
	15	* Check if the page selection algorithm is working well.
	16	* Fix support for large files
	17	* Divide swappability of objects by refcount
	18	* While loading DB from snapshot or AOF, swap objects as needed if maxmemory
	19	is reached, calling swapOneObject().
0d7170a4	20	* vm-swap-file <filename>. The swap file should go where the user wants, and if it's already there and of the right size we can avoid to create it again.
f870935d	21
2014c437	22	VERSION 1.6 TODO (Virtual memory)
c35f7d5b	23	=================================
7d65b33d	24
b177fd30	25	* Asynchronous Virtual Memory
b177fd30	26	* Hashes (HSET, HGET, HEXISTS, HLEN, ...).
7d65b33d	27
2014c437	28	VERSION 1.8 TODO (Fault tollerant sharding)
c35f7d5b	29	===========================================
7d65b33d	30
c35f7d5b	31	* Redis-cluster, a fast intermediate layer (proxy) that implements consistent hashing and fault tollerant nodes handling.
7d65b33d	32
5b2a1c29	33	Interesting readings about this:
	34
	35	- http://ayende.com/Blog/archive/2009/04/06/designing-rhino-dht-a-fault-tolerant-dynamically-distributed-hash.aspx
	36
2014c437	37	VERSION 2.0 TODO (Optimizations and latency)
c35f7d5b	38	============================================
7d65b33d	39
	40	* Lower the CPU usage.
	41	* Lower the RAM usage everywhere possible.
	42	* Use epool and alike to rewrite ae.c for Linux and other platforms suppporting fater-than-select() mutiplexing APIs.
	43	* Implement an UDP interface for low-latency GET/SET operations.
	44
2014c437	45	VERSION 2.2 TODO (Optimizations and latency)
	46	============================================
	47
	48	* 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.
	49
3f477979	50	OTHER IMPORTANT THINGS THAT WILL BE ADDED BUT I'M NOT SURE WHEN
	51	===============================================================
	52
	53	BIG ONES:
	54
	55	* Specially encoded memory-saving integer sets.
	56	* A command to export a JSON dump (there should be mostly working patch needing major reworking).
f0c138f6	57	* Specially encoded sets of integers (this includes a big refactoring providing an higher level layer for Sets manipulation)
322fc7d8	58	* ZRANK: http://docs.google.com/viewer?a=v&q=cache:tCQaP3ZeN4YJ:courses.csail.mit.edu/6.046/spring04/handouts/ps5-sol.pdf+skip+list+rank+operation+augmented&hl=en&pid=bl&srcid=ADGEEShXuNjTcZyXw_1cq9OaWpSXy3PprjXqVzmM-LE0ETFznLyrDXJKQ_mBPNT10R8ErkoiXD9JbMw_FaoHmOA4yoGVrA7tZWiy393JwfCwuewuP93sjbkzZ_gnEp83jYhPYjThaIzw&sig=AHIEtbRF0GkYCdYRFtTJBE69senXZwFY0w
3f477979	59
	60	SMALL ONES:
	61
	62	* 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.
25e52257	63	* MSADD (n keys) (n values). See this thread in the Redis google group: http://groups.google.com/group/redis-db/browse_thread/thread/e766d84eb375cd41
f0c138f6	64	* Don't save empty lists / sets / zsets on disk with snapshotting.
f0c138f6	65	* Remove keys when a list / set / zset reaches length of 0.
3f477979	66
f0c138f6	67	THE "MAYBE" TODO LIST: things that may or may not get implemented
f0c138f6	68	=================================================================
f6b141c5	69
0188805d	70	Most of this can be seen just as proposals, the fact they are in this list
	71	it's not a guarantee they'll ever get implemented ;)
	72
57033301	73	* Move dict.c from hash table to skip list, in order to avoid the blocking resize operation needed for the hash table.
682ac724	74	* FORK command (fork()s executing the commands received by the current
	75	client in the new process). Hint: large SORTs can use more cores,
	76	copy-on-write will avoid memory problems.
	77	* DUP command? DUP srckey dstkey, creates an exact clone of srckey value in dstkey.
	78	* SORT: Don't copy the list into a vector when BY argument is constant.
	79	* 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.
	80	* LOCK / TRYLOCK / UNLOCK as described many times in the google group
	81	* Replication automated tests
	82	* 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.
	83	* 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.
	84	* Read-only mode.
	85	* Pattern-matching replication.
ac945e2d	86	* Add an option to relax the delete-expiring-keys-on-write semantic denying replication and AOF when this is on? Can be handy sometimes, when using Redis for non persistent state, but can create problems. For instance should rename and move also "move" the timeouts? How does this affect other commands?
f0c138f6	87	* Multiple BY in SORT.