Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 1 month 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-10-21T04:43:58.000Z (about 2 months ago)
- Last Synced: 2024-10-23T00:51:08.474Z (about 2 months ago)
- Topics: embedded, go, go-binding, golang, no-defer, rocksdb, static, static-library, wrapper
- Language: Go
- Homepage:
- Size: 137 MB
- Stars: 303
- Watchers: 13
- Forks: 65
- Open Issues: 2
-
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-11 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://goreportcard.com/report/github.com/linxGnu/grocksdb)
[](https://coveralls.io/github/linxGnu/grocksdb?branch=master)
[](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
```
#### Customize the build flags
Currently, the default build flags without specifying `CGO_LDFLAGS` or the corresponding environment variables are `-lrocksdb -pthread -lstdc++ -ldl -lm -lzstd -llz4 -lz -lsnappy`
If you want to customize the build flags:
1. Use `-tags grocksdb_clean_link` to create a cleaner set of flags and build it based on the cleaner flag. The base build flags after using the tag are `-lrocksdb -pthread -lstdc++ -ldl`.
```bash
CGO_LDFLAGS="-L/path/to/rocksdb -lzstd" go build -tags grocksdb_clean_link
```
2. Use `-tags grocksdb_no_link` to ignore the build flags provided by the library and build it fully based on the custom flags.
```bash
CGO_LDFLAGS="-L/path/to/rocksdb -lrocksdb -lstdc++ -lzstd -llz4" go build -tags grocksdb_clean_link
```
## Usage
See also: [doc](https://godoc.org/github.com/linxGnu/grocksdb)
## API Support
Almost C API, excepts:
- [ ] get_db_identity
- [ ] 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
- [ ] writebatch_update_timestamps/writebatch_wi_update_timestamps/writebatch_iterate_cf
- [ ] approximate_sizes_cf_with_flags
- [ ] logger_create_callback_logger