flatdb 0.1.0

API

There are three endpoints. Each accepts multiple values at a time. All use HTTP GET. (This is not a RESTful interface.)

GET /get?key=foo&key=bar HTTP/1.1

GET /getrange?from=from_key HTTP/1.1

GET /put?foo=bar&baz=qux HTTP/1.1

GET /delete?key=foo&key=baz HTTP/1.1

Why FlatDB?

LevelDB is an ideal solution for a persistent, fast key-value store. (RocksDB is an alternative from Facebook that has a lot in common, but is also very new.) Since LevelDB (and RocksDB) is a library-level data store, FlatDB provides a simple, service-oriented interface to it.

Other projects, like RevelDB and the Python leveldb-server package, provide similar functionality, but:

• RevelDB barely built and then segfaulted on startup.

• leveldb-server is weird and tornadoy and undocumented.

Running FlatDB

FlatDB installs two executable scripts: flatdb and flatdb-dev.

$ flatdb -h
usage: flatdb [-h] [-d] [-p PORT] [-b DATABASE] [-H HOST]

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug
  -p PORT, --port PORT
  -b DATABASE, --database DATABASE
  -H HOST, --host HOST

--port:

Port to listen on. (7532)

--host:

Address to bind to. (127.0.0.1)

--database:

Path to a LevelDB (will be created if it doesn’t exist).

flatdb runs a gevent server. flatdb-dev runs the built-in Flask server.