BrewFSBrewFS
BrewFSBrewFS
Get started
DevelopersExamplesBackend Adapter GuideMetadata Backend GuideContributingCode Structure
Developers

Metadata Backend Guide

Add a new metadata backend.

Metadata backends provide transactional storage for the namespace, inodes, and slice descriptors. The core abstraction is a transactional key-value / relational client with:

  • Namespace operations (lookup, readdir, rename)
  • Inode attribute reads and writes
  • Slice descriptor append and compaction commits
  • Transactions covering multi-key updates

Start from the SQLx implementation (simplest to follow), then compare with the Redis implementation for the latency-optimized variant. Correctness is enforced by a shared transaction test suite that every backend must pass.

Backend Adapter Guide

Add a new object storage backend.

Contributing

How to get involved with BrewFS.