A high performance NoSQL Database Server powered by Go
Go to file
siddontang ab667fb7e1 Merge pull request #58 from holys/develop
add cli auco-completion for new commands
2014-08-27 12:26:07 +08:00
build_tool can run build_leveldb.sh more than once 2014-08-18 22:29:32 +08:00
client add flush command 2014-08-27 10:57:18 +08:00
cmd add cli auco-completion for new commands 2014-08-27 11:25:55 +08:00
config refactor 2014-08-25 14:18:23 +08:00
doc add flush command 2014-08-27 10:57:18 +08:00
etc lmdv add nosync config, fix hyperleveldb build bug 2014-08-15 10:46:48 +08:00
ledis server add scan support 2014-08-26 23:21:54 +08:00
server add flush command 2014-08-27 10:57:18 +08:00
store refactor 2014-08-25 14:18:23 +08:00
tools refactor 2014-08-25 14:18:23 +08:00
.gitignore refactor 2014-08-25 14:18:23 +08:00
LICENSE Initial commit 2014-04-29 17:43:09 -07:00
Makefile update build 2014-07-28 12:46:17 +08:00
README.md refactor 2014-08-25 14:18:23 +08:00
bootstrap.sh change import path of bson lib 2014-08-11 10:08:41 +08:00
dev.sh add HyperLevelDB support 2014-08-12 00:54:53 +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, and may be alternative for Redis.

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.
  • Supports transaction using LMDB or BotlDB.
  • Supports expiration and ttl.
  • Redis clients, like redis-cli, are supported directly.
  • Multiple client API supports, 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

LevelDB support

  • Install leveldb and snappy.

    LedisDB supplies a simple script to install leveldb and snappy:

      sudo sh build_tool/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

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

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

Choose store database

LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, hyperleveldb. it will choose goleveldb as default to store data if you not 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.

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.

Configuration

LedisDB uses toml as the preferred configuration format, also supports json because of some history reasons. 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

Thanks

Gmail: cenqichao@gmail.com

Gmail: chendahui007@gmail.com

Gmail: cppgohan@gmail.com

Gmail: tiaotiaoyly@gmail.com

Gmail: wyk4true@gmail.com

Feedback

Gmail: siddontang@gmail.com