A high performance NoSQL Database Server powered by Go

Go to file

siddontang a3faef12e6 Merge branch 'develop'		2014-10-08 16:39:49 +08:00
Godeps	update goleveldb	2014-10-08 13:05:18 +08:00
client	add config rewrite command	2014-10-08 16:39:14 +08:00
cmd	Merge branch 'develop'	2014-10-08 16:39:49 +08:00
config	config add rewrite	2014-10-08 16:20:09 +08:00
doc	add config rewrite command	2014-10-08 16:39:14 +08:00
etc	add wait max slave acks config	2014-10-05 17:24:44 +08:00
ledis	support zset lex commands	2014-10-01 23:26:46 +08:00
lua	use golua directly	2014-09-13 14:11:05 +08:00
rpl	add compression for log	2014-09-27 10:08:45 +08:00
server	add config rewrite command	2014-10-08 16:39:14 +08:00
store	add DBPath and UseBinLog config	2014-09-18 22:30:33 +08:00
tools	add data migration support for data type Set	2014-10-08 11:33:43 +08:00
.gitignore	support godep	2014-10-01 16:47:35 +08:00
LICENSE	Initial commit	2014-04-29 17:43:09 -07:00
Makefile	support godep	2014-10-01 16:47:35 +08:00
README.md	update read me	2014-10-05 08:56:35 +08:00
bootstrap.sh	support godep	2014-10-01 16:47:35 +08:00
dev.sh	update lua bash	2014-09-13 14:34:15 +08:00

README.md

LedisDB

Ledisdb is a high performance NoSQL like Redis written by go. It supports some data structure like kv, list, hash, zset, bitmap,set.

LedisDB now supports multiple databases as backend to store data, you can test and choose the proper one for you.

Features

Rich data structure: KV, List, Hash, ZSet, Bitmap, Set.
Stores lots of data, over the memory limit.
Various backend database to use: LevelDB, goleveldb, LMDB, RocksDB, BoltDB, HyperLevelDB, Memory.
Supports transaction using LMDB or BotlDB.
Supports lua scripting.
Supports expiration and ttl.
Supports using redis-cli directly.
Multiple client API support, including Go, Python, Lua(Openresty), C/C++, Node.js.
Easy to embed in your own Go application.
Restful API support, json/bson/msgpack output.
Replication to guarantee data safe.
Supplies tools to load, dump, repair database.

Build and Install

Create a workspace and checkout ledisdb source

mkdir $WORKSPACE
cd $WORKSPACE
git clone git@github.com:siddontang/ledisdb.git src/github.com/siddontang/ledisdb

cd src/github.com/siddontang/ledisdb

#set build and run environment 
source dev.sh

make
make test

Godep support

LedisDB supports building with godep which can manage LedisDB go dependence automatically.

LevelDB support

Install leveldb and snappy.

LedisDB supplies a simple script to install leveldb and snappy:
```
  sudo sh tools/build_leveldb.sh
```
It will default install leveldb at /usr/local/leveldb and snappy at /usr/local/snappy.

LedisDB use the modified LevelDB for better performance, see here.
Set LEVELDB_DIR and SNAPPY_DIR to the actual install path in dev.sh.
make clean && make

RocksDB support

Install rocksdb(make shared_lib) and snappy first.

LedisDB has not supplied a simple script to install, maybe later.
Set ROCKSDB_DIR and SNAPPY_DIR to the actual install path in dev.sh.
make clean && make

Because RocksDB API may change sometimes, LedisDB may not build successfully. Now LedisDB supports RocksDB version 3.5 or newest master branch.

HyperLevelDB support

Install hyperleveldb and snappy first.

LedisDB has not supplied a simple script to install, maybe later.
Set HYPERLEVELDB and SNAPPY_DIR to the actual install path in dev.sh.
make clean && make

Choose store database

LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, hyperleveldb, memory. it will use goleveldb as default to store data if you don't set.

Choosing a store database to use is very simple, you have two ways:

Set in server config file
```
  db_name = "leveldb"
```
Set in command flag
```
  ledis-server -config=/etc/ledis.conf -db_name=leveldb
```
Flag command set will overwrite config set.

Lua support

Compile and install lua
Set LUA_DIR to the actual path in dev.sh
make clean && make

Configuration

LedisDB uses toml as the configuration format. The basic configuration ./etc/ledis.conf in LedisDB source may help you.

If you don't use a configuration, LedisDB will use the default for you.

Server Example

//set run environment if not
source dev.sh

ledis-server -config=/etc/ledis.conf

//another shell
ledis-cli -p 6380

ledis 127.0.0.1:6380> set a 1
OK
ledis 127.0.0.1:6380> get a
"1"

//use curl
curl http://127.0.0.1:11181/SET/hello/world
→ {"SET":[true,"OK"]}

curl http://127.0.0.1:11181/0/GET/hello?type=json
→ {"GET":"world"}

Package Example

import "github.com/siddontang/ledisdb/ledis"
l, _ := ledis.Open(cfg)
db, _ := l.Select(0)

db.Set(key, value)

db.Get(key)

Replication Example

Set slaveof in config or dynamiclly

ledis-cli -p 6381 

ledis 127.0.0.1:6381> slaveof 127.0.0.1 6380
OK

Benchmark

See benchmark for more.

Todo

See Issues todo

Caveat

You must known that changing store database runtime is very dangerous, LedisDB will not guarantee the data validation if you do it.
Begin a transaction will block any other write operators before you call commit or rollback. Don't use long-time transaction.
pcall and xpcall are not supported in lua, you can see the readme in golua.