rocksq 0.2.4

Rust persistent queue based on RocksDB with Python bindings

RocksQ

An inproc RocksDB-based queue with Python bindings. It is implemented in Rust.

Features:

• max capacity limit in number of elements;
• size calculation based on filesystem space usage;
• length calculation based on number of elements;
• supports only bytes-like objects;
• can operate in a multithreaded environment efficiently (push and pop methods can release GIL if necessary);
• keeps the state between restarts;
• two implementations: blocking and nonblocking;

What is not supported:

• pub/sub is not supported intentionally (implement it on top of RocksQ if necessary);
• TTL is not supported intentionally (implement it on top of RocksQ if necessary).

Implementation details

It works on RocksDB and uses a single column family. The keys are 64-bit integers, the values are byte arrays. The keys are generated by incrementing a counter. The read and write counters are stored in a separate key-value pairs.

It is implemented in Rust and PyO3, thus allows to release GIL when necessary. The library does not require external dependencies installed in the environment.

Supported Platforms and Python Versions

Windows: Python versions: 3.7-3.12.

Linux: ManyLinux Python versions: 3.7-3.12. CI does not build for PyPy, but it should work if you build it manually.

MacOS: Currently, I do not have MacOS environment to debug the build process in MacOS, all volounteers are welcome.

Installation

pip install rocksq

Usage

See the examples in the python directory.

API docs are located at: https://insight-platform.github.io/RocksQ/.

Performance

The performance is mostly limited by the throughput of the underlying filesystem. The queue is able to saturate the throughput of the filesystem.