Packages

rocksdb

2.6.0
3.1.2 3.1.1 3.1.0 3.0.0 2.6.2 2.6.1 retired 2.6.0 retired 2.5.0 2.4.1 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.0 0.26.2 0.26.1 0.26.0 0.25.0 0.24.0 0.23.3 0.23.2 0.23.1 0.23.0 0.22.0 0.21.0 0.20.1 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.9.0 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0

RocksDB for Erlang

Retired package: Release invalid - Use 2.6.1 instead
HexDocs

Current section

Files

Jump to
Readme
64 Versions
0 Dependencies
Dependants
Files
Activity
rocksdb README.md
Raw

README.md 

# erlang-rocksdb - Erlang wrapper for RocksDB



[![Build Status](https://github.com/EnkiMultimedia/erlang-rocksdb/workflows/build/badge.svg)](https://github.com/EnkiMultimedia/erlang-rocksdb/actions?query=workflow%3Abuild)

[![Hex pm](http://img.shields.io/hexpm/v/rocksdb.svg?style=flat)](https://hex.pm/packages/rocksdb)



**Current version: 2.6.0**



Copyright (c) 2016-2026 Benoît Chesneau



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.



## Features



- RocksDB 10.10.1 with snappy 1.2.1, lz4 1.10.0, zstd 1.5.7

- Erlang 22+ with dirty-nifs enabled

- All basic db operations (get, put, delete, merge, multi_get)

- Wide-column entity API (put_entity, get_entity, iterator_columns)

- Extended statistics API (45+ tickers, 13+ histograms)

- BlobDB support with statistics and lazy loading

- Batch operations support

- Snapshots support

- Checkpoint support

- Column families support with coalescing iterator

- Transaction logs

- Pessimistic transactions with row-level locking

- Backup support

- Erlang merge operator

- Posting list merge operator for inverted indexes

- Compaction filters (declarative rules and Erlang callbacks)

- SST file support (write, ingest, read)

- Customized build support

- Tested on macOS, FreeBSD, Solaris and Linux



## Usage



See the [Doc](https://hexdocs.pm/rocksdb/) for more explanation.



> Note: since the version **0.26.0**, `cmake>=3.4` is required to install `erlang-rocksdb`.



## Customized build ##



See the [Customized builds](https://hexdocs.pm/rocksdb/CUSTOMIZED_BUILDS.html) for more information.



## Support



Support, Design and discussions are done via the [Github Tracker](https://github.com/EnkiMultimedia/erlang-rocksdb/issues).



Professional support is available via [Enki Multimedia](https://enki-multimedia.eu). Contact sales@enki-multimedia.eu.



## License



Erlang RocksDB is licensed under the Apache License 2.