Skip to content

Repository files navigation

Macrame

CI Python crates.io docs.rs PyPI Python versions MSRV License

A bitemporal graph ledger for knowledge management — embedded, single-file, no server.

Macrame stores concepts linked by typed, weighted relationships — where both concepts and relationships change over time, and the history of those changes is itself a first-class asset. Everything lives in one .db file on disk. No database server, no network protocol, no external service.


Why Macrame

Strength What it means
Bitemporal by design Two independent clocks per row — valid time (when a fact held in the world) and transaction time (when the database learned it). as_of(ts) answers "what did the world look like?" and reconstruct(ts) answers "what did we believe?" — both correct, both different.
Single file, embedded The entire database is one file on the local filesystem. Link it directly into your application. Run on Windows desktop, Linux, or macOS — the Rust suite runs on all three in CI.
Graph + vectors + search Recursive CTE traversal, native DiskANN vector search, FTS5 keyword search, and hybrid RRF fusion — all in one crate, no external graph library.
Five in-memory analytics Dijkstra, A*, SCC, k-core, and Louvain — operating on a typed Subgraph with zero external dependencies.
Rebuildable materialization links_current is a cache of current belief, always rebuildable from the append-only transaction_log. Drift is detectable by audit, recoverable by atomic or chunked rebuild.
Archival path Closed intervals move to a cold database inside atomic sessions. Point-in-time reconstruction composes from snapshots plus anchored folds — fast because it doesn't fold from genesis.
Runtime safety One Write Actor serialises all writes; read connections carry PRAGMA query_only = ON enforced at the engine level. No raw SQL escapes the guard.

Quick Start

Rust

[dependencies]
macrame-db = "0.9"
use macrame::prelude::*;

async fn main() {
    let db = Database::open("knowledge.db").await?;

    db.upsert_concept(ConceptUpsert::new("quantum", "Quantum Computing")
        .valid_from("2026-01-01T00:00:00.000000Z"))
        .await?;

    db.upsert_concept(ConceptUpsert::new("entanglement", "Quantum Entanglement")
        .valid_from("2026-01-01T00:00:00.000000Z"))
        .await?;

    db.assert_edge(EdgeAssertion::new("quantum", "entanglement", "ENTAILS")
        .valid_from("2026-01-01T00:00:00.000000Z")
        .weight(1.0))
        .await?;

    let subgraph = db.traverse()
        .start_node("quantum")
        .max_depth(3)
        .execute(db.read_conn(), None)
        .await?;
}

Python

pip install macrame-db
import macrame

T0 = "2026-01-01T00:00:00.000000Z"

with macrame.Database.open("knowledge.db") as db:
    db.write_concepts([
        macrame.ConceptUpsert("quantum", "Quantum Computing", valid_from=T0),
        macrame.ConceptUpsert("entanglement", "Quantum Entanglement", valid_from=T0),
    ])
    db.assert_edge(
        macrame.EdgeAssertion("quantum", "entanglement", "ENTAILS", valid_from=T0)
    )
    graph = db.load_subgraph("quantum", 3, 1 << 20)
    print(graph.dijkstra("quantum"))

Architecture Highlights

Eight Doctrine Invariants

Every design decision derives from these invariants:

  1. The boundary is sacred — Everything above libSQL is ours; everything below it is upstream. Never patch the engine.
  2. Two clocks, never mixed — Valid time and transaction time are independent axes. No code path derives one from the other.
  3. Assertions are immutable — Rows in links are never updated in place. The past is never rewritten; it is only ever superseded.
  4. The ledger is a table, not the log — Transaction-time reconstruction reads transaction_log, not WAL or CDC frames.
  5. No physical deletion in hot tables — Rows leave through the archive path only. Ad-hoc DELETE aborts at the trigger layer.
  6. Derivative state is disposablelinks_current is a rebuildable materialization. Drift is detectable, recoverable by rebuild.
  7. Embeddings are immutable per version, excluded from the ledger — Vectors live in per-model tables; they never appear in transaction_log payloads.
  8. Fidelity is a parameter, never a silent defaultas_of(ts) and reconstruct(ts) say what they mean in their signatures.

Concurrency Model

  • One writer — a dedicated Tokio task holds the sole write-capable connection
  • Many readers — WAL journaling; readers never block on writer
  • Two-tier priority channels — high-priority (user-driven) preempts low-priority (background)
  • Cooperative chunking — bounded to ~3 ms per chunk, four paths with different row counts (90 edges, 70 concepts, 600 annotations, 30 embeddings)

Schema Versioning

Version Feature
v2 Legacy-free baseline
v3 analytics_annotations table
v4 FTS5 external-content index
v5 Overlap guard index
v6 Overlapping closed intervals refused in actor
v7 CHECK (weight >= 0.0) on links.weight
v8 concepts.rowid_pk, the third FTS trigger, and the two unread indices dropped — current

v8 is the last rung before the 1.0 freeze that could take it: rowid_pk INTEGER PRIMARY KEY costs id the primary key, and D-036 forbids a primary-key change after 1.0 (D-119). It also drops idx_annotations_label and idx_lc_tgt_active, which shipped in the v7 baseline with no query that seeks on them — measured at −7.9% off assert_edge (D-089, D-118).


Rust Implementation

Detail Value
Edition Rust 2021
MSRV 1.88 (verified, not declared)
Runtime tokio async, single process
Engine libSQL 0.9.30 (MIT, unmodified)
Schema version 10
Test suite 330 Rust · 339 with metrics · +7 property-tests (run as its own step — see below) · 353 Python — all green (measured 2026-08-07)
Dependencies tokio, serde, bincode, zstd, thiserror, tracing, ulid

