Skip to main content

A persistent key-value storage engine based on LSM-tree architecture.

Project description

BloomKV

Light weight key value storage engine optimized for write heavy workloads.

Overview

This project is an LSM-tree based key-value storage engine implemented in Python, optimized for write-heavy workloads.

It is a persistent key-value store featuring:

  • A Write Ahead Log (WAL) for atomicity and durability.
  • An in-memory Memtable using SortedDict.
  • Persistent Sorted String Tables (SSTables).
  • Asynchronous, leveled compaction handled by a background worker thread (introduced in v1.0.0).
  • Metadata generation for created collections
  • Bloom filter functionality to prevent unnecessary disk operations for keys that we know dont exist in the collection
  • Storage engine is behind a FastAPI server and can be communicated with using REST APIs.
  • Supports range queries from start_key to end_key
  • Can be used as an importable library for programmatic integration
  • Import csv files and store them as kv pairs in a collection

Getting Started

  • Detailed documentation, usage and explanation of each component is available in the docs folder.

Contributing

Contributions, issues and feature requests are welcome! Contributing ideas

  • Implement a proper testing suite for different components. Unit tests, Integration Tests
  • Thread safety for multi threaded programs
  • UI features along with CLI and library utilisation. and many more, ideas are always welcome!

LICENSE

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bloomkv-1.3.1.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bloomkv-1.3.1-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file bloomkv-1.3.1.tar.gz.

File metadata

  • Download URL: bloomkv-1.3.1.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for bloomkv-1.3.1.tar.gz
Algorithm Hash digest
SHA256 17ffdd2333061b6d7eeb3b1959fc4964ccdba838382e47422dc9802efb9fd7e4
MD5 89eafb76dc8cbef6a146b8031247de72
BLAKE2b-256 d4eea71b3d26a442f9bee22e2eba2363c68299e20ca02a5f995eca6c59665bf8

See more details on using hashes here.

File details

Details for the file bloomkv-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: bloomkv-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for bloomkv-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74418258d58914df43b0fc244d3696d4624937a3e29130c66afa11260a41b614
MD5 270af1a2c1c3f01bf7b84386986a37b2
BLAKE2b-256 042a9979972d58cb5b5ea13e62a0617b41c50fda0a5ec31fdcbd3fa236e61453

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page