Skip to content

Latest commit

 

History

History
100 lines (74 loc) · 5.46 KB

README.md

File metadata and controls

100 lines (74 loc) · 5.46 KB

pmemkv

GHA build status Coverity Scan Build Status Coverage Status PMEMKV version Packaging status

pmemkv is a local/embedded key-value datastore optimized for persistent memory. Rather than being tied to a single language or backing implementation, pmemkv provides different options for language bindings and storage engines.

For more information, including C API and C++ API see: https://pmem.io/pmemkv. Documentation is available for every branch/release. For most recent always see (master branch):

Latest releases can be found on the "releases" tab.

Up-to-date, current support/maintenance status of branches/releases is available on pmem.io.

There is also a small helper library pmemkv_json_config provided. See its manual for details.

Table of contents

  1. Installation
  2. Language Bindings
  3. Storage Engines
  4. Benchmarks
  5. Contact us

Installation

Installation guide provides detailed instructions how to build and install pmemkv from sources, build rpm and deb packages and explains usage of experimental engines and pool sets.

Language Bindings

pmemkv is written in C/C++ and can be used in other languages - Java, Node.js, Python, and Ruby.

pmemkv-bindings

C/C++ Examples

Examples for C and C++ can be found within this repository in examples directory.

Other Languages

The above-mentioned bindings are maintained in separate GitHub repositories, but are still kept in sync with the main pmemkv distribution.

Storage Engines

pmemkv provides multiple storage engines that share common API, so every engine can be used with all language bindings and utilities. Engines are loaded by name at runtime.

Engine Name Description Experimental Concurrent Sorted
blackhole Accepts everything, returns nothing No Yes No
cmap Concurrent hash map No Yes No
vsmap Volatile sorted hash map No No Yes
vcmap Volatile concurrent hash map No Yes No
csmap Concurrent sorted map Yes Yes Yes
radix Radix tree Yes No Yes
tree3 Persistent B+ tree Yes No No
stree Sorted persistent B+ tree Yes No Yes
robinhood Persistent hash map with Robin Hood hashing Yes Yes No
dram_vcmap Volatile concurrent hash map placed entirely on DRAM Yes Yes No

The production quality engines are described in the libpmemkv(7) manual and the experimental ones are described in the ENGINES-experimental.md file.

Contributing a new engine is easy, so feel encouraged!

Benchmarks

Experimental benchmark based on leveldb's db_bench to measure pmemkv's performance is available here: https://github.com/pmem/pmemkv-bench (previously pmemkv-tools).

Contact us

For more information about pmemkv, contact Igor Chorążewicz ([email protected]), Piotr Balcer ([email protected]) or post on our #pmem Slack channel using this invite link or Google group.