openeuler/rocksdb repository overview

⁠Quick reference

• The official RocksDB docker image.

• Maintained by: openEuler CloudNative SIG⁠.

• Where to get help: openEuler CloudNative SIG⁠, openEuler⁠.

⁠RocksDB | openEuler

Current RocksDB docker images are built on the openEuler⁠. This repository is free to use and exempted from per-user rate limits.

RocksDB is a high performance embedded key-value store for fast storage, developed by Meta. It is a persistent key-value store for fast storage environments based on a Log-Structured Merge Tree, and is widely used as the storage engine behind databases such as Kvrocks, TiDB and MyRocks.

Learn more on RocksDB⁠.

⁠Supported tags and respective Dockerfile links

The tag of each rocksdb docker image is consist of the version of rocksdb and the version of basic image. The details are as follows

⁠Usage

In this usage, users can select the corresponding {Tag} based on their requirements.

• Pull the openeuler/rocksdb image from docker

  docker pull openeuler/rocksdb:{Tag}
  

  Copy

• Compile a program against the installed RocksDB library

  Create a file named rocksdb_example.cpp with the following content:

  #include <cassert>
  #include <string>
  #include <rocksdb/db.h>
  
  int main() {
      rocksdb::DB* db;
      rocksdb::Options options;
      options.create_if_missing = true;
      rocksdb::Status status = rocksdb::DB::Open(options, "/tmp/testdb", &db);
      assert(status.ok());
  
      const std::string key = "hello";
      const std::string value = "openEuler";
      status = db->Put(rocksdb::WriteOptions(), key, value);
      assert(status.ok());
  
      std::string result;
      status = db->Get(rocksdb::ReadOptions(), key, &result);
      assert(status.ok() && result == value);
  
      delete db;
      return 0;
  }
  

  Copy

  Then compile and run it inside the container:

  docker run --rm -v $(pwd):/workspace openeuler/rocksdb:{Tag} \
      g++ -std=c++17 -O2 /workspace/rocksdb_example.cpp -o /workspace/rocksdb_example \
      -I/usr/local/include -L/usr/local/lib -lrocksdb -lsnappy -lzstd -lz -lpthread
  

  Copy

  docker run --rm -v $(pwd):/workspace openeuler/rocksdb:{Tag} /workspace/rocksdb_example
  

  Copy

• Run the bundled db_bench benchmark

  docker run --rm openeuler/rocksdb:{Tag} db_bench --benchmarks=fillseq,readrandom --num=100000
  

  Copy

• View container logs

  docker logs -f my-rocksdb
  

  Copy

• Open an interactive shell

  docker run -it --rm openeuler/rocksdb:{Tag} bash
  

  Copy

⁠Question and answering

If you have any questions or want to use some special features, please submit an issue or a pull request on openeuler-docker-images⁠.