Barrel
FR GitHub

What works today, and what doesn't yet.

Every page on this site uses the same three marks. This page lists each capability with its mark, copied from the feature table in the Barrel repository.

The three marks

Works today
Usable now with no extra setup, and covered by the test suites. In the table below: Ready.
Optional, needs setup
Usable now, but off by default or behind a build profile: a backend to enable, a library to install, a key to provide. In the table below: Opt-in.
Planned
Not built yet. Described so you can plan around it, never shown as working. In the table below: Planned.

What Barrel does today and what is planned, by capability. Read this to see which features are usable now, which are opt-in, and which are still ahead. Each row links to a guide where one exists.

Status legend

  • Ready: usable now, has tests.
  • Opt-in: usable now, off by default or behind a build profile.
  • Planned: not built yet.

Data model

A barrel record is one id with three faces: a JSON document, its attachments (blobs), and its vector. Documents live in barrel_docdb, vectors in barrel_vectordb, blobs are document attachments. The barrel API composes them; each underlying app stays usable on its own.

Capabilities

CapabilityStatusNotes
Documents (CRUD, MVCC, query)Readybarrel_docdb; find/2 over the path index. See embedding.
Batches (put_docs/get_docs/delete_docs, vector_add_batch)ReadyPer-element results, in order. A put_docs entry can be {Doc, DocOpts} with its own outbox tags and sync flag.
Write throughputReadyConcurrent writes to one database share one batch and one sync (group commit, max_group); documents are prepared in the caller and a committer process writes each group (write_chunk). See apps/barrel_docdb/docs/benchmarks.md.
Read-only opensReadyread_only => true on barrel:open/2, barrel_docdb and barrel_vectordb: RocksDB OpenForReadOnly, no file created or rewritten, several nodes can serve one directory. Writes answer {error, read_only}.
Attachments (blobs)ReadyDocument attachments; pluggable backend per db via barrel_att_backend (RocksDB BlobDB default, none for databases without attachments). Streaming read/write.
S3 attachment backendOpt-inbarrel_att_s3 (rebar3 as s3): attachments in S3-compatible storage, with replication and multipart-upload GC.
Vector searchReadybarrel_vectordb; HNSW by default.
Record mode (policy-driven vector indexing)ReadyDocuments auto-embed per policy; async (healed) or sync (read-your-write); explicit vectors via put option. See record-mode.
BM25 keyword searchOpt-inEnable with bm25_backend => memory (or disk) at open; disk by default in record mode. The disk index is durable across close and kill; the memory index is rebuilt from the stored text at open.
Trigram substring and regex searchOpt-inbarrel_ngram: an index over barrel_docdb documents with checksummed segments (verify_segments); served as the ngram_search MCP tool.
Hybrid search (vector + BM25)Opt-inNeeds BM25 enabled; results carry text/metadata. Text queries need an embedder (or query_vector).
EmbeddingsOpt-inbarrel_embed (local Python, Ollama, OpenAI, ...). Auto-embed and text hybrid need it. barrel:embedder_info/1 reports the model identity and a fingerprint: two databases with the same fingerprint produce comparable vector scores. See record-mode.
RerankingOpt-inbarrel_rerank (cross-encoder).
FAISS index backendOpt-inbarrel_faiss; needs the FAISS C++ library, excluded from the default build (rebar3 as faiss).
Changes feedReadychanges/2, subscribe/2; HLC cursor via hlc_encode/1.
BQL queriesReadyPartiQL dialect over docs, vectors, and BM25; live SUBSCRIBE queries. Results carry the observed version (instance_id, last_seq); the REST query route takes max_rows and deadline_ms and reports bound. See query-bql.
ContextsReadyNamed datasets on this node or other barrel_server nodes, queried together with one BQL statement; per-source status, version and coverage; working sets with saved slices and imported snapshots that answer offline. Erlang (barrel_ctx), REST (/contexts, /worksets) and MCP (context_* tools). See contexts.
Export and read-only importReadybarrel_ctx_export: a checksummed copy of a database, imported and verified elsewhere and served read only. See contexts.
Database lifecycleReadybarrel_dbs: idle close, LRU eviction, pinning, counted leases, exclusive holds, must_exist opens.
Synchronization / replicationReadySame VM and over HTTP (/db/:db/_sync/*); documents, attachments, channels, continuous tasks. Bearer, Ed25519 signed-request, and mTLS auth (opt-in; bearer is the default). Vectors rebuild locally. See synchronization.
Timeline (branch, PITR, merge)ReadyO(1) forks, point-in-time rewind, merge back as sync. See timeline.
Audit and provenanceReadyRetained history log; actor/session/source on writes; past bodies by version. See audit-provenance.
Document TTLReadyexpires_at write option, lazy expiry, opt-in sweeper (ttl_sweep_interval).
Encryption at restOpt-inPer-database keys via barrel_keyprovider; EncryptedEnv plus a sector cipher for flat files. See encryption.
REST/JSON serverOpt-inbarrel_server over livery, rebar3 as server; serves HTTP/1.1 (default) plus opt-in HTTP/2 and HTTP/3 over TLS. See rest-server.
Agent layer (spaces, capabilities, sessions, handoffs)Readybarrel_spaces; capability bearers on REST and MCP. See spaces.
MCP endpoint (tools, resources, live queries)Opt-in/mcp in barrel_server, on by default there. See mcp.
Browser client (barrel-lite)ReadyOffline-first TypeScript client (clients/barrel-lite): OPFS store, HLC-stamped writes, sync over the wire (polling or continuous SSE), multi-tab, attachment sync, a local BQL subset matching the server, and vector search (embedding pull + brute-force cosine top-k over the synced set, with server /search delegation; no ANN in the browser). See barrel-lite.
CORS + capability tokens on /dbReadyCORS middleware and bsp_ bearers scoped to their space's /db routes, so browsers can sync. See rest-server.
gRPC, WebTransport, unix socket, OpenAPIPlannedLater transports on barrel_server.
SQL API, agentfsPlannedLater.

Where things run

  • Embedded: depend on barrel (no transports pulled in). See embedding.
  • Server: run barrel_server for HTTP. See rest-server.

From docs/features.md at commit 794415d, updated 2026-09-26. Corrections go to the repository.

Up and down to moveEnter to open