https://github.com/nervosnetwork/ckb-rocksdb

A high-performance RocksDB wrapper tailored for Nervos CKB (Common Knowledge Base), with CKB-specific optimizations
https://github.com/nervosnetwork/ckb-rocksdb

ckb rocksdb rust wrapper-library

Last synced: 10 days ago
JSON representation

A high-performance RocksDB wrapper tailored for Nervos CKB (Common Knowledge Base), with CKB-specific optimizations

• Host: GitHub
• URL: https://github.com/nervosnetwork/ckb-rocksdb
• Owner: nervosnetwork
• License: apache-2.0
• Created: 2025-11-27T07:46:24.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2025-12-21T06:09:45.000Z (6 months ago)
• Last Synced: 2026-04-23T20:34:06.984Z (about 2 months ago)
• Topics: ckb, rocksdb, rust, wrapper-library
• Language: Rust
• Homepage:
• Size: 2.03 MB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

          
ckb-rocksdb

============

[![Build Status](https://github.com/nervosnetwork/ckb-rocksdb/actions/workflows/rust.yml/badge.svg)](https://github.com/nervosnetwork/ckb-rocksdb/actions/workflows/rust.yml?query=branch%3Amaster)

[![crates.io](https://img.shields.io/crates/v/ckb-rocksdb.svg)](https://crates.io/crates/ckb-rocksdb)

[![documentation](https://docs.rs/ckb-rocksdb/badge.svg)](https://docs.rs/ckb-rocksdb)

[![license](https://img.shields.io/crates/l/ckb-rocksdb.svg)](https://github.com/nervosnetwork/ckb-rocksdb/blob/master/LICENSE)

[![Discord](https://img.shields.io/badge/chat-on%20Discord-7289DA.svg)](https://discord.com/invite/nervos)

A high-performance RocksDB wrapper tailored for Nervos CKB (Common Knowledge Base), with CKB-specific optimizations

## Requirements

- Clang and LLVM

## Contributing

Feedback and pull requests welcome!  If a particular feature of RocksDB is

important to you, please let me know by opening an issue, and I'll

prioritize it.

## Usage

This binding is statically linked with a specific version of RocksDB. If you

want to build it yourself, make sure you've also cloned the RocksDB and

compression submodules:

    git submodule update --init --recursive

## Compression Support

By default, support for the [Snappy](https://github.com/google/snappy),

[LZ4](https://github.com/lz4/lz4), [Zstd](https://github.com/facebook/zstd),

[Zlib](https://zlib.net), and [Bzip2](http://www.bzip.org) compression

is enabled through crate features.  If support for all of these compression

algorithms is not needed, default features can be disabled and specific

compression algorithms can be enabled. For example, to enable only LZ4

compression support, make these changes to your Cargo.toml:

```

[dependencies.rocksdb]

default-features = false

features = ["lz4"]

```