README.md

pypebble

A work-in-progress Python wrapper for CockroachDB's Pebble storage engine, using a cgo and C++/pybind11-based interface.

Building

Requires: cmake (>=3.5), Python (>=3.7), Pybind11, Go >=1.22, a C++ compiler.

$ mkdir build && cd build
$ cmake ..
$ make pypebble

Or, for just C++ bindings and sample program:

$ make pebble_bindings
..
$ make pebtest.out

Build Flags

Can be enabled or disabled with -D<FLAG_NAME>=[ON|OFF]. Defaults:

COCKROACH:BOOL=OFF          // Enable CockroachDB-specific functionality
CGO_DYLD_ENABLED:BOOL=OFF   // Enable CGo Dynamic Linking

Python Usage

Make sure pypebble.so shared module is on the PATH.

You may need to set DYLD_LIBRARY_PATH=/path/to/libpebble.so as well.

>>> import pypebble
>>> db = pypebble.open("tmp", read_write=True)
>>> db.set(b"name", b"pebble!", sync=True)
>>> db.get(b"name")
b'pebble!'
>>> db.get(b"other")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
RuntimeError: pebble: not found
>>> db.num_files()
1
>>> db.close()