# pmemstream

**Repository Path**: mirrors_pmem/pmemstream

## Basic Information

- **Project Name**: pmemstream
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-26
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pmemstream
[![Basic Tests](https://github.com/pmem/pmemstream/actions/workflows/basic.yml/badge.svg)](https://github.com/pmem/pmemstream/actions/workflows/basic.yml)
[![pmemstream version](https://img.shields.io/github/tag/pmem/pmemstream.svg)](https://github.com/pmem/pmemstream/releases/latest)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/24120/badge.svg)](https://scan.coverity.com/projects/pmem-pmemstream)
[![Coverage Status](https://codecov.io/github/pmem/pmemstream/coverage.svg?branch=master)](https://app.codecov.io/gh/pmem/pmemstream/branch/master)
[![CodeQL](https://github.com/pmem/pmemstream/actions/workflows/codeql.yml/badge.svg)](https://github.com/pmem/pmemstream/actions/workflows/codeql.yml)
## ⚠️ Discontinuation of the project
The **pmemstream** project will no longer be maintained by Intel.
- Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases,
or updates, to this project.
- Intel no longer accepts patches to this project.
- If you have an ongoing need to use this project, are interested in independently developing it, or would like to
maintain patches for the open source software community, please create your own fork of this project.
- You will find more information [here](https://pmem.io/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/).

## Introduction

**pmemstream** is a logging data structure optimized for persistent memory.

*This is experimental pre-release software and should not be used in production systems.
APIs and file formats may change at any time without preserving backwards compatibility.
All known issues and limitations are logged as GitHub issues.*

**Libpmemstream** implements a pmem-optimized log data structure and provides stream-like access to the data.
It presents a contiguous logical address space, divided into regions, with log entries of arbitrary sizes.
We intend for this library to be a foundation for various, more complex higher-level solutions.

This library is a successor to [libpmemlog](https://pmem.io/pmdk/libpmemlog/). These two libraries are very similar
in basic concept, but *libpmemlog* was developed in a straightforward manner and does not allow easy extensions.

For more information, including **C API** documentation see [pmem.io/pmemstream](https://pmem.io/pmemstream).

![example pmemstream](doc/pmemstream.png)

## Build and install
[Installation guide](INSTALL.md) provides detailed instructions how to build and install
**pmemstream** from sources, build rpm and deb packages, and more.

## Contact us
For more information about **pmemstream**, please:
- read our whitepaper [attached to 0.2.1 release](https://github.com/pmem/pmemstream/releases/download/0.2.1/Libpmemstream_whitepaper.docx),
- if the [blog post](https://pmem.io/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/) didn't answer your question, please contact us using the dedicated e-mail: pmdk_support@intel.com.