Skip to content

Commit

Permalink
doc: minor fix build steps.
Browse files Browse the repository at this point in the history
  • Loading branch information
patpatbear committed Nov 1, 2023
1 parent 4a9cbc4 commit 534d2c4
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
# Introduction
## Introduction

ROR is a more cost-effective alternative to redis, uses RocksDB as the storage engine and can save about 2/3 of the cost.

ROR extends SWAP feature based on redis codebase, it is compatible with almost all redis commands (including lua and multi/exec) and redis replication (RDB +RESP).

## Build

### prerequisites

1. ubuntu

```
apt install librocksdb-dev libsnappy-dev zlib1g-dev libgflags-dev libstdc++6
cd /path/to/redis && make
```

2. centos

```
yum install snappy zlib gflags libstdc++
cd /path/to/redis && make
```

# Details
### build

```
git clone https://github.com/ctripcorp/Redis-On-Rocks.git
git submodule upadate --init
cd redis
make
```

## Details

## SWAP
### SWAP

ROR stores hot and cold data in redis and RocksDB respectively, and exchanges hot and cold data automatically:

Expand All @@ -31,7 +40,7 @@ ROR stores hot and cold data in redis and RocksDB respectively, and exchanges ho

![SWAP](docs/images/ROR.png)

## Replication
### Replication

ROR replication process is almost the same with redis, the only difference lies in RDB generation for cold data: RocksDB CHECKPOINT is obtained first, and then the cold data is scanned and converted into RDB format.

Expand Down

0 comments on commit 534d2c4

Please sign in to comment.