The C API of pmemkv is documented in the manuals and the C++ API is documented in the form of Doxygen documentation:
for the current master:
- C++ Doxygen doc
- C manpages:
- libpmemkv.3
- libpmemkv.7
- libpmemkv_tx.3 (EXPERIMENTAL API)
- libpmemkv_iterator.3 (EXPERIMENTAL API)
- libpmemkv_config.3
- libpmemkv_json_config.3
for the latest stable branch (1.5):
- C++ Doxygen doc
- C manpages:
- libpmemkv.3
- libpmemkv.7
- libpmemkv_tx.3 (EXPERIMENTAL API)
- libpmemkv_iterator.3 (EXPERIMENTAL API)
- libpmemkv_config.3
- libpmemkv_json_config.3
Language Bindings
Up-to-date overview information about language bindings for pmemkv can be found in pmemkv’s README on GitHub.
Each of bindings has its own detailed API documentation on pmem.io:
Performance Reports
Available performance measurements can be found in 'reports' sub-section.
Blog Entries
The following blog articles relates to pmemkv:
- Introduction
- Zero-copy leaf splits in pmemkv
- Benchmarking with different storage engines using pmemkv
- Language bindings for pmemkv
- API overview of pmemkv-java binding
Releases’ Support Status
Only some of the latest branches/releases are fully supported. The most recent releases can be found on the "releases" tab on the Github page.
| Version branch | First release date | Last patch release | Maintenance status |
|---|---|---|---|
| stable-1.5 | Jul 27, 2021 | N/A | Full |
| stable-1.4 | Feb 15, 2021 | N/A | Full |
| stable-1.3 | Oct 02, 2020 | N/A | Full |
| stable-1.2 | May 29, 2020 | 1.2.1 (Jul 06, 2021) | EOL |
| stable-1.1 | Jan 31, 2020 | 1.1.1 (Jun 28, 2021) | EOL |
| stable-1.0 | Oct 4, 2019 | 1.0.3 (Oct 06, 2020) | EOL |
Possible statuses:
- Full maintenance:
- All/most of bugs fixed (if possible),
- Patch releases issued based on a number of fixes and their severity,
- At least one release at the end of the maintenance period,
- Full support for at least a year since the initial release.
- Limited scope:
- Only critical bugs (security, data integrity, etc.) will be backported,
- Patch versions will be released when needed (based on severity of found issues),
- Branch will remain in “limited maintenance” status based on original release availability in popular distros,
- EOL:
- No support,
- No bug fixes,
- No official releases.
Older Documentation
For branch stable-1.4:
- C++ Doxygen docs
- C manpages:
- libpmemkv.3
- libpmemkv.7
- libpmemkv_tx.3 (EXPERIMENTAL API)
- libpmemkv_iterator.3 (EXPERIMENTAL API)
- libpmemkv_config.3
- libpmemkv_json_config.3
For branch stable-1.3:
Archived Documentation
For branch stable-1.2.1:
For branch stable-1.1.1:
For branch stable-1.0.3:
The contents of this web site and the associated GitHub repositories are BSD-licensed open source.