erebor 2.0.3

key-value store

erebor

Erebor is a lightweight key-value store with a Redis-like syntax.

Installation

To install the erebor server:

pip install erebor

Usage

Run the server like so:

$ erebor

You can verify erebor is running by connecting to 127.0.0.1:8044.

$ nc localhost 8044
keys
[]
set foo bar
OK
keys
['foo']
get foo
bar

API

Erebor recognizes the following commands:

    set   <key> <value>  set a key to a value
    del   <key>          remove a key and its value
    get   <key>          retrieve the value of a key
    keys  [prefix]       return a list of keys starting with prefix

Configuration

Erebor listens on 127.0.0.1:8044. You can change this by modifying the port variable at the top of the file.

$ vim $(which erebor)

You can also change the bind address. However, for security reasons, it is not recommended to bind on 0.0.0.0 and expose the database to the world.

By default, erebor runs in ephemeral mode, where keys are only stored in memory and not persisted to disk. To run in persistence mode, run with the -p option. This will save the database to a local JSON file called keys.db.

Other notes

The erebor API uses vanilla TCP sockets, so you can make API requests using netcat.

$ echo "set home $(cat index.html)" | nc -q 0 localhost 8044
OK

You can also talk to erebor programmatically using any language that can speak TCP:

import socket

# Setup a socket to the host and port where erebor is running.
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 8044))

def erebor(message):
    sock.send(message.encode())
    return sock.recv(1024).decode().strip()

print(erebor("set foo bar"))
# OK
print(erebor("get foo"))
# bar