RDB is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install rdb

It will make the rdb command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall rdb uninstalls.

Adding `rdb` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add rdb

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

rdb = "0.3.0"

The rdb library will be automatically available globally. Read the rdb library documentation.

Back to the crate overview.

Readme

rdb-rs - RDB parsing, formatting, analyzing. All in one library

This is a fork and refactor of the archived https://github.com/badboy/rdb-rs. My goal is to modernize the library, implement support for newer RDB versions and encoding types and also offer python bindings.

See changelog.

Inspired and based on redis-rdb-tools.

Documentation

TBD

Build

cargo build --release

Basic operation

rdb-rs exposes just one important method: parse. This methods takes care of reading the RDB from a stream, parsing the containted data and calling the provided formatter with already-parsed values.

use std::io::BufReader;
use std::fs::File;
use std::path::Path;

let file = File::open(&Path::new("dump.rdb")).unwrap();
let reader = BufReader::new(file);
rdb::parse(reader, rdb::formatter::JSON::new(), rdb::filter::Simple::new());

Formatter

rdb-rs brings 4 pre-defined formatters, which can be used:

Plain: Just plain output for testing
JSON: JSON-encoded output
Nil: Surpresses all output
Protocol: Formats the data in RESP, the Redis Serialization Protocol

These formatters adhere to the Formatter trait and supply a method for each possible datatype or opcode. Its up to the formatter to correctly handle all provided data such as lists, sets, hashes, expires and metadata.

Command-line

rdb-rs brings a Command Line application as well.

This application will take a RDB file as input and format it in the specified format (JSON by default).

Example:

$ rdb --format json dump.rdb
[{"key":"value"}]
$ rdb --format protocol dump.rdb
*2
$6
SELECT
$1
0
*3
$3
SET
$3
key
$5
value

Tests

Run tests with:

make test

This will run the code tests with cargo as well as checking that it can parse all included dump files.

Contribute

If you find bugs or want to help otherwise, please open an issue.

License

MIT. See LICENSE.

Installing the command-line executable

Adding rdb library as a dependency

Adding `rdb` library as a dependency