PyVidarDB is a simple, fast, and persistent key-value store that can store terabytes of data. It is the Python binding for VidarDB, which is a lineage of LevelDB and RocksDB.
PyVidarDB guarantees to support Python >= 3.5
.
There is no need to have VidarDB installed in advance, PyVidarDB will install it automatically for you.
For Linux users (Ubuntu as an example):
sudo apt-get update
sudo apt-get install git python3-pip build-essential cmake
For MacOS users (Please install Homebrew at first):
sudo brew install git python3 cmake
For Windows users:
The compiler should support C++11 (at least Visual Studio 2015 update 3).
From PyPI:
pip3 install PyVidarDB
From Github:
git clone --recursive https://github.com/vidardb/PyVidarDB.git
pip3 install ./PyVidarDB
Here is the basic usage for PyVidarDB:
import pyvidardb
db = pyvidardb.DB()
# Open the database, will create one if not exist.
db.open("./hello_world")
# Put a pair of 'key1' and 'value1' into the database.
db.put(b"key1", b"value1")
# Get the value(s) of the provided key, will return None
# if there is no such key in the database.
value = db.get(b"key1")
assert value == [b"value1"]
# 'key2' does not exist in the database. So we will get None here.
value = db.get(b"key2")
assert value is None
# Remove 'key1' from the database.
db.delete(b"key1")
# Put a pair of 'key2' and multiple values into the database.
db.put(b"key2", [b"value1", b"value2", b"value3"])
# Get the value(s) of the provided key.
value = db.get(b"key2")
assert value == [b"value1", b"value2", b"value3"]
# Remove 'key2' from the database.
db.delete(b"key2")
# Close the database.
db.close()
More examples can be found at here: https://github.com/vidardb/PyVidarDB/tree/master/examples
See our wiki page for more information.