From 956a8b4421d0d7269bebdc880a5e6be0689d9b19 Mon Sep 17 00:00:00 2001 From: siddontang Date: Mon, 29 Sep 2014 14:11:14 +0800 Subject: [PATCH] update doc --- README.md | 4 ++-- doc/Replication.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6779b94..05ba17d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ LedisDB now supports multiple databases as backend to store data, you can test a + Supports lua scripting. + Supports expiration and ttl. + Supports using redis-cli directly. -+ Multiple client API supports, including Go, Python, Lua(Openresty), C/C++, Node.js. ++ 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. @@ -75,7 +75,7 @@ Create a workspace and checkout ledisdb source ## 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. +LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, hyperleveldb, memory. it will choose goleveldb as default to store data if you don't set. Choosing a store database to use is very simple, you have two ways: diff --git a/doc/Replication.md b/doc/Replication.md index 4e7986a..6e6613b 100644 --- a/doc/Replication.md +++ b/doc/Replication.md @@ -10,7 +10,7 @@ Another implementation influencing me is [Raft](http://raftconsensus.github.io/) Refer above, I supply a simple solution for LedisDB's replication. -## Key word +## Keyword + LogID: a monotonically increasing integer for a log + FirstLogID: the oldest log id for a server, all the logs before this id have been purged. @@ -62,14 +62,14 @@ You must notice that this feature has a big influence on the performance. Use yo Using replication is very simple for LedisDB, only using `slaveof` command. -+ Uses `slaveof host port` to enable replication from master at "host:port". -+ Uses `slaveof no one` to stop replication and changes to master. ++ Use `slaveof host port` to enable replication from master at "host:port". ++ Use `slaveof no one` to stop replication and change the slave to master. -If a slave first syncs from a master A, then uses slaveof to sync from master B, it will sync with the LogID = LastLogID + 1. If you want to start over from B, you must first use `slaveof host port restart`. +If a slave first syncs from a master A, then uses `slaveof` to sync from master B, it will sync with the LogID = LastLogID + 1. If you want to start over from B, you must use `slaveof host port restart` which will start a full sync first. ## Limitation + Replication can not store log less than current LastLogID. -+ Cycle replication not support. ++ Cycle replication is not supported. + Master and slave must set `use_replication` to true to support replication.