# BorgStore

borgstore implements a general purpose key/value store in Python.

## Overview

Keys are simple strings like config/main or data/0123456789abcdef [str] (config and data are namespaces here). Values are binary objects [bytes] - when storing, a memoryview is accepted as well, so callers can avoid copying.

The Store class is the high-level API, so you can comfortably work with the kv store without caring for low-level details.

The backends package has misc. storage backend implementations.

The server package has a REST server implementation, complementing the REST client functionality in the rest backend. To actually store stuff, the REST server can use any backend internally, e.g. the posixfs backend.

## Store features

- supports URLs, like file:///srv/borgstore or https://myserver/path

- easy to use, high-level Store API: create/destroy, open/close, list, load/store, delete, move, soft delete/undelete, hash, defrag, …

- uses a backend to implement the storage

- optionally uses an additional caching backend, with a configurable cache policy per namespace

- name nesting / unnesting, recursive directory listing

- statistics collection

- latency/bandwidth emulator

## Backend features

- existing backends for local filesystem, sftp, REST, S3 / B2 (native) and many other cloud storage protocols via rclone

- new backends are simple to implement

- key validation

- partial loads / range requests

- stored object hashing (hashlib algorithms, e.g. sha256, and optionally blake3)

- stored object defragmentation

- quota support (only posixfs)

- permissions checking (only posixfs)

## REST server features

- server-side permissions/quota enforcement

- server-side hashsum check of transferred objects before storing

- network traffic optimization by doing stuff server-side:

  - stored object hashing

  - stored object defragmentation

- the REST server can internally use any backend for storage, e.g. posixfs

- for the REST server, we provide CI tested configs for:

  - an nginx-based reverse proxy

  - systemd-based on-demand borgstore.server process creation

## State of this project

API is still unstable and expected to change as development goes on.

As long as the API is unstable, there will be no data migration tools, such as tools for upgrading an existing store’s data to a new release.

There are tests, and they pass for the basic functionality, so some functionality is already working well.

There might be missing features or optimization potential. Feedback is welcome!

Many possible backends are still missing. If you want to create and support one, pull requests are welcome.

## Borg?

Please note that this code is currently not used by the stable release of BorgBackup (also known as “borg”), but only by Borg 2 beta 10+ and the master branch.

- Installation
  - Minimal installation
  - Installation with optional dependencies
  - Running the demo
- Store
  - Overview
  - Initialization
  - Latency and bandwidth emulator
  - Keys
  - Namespaces
  - Values
  - Automatic Nesting
  - Soft deletion
  - Scalability
- Store caching
  - Configuration
  - Behavior
  - Manual Cache Invalidation
  - Limitations
  - Statistics
- Backends
  - posixfs
  - sftp
  - rclone
  - s3
  - REST (http/https)
- REST Server
  - Running the server on host:port
  - Running the server via stdio
  - Accessing the server from a client
  - Permissions
  - Quota
- Changelog
  - Version 0.6.1 (2026-08-11)
  - Version 0.6.0 (2026-08-02)
  - Version 0.5.5 (2026-07-10)
  - Version 0.5.4 (2026-07-09)
  - Version 0.5.3 (2026-06-30)
  - Version 0.5.2 (2026-06-26)
  - Version 0.5.1 (2026-06-02)
  - Version 0.5.0 (2026-05-28)
  - Version 0.4.1 (2026-04-26)
  - Version 0.4.0 (2026-03-15)
  - Version 0.3.1 (2026-02-09)
  - Version 0.3.0 2025-05-22
  - Version 0.2.0 2025-04-21
  - Version 0.1.0 2024-10-15
  - Version 0.0.5 2024-10-01
  - Version 0.0.4 2024-09-22
  - Version 0.0.3 2024-09-17
  - Version 0.0.2 2024-09-10
  - Version 0.0.1 2024-08-23
- Authors and License
  - Authors
  - License