Module Map

Module Responsibility
schema DDL, triggers, migrations
graph CTE compilation, subgraph loading, vector filters
temporal as_of(), reconstruct(), snapshots, archive, rehydrate
vector Model registration, embedding upsert, DiskANN search, hybrid RRF
integrity Audit, atomic rebuild, chunked shadow-swap rebuild
connection Database handle, Write Actor, priority channels
error DbError enum, error classification

Python Bindings (v0.9.0)

Detail Value
Engine pyo3 0.29 + maturin
Surface Synchronous (Write Actor serialises all writes)
GIL Released via Python::detach around Runtime::block_on
Distribution macrame-db on PyPI, import macrame
Wheels abi3-py310 — one per platform (Linux x86_64/aarch64, macOS universal2, Windows x86_64)
Python CPython 3.10+
Type stubs Ship with wheel, py.typed set, mypy --strict in CI

Key design decisions

  • Synchronous surface — The Write Actor serialises every write through one channel, so exposing await advertises concurrency the architecture does not grant.
  • Opaque Subgraph — A #[pyclass] with forwarded accessors; .to_dict() for callers who want the copy. It paid for itself in 0.8.0: the crate re-represented EdgeRef and no binding signature moved, because there is no converted copy whose layout had to follow (D-101, D-123).
  • Open intervals cross as None — Not a sentinel datetime, because datetime.max cannot survive .astimezone() east of UTC.
  • Absent content crosses as Noneload_subgraph does not fetch document text unless asked (content=True). "" cannot mark not loaded, because it is a valid value of the type (D-116, D-123).
  • Every error is typed — 35 exception classes under MacrameError, with six intermediate groups for catching sets: IntegrityError, ValidationError, VectorError, TemporalError, WriterError, BudgetError.
  • metrics shipped on — The wheel ships with the metrics feature enabled because feature flags do not survive into binary artifacts.

Performance (measured, not gated)

Re-measured at 0.8.0, because B2 changed how a Subgraph is represented, B3 changed what a load carries, and B4 dropped an index — three reasons a table of 0.7.0 numbers would have been describing a different crate.

Operation Budget 0.7.0 0.8.0
Single assertion ≤ 5 ms 258 µs, and still O(out-degree), not O(1) (D-059)
Chunk commit (edges, 90 rows) ≤ 3 ms 2.39 ms 2.40 ms
Three-hop traversal ≤ 10 ms 2.1 ms 1.66 ms
Vector top-10 ≤ 20 ms 294 µs 246 µs
Hybrid top-10 ≤ 50 ms 2.0 ms 1.77 ms
Full fold (reconstruct) ≤ 100 ms 21 ms 16.9 ms
Composition (snapshot + delta) ≤ 100 ms 3.4 ms 2.18 ms

Two controls, or the read-path numbers would mean nothing. A uniform improvement across unrelated paths is what a faster machine looks like, so: the fixed control/select_1 row reads 1.51–1.62 µs against the 1.589–1.639 µs D-090 recorded, and the chunk-commit path — which 0.8.0 did not touch — is 2.39 → 2.40 ms. The machine has not moved and an untouched path has not moved, so the 12–36% on the read paths is the code.

The single-assertion row is a fixture measurement and the caveat is the load-bearing part: it is under budget on this fixture and remains linear in out-degree, so a high-degree hub still exceeds it. Dropping idx_lc_tgt_active bought −7.9% on that path (D-118); it did not change the complexity.

All budgets measured on named reference hardware, and deliberately not CI gates (D-055) — an absolute ≤ 5 ms on a shared runner is an assertion about whichever machine picked up the job. Regression detection uses criterion baselines, machine against itself. See §9 of the architecture docs for full table.


Known Risks

Risk Mitigation
R15: Concurrent open → access violation (libSQL 0.9.30) One open per database; R15 reproduces transparently through Python. --features property-tests is run as its own step, not folded into the suite: integrity_property_tests needs a database per case, and inside the full run it faults often enough that the classifier's three retries are routinely exhausted. Alone it is ~50/50 and green when it completes — measured 2026-08-07, and it is the engine rather than the tests
Property test binaries fault mid-suite property-tests feature gate; serialised runs; CI classifies each run rather than counting failures, and retries only a crash
Covering index wins over selective EXPLAIN QUERY PLAN assertions on every index-sensitive query
Snapshot chain divergence verify_snapshot_chain() reports but does not repair (snapshots are disposable)

Minimum Supported Rust Version

1.88, verified rather than declared — cargo +1.88.0 check --all-features --all-targets passes and 1.85 does not. The constraint comes from libsql-ffi's build dependency chain (bindgen → which → home), not from this crate's own code (which needs only 1.73).


Documentation


Naming

Distribution macrame-db, import macrame — on both crates.io and PyPI. The Rust side has no caveat: a crate's [lib] name is namespaced per build graph, so macrame-db providing macrame collides with nothing. site-packages is flat.

The PyPI package macrame is an unrelated, effectively abandoned build tool (0.0.1, 2021). If it installs a top-level macrame/, then installing both leaves two distributions contending for one directory — pip warns on file conflicts, so this is a known and non-silent risk. Importing as macrame_db is the fallback if it ever matters.


License

See LICENSE for details.

About

An embedded bitemporal graph ledger — concepts, typed relationships, and their full history of change, with hybrid vector/keyword search, graph traversal, and in-memory analytics, in a single .db file.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages