Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linxGnu/grocksdb

RocksDB wrapper for Go. Support 9.x, 8.x, 7.x, 6.x, etc
https://github.com/linxGnu/grocksdb

embedded go go-binding golang no-defer rocksdb static static-library wrapper

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/linxGnu/grocksdb
Owner: linxGnu
License: mit
Created: 2019-04-23T03:48:53.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-06-23T03:26:13.000Z (4 months ago)
Last Synced: 2024-06-23T05:54:56.226Z (4 months ago)
Topics: embedded, go, go-binding, golang, no-defer, rocksdb, static, static-library, wrapper
Language: Go
Homepage:
Size: 137 MB
Stars: 278
Watchers: 13
Forks: 60
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-golang-repositories - grocksdb
my-awesome - linxGnu/grocksdb - binding,golang,no-defer,rocksdb,static,static-library,wrapper pushed_at:2024-10 star:0.3k fork:0.1k RocksDB wrapper for Go. Support 9.x, 8.x, 7.x, 6.x, etc (Go)

README

        # grocksdb, RocksDB wrapper for Go

[![](https://github.com/linxGnu/grocksdb/workflows/CI/badge.svg)]()

[![Go Report Card](https://goreportcard.com/badge/github.com/linxGnu/grocksdb)](https://goreportcard.com/report/github.com/linxGnu/grocksdb)

[![Coverage Status](https://coveralls.io/repos/github/linxGnu/grocksdb/badge.svg?branch=master)](https://coveralls.io/github/linxGnu/grocksdb?branch=master)

[![godoc](https://img.shields.io/badge/docs-GoDoc-green.svg)](https://godoc.org/github.com/linxGnu/grocksdb)

This is a `Fork` from [tecbot/gorocksdb](https://github.com/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](https://github.com/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:

```bash

CGO_CFLAGS="-I/path/to/rocksdb/include" \

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

  go build

```

Or just:

```bash

go build // if prerequisites are in linker paths

```

If your rocksdb was linked with bz2:

```bash

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

  go build

```

## Usage

See also: [doc](https://godoc.org/github.com/linxGnu/grocksdb)

## 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