grocksdb icon indicating copy to clipboard operation
grocksdb copied to clipboard

RocksDB wrapper for Go. Support 8.x, 7.x, 6.x, etc

grocksdb, RocksDB wrapper for Go

Go Report Card Coverage Status godoc

This is a Fork from tecbot/gorocksdb. I respect the author work and community contribution. The LICENSE still remains as upstream.

Why I made a patched clone instead of PR:

  • Supports almost C API (unlike upstream). Catching up with latest version of Rocksdb as promise.
  • This fork contains no defer in codebase (my side project requires as less overhead as possible). This introduces loose convention of how/when to free c-mem, thus break the rule of tecbot/gorocksdb.

Install

Prerequisite

  • librocksdb
  • libsnappy
  • libz
  • liblz4
  • libzstd
  • libbz2 (optional)

Please follow this guide: https://github.com/facebook/rocksdb/blob/master/INSTALL.md to build above libs.

Build

After installing both rocksdb and grocksdb, you can build your app using the following commands:

CGO_CFLAGS="-I/path/to/rocksdb/include" \
CGO_LDFLAGS="-L/path/to/rocksdb -lrocksdb -lstdc++ -lm -lz -lsnappy -llz4 -lzstd" \
  go build

Or just:

go build // if prerequisites are in linker paths

If your rocksdb was linked with bz2:

CGO_LDFLAGS="-L/path/to/rocksdb -lrocksdb -lstdc++ -lm -lz -lsnappy -llz4 -lzstd -lbz2" \
  go build

Usage

See also: doc

API Support

Almost C API, excepts:

  • [ ] putv/mergev/deletev/delete_rangev
  • [ ] compaction_filter/compaction_filter_factory/compaction_filter_context
  • [ ] transactiondb_property_value/transactiondb_property_int
  • [ ] optimistictransactiondb_property_value/optimistictransactiondb_property_int