Permalink
Browse files

update docs

  • Loading branch information...
1 parent 233d5fc commit 7ed097e15daafd48283d9702f6ad0dce8208447e @davies davies committed Feb 23, 2012
Showing with 33 additions and 22 deletions.
  1. +1 −2 CREDITS
  2. +9 −9 INSTALL
  3. +21 −11 README
  4. +2 −0 TODO
View
@@ -1,5 +1,4 @@
Special thanks go to people who have volunteered their time, effort,
and ideas to make this software available. (Words quoted from squid)
-* The code of beansdb is most based on memcachedb <http://memcachedb.org/>
-and Memcached <http://www.danga.com/memcached/>.
+* The code of beansdb is most based on Memcached <http://www.danga.com/memcached/>.
View
18 INSTALL
@@ -4,19 +4,19 @@ beansdb require epoll on Linux, or kqueue on *BSD/Mac OS.
Installation
============
-$svn co svn checkout http://beansdb.googlecode.com/svn/trunk/ beansdb-trunk
-$cd beansdb-trunk
-$./autogen.sh
+$ git clone https://github.com/douban/beansdb
+$ cd beansdb
+$ ./autogen.sh
or
-$wget http://
-$tar xvzf memcachedb-X.Y.Z.tar.gz
-$cd memcachedb-X.Y.Z
+$ # wget from github/douban/beansdb/
+$ tar xvzf beansdb-X.Y.Z.tar.gz
+$ cd beansdb-X.Y.Z
-$./configure
-$make
-$sudo make install
+$ ./configure
+$ make
+$ sudo make install
Getting Started
===============
View
32 README
@@ -1,30 +1,41 @@
-What is Beansdb?
-*******************
+
+# What is Beansdb?
+
Beansdb is a distributed key-value storage system designed for large scale
online system, aiming for high avaliablility and easy management. It took
the ideas from Amazon's Dynamo, then made some simplify to Keep It Simple
Stupid (KISS).
+
The clients write to N Beansdb node, then read from R of them (solving
conflict). Data in different nodes is synced through hash tree, in cronjob.
Beansdb base on memcached and Tokyo Cabinet, with efficient persistant
hash tree (called Hex Tree) support.
+
It conforms to memcache protocol (not completed, see below), so any memcached
client can interactive with it without any modification.
+
Beansdb is heavy used in http://www.douban.com/, stored images, mp3, text
fields and so on, see benchmark below.
+
Any suggestion or feedback is welcome.
-Features
-********
+
+# Features
+
* High availability data storage with multi readable and writable repications
+
* Soft state and final consistency, synced with hash tree
+
* Easy Scaling out without interrupting online service
+
* High performance read/write for a key-value based object
+
* Configurable availability/consistency by N,W,R
+
* Memcache protocol compatibility
-Supported memcache commands
-***************************
+
+# Supported memcache commands
get
set(with version support)
append
@@ -33,9 +44,8 @@ delete
stats
flush_all
-Private commands
-****************
-get @xxx, list the content of hash tree, such as @0
-get ?xxx, get the meta data of key.
-For more info, see: http://beansdb.googlecode.com/
+# Private commands
+
+get @xxx, list the content of hash tree, such as @0f
+get ?xxx, get the meta data of key.
View
2 TODO
@@ -0,0 +1,2 @@
+* merge data file
+* tools to split buckets

0 comments on commit 7ed097e

Please sign in to comment.