A high performance NoSQL Database Server powered by Go
Go to file
siddontang f2cc5f5fd9 use newest goleveldb
you must update goleveldb by yourself
2014-12-12 20:56:17 +08:00
Godeps use newest goleveldb 2014-12-12 20:56:17 +08:00
client add xmigrate 2014-12-03 16:27:52 +08:00
cmd Merge branch 'copy-bugfix' into develop 2014-11-27 20:51:21 +08:00
config add usemmap config 2014-11-20 22:28:08 +08:00
doc update doc 2014-11-28 15:48:16 +08:00
etc add usemmap config 2014-11-20 22:28:08 +08:00
ledis must clear key before restore 2014-11-30 22:39:00 +08:00
lua use golua directly 2014-09-13 14:11:05 +08:00
rpl Merge branch 'copy-bugfix' into develop 2014-11-27 20:51:21 +08:00
server add xmigrate 2014-12-03 16:27:52 +08:00
store use newest goleveldb 2014-12-12 20:56:17 +08:00
tools remove rocksdb_ext 2014-11-05 10:47:49 +08:00
upgrade/ledis-upgrade-ttl add flag upgrade-ttl 2014-10-29 16:07:58 +08:00
.gitignore update gitignore 2014-11-05 10:44:57 +08:00
.travis.yml travis add test race 2014-11-21 10:32:18 +08:00
LICENSE Initial commit 2014-04-29 17:43:09 -07:00
Makefile remove unnecessary code 2014-11-02 14:21:24 +08:00
README.md update read me 2014-12-04 20:59:16 +08:00
bootstrap.sh update godep bootstrap 2014-11-21 09:13:48 +08:00
dev.sh remove hyperleveldb 2014-10-16 11:10:19 +08:00

README.md

LedisDB

Build Status

Ledisdb is a high-performance NoSQL database, similar to Redis, written in Go. It supports many data structures including kv, list, hash, zset, bitmap,set.

LedisDB now supports multiple different databases as backends.

You must run ledis-upgrade-ttl before using LedisDB version 0.4, I fixed a very serious bug for key expiration and TTL.

Features

  • Rich data structure: KV, List, Hash, ZSet, Bitmap, Set.
  • Data storage is not limited by RAM.
  • Various backends supported: LevelDB, goleveldb, LMDB, RocksDB, BoltDB, RAM.
  • Supports transactions using LMDB or BotlDB.
  • Supports Lua scripting.
  • Supports expiration and TTL.
  • Can be managed via redis-cli.
  • Easy to embed in your own Go application.
  • HTTP API support, JSON/BSON/msgpack output.
  • Replication to guarantee data safety.
  • Supplies tools to load, dump, and repair database.
  • Supports cluster, use xcodis

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

#install Go dependences
./bootstrap.sh

#set build and run environment 
source dev.sh

make
make test

Godep support

LedisDB can be built with godep which can manage LedisDB Go dependency 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 install leveldb at /usr/local/leveldb and snappy at /usr/local/snappy by default.

    LedisDB uses the modified LevelDB for better performance. Details.

    You can easily use other LevelDB versions (like Hyper LevelDB or Basho LevelDB) instead, as long as the header files are in include/leveldb, not include/hyperleveldb or any other location.

  • 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 yet supplied a simple script to install.

  • Set ROCKSDB_DIR and SNAPPY_DIR to the actual install path in dev.sh.

  • make clean && make

If the RocksDB API changes, LedisDB may not build successfully. LedisDB currently supports RocksDB version 3.5 or later.

Choose store database

LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, and RAM. It will use goleveldb by default.

Choosing a store database to use is very simple.

  • 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 setting.

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

Cluster support

LedisDB uses a proxy named xcodis to support cluster.

Benchmark

See benchmark for more.

Todo

See Issues todo

Client

See Clients to find or contribute LedisDB client.

Caveat

  • Changing the backend database at runtime is very dangerous. Data validation is not guaranteed if this is done.
  • Beginning a transaction will block any other write operators until commit or rollback is called. Avoid long-running transactions.
  • pcall and xpcall are not supported in Lua. See the README in golua.

Requirement

  • Go version >= 1.3

Feedback