Categorygithub.com/tecbot/gorocksdb
modulepackage
0.0.0-20191217155057-f0fad39f321c
Repository: https://github.com/tecbot/gorocksdb.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
2
Dependents
1.2k
Files
46 SLOC

# README

gorocksdb, a Go wrapper for RocksDB

Build Status GoDoc

Install

You'll need to build RocksDB v5.16+ on your machine.

After that, you can install gorocksdb using the following command:

CGO_CFLAGS="-I/path/to/rocksdb/include" \
CGO_LDFLAGS="-L/path/to/rocksdb -lrocksdb -lstdc++ -lm -lz -lbz2 -lsnappy -llz4 -lzstd" \
  go get github.com/tecbot/gorocksdb

Please note that this package might upgrade the required RocksDB version at any moment. Vendoring is thus highly recommended if you require high stability.

The embedded CockroachDB RocksDB is no longer supported in gorocksdb.

# Functions

NewCompressionOptions creates a CompressionOptions object.
NewCOWList creates a new COWList.
NewDefaultCompressionOptions creates a default CompressionOptions object.

# Structs

CompressionOptions represents options for different compression algorithms like Zlib.
COWList implements a copy-on-write list.