Skip to content

Docs: roadmap checklist, drop draft framing #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eddietejeda merged 1 commit into from
Jul 22, 2026
Merged

Docs: roadmap checklist, drop draft framing #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions DESIGN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Package:** `hotdata-materialized` (module `hotdata_materialized`)
**Primitive:** `@materialize` decorator → `MaterializedFrame` handle
**Status:** Draft v0.2 (2026-07-22)
**Status:** v0.2 — see the README roadmap for what is implemented

## What it is

Expand Down Expand Up @@ -209,7 +209,7 @@ write-through for callers that need `.sql()` on the entry immediately.

## MaterializedFrame

First cut implements `.arrow()`, `.df()`, `.to_pylist()`, `len()`, and
Implemented today: `.arrow()`, `.df()`, `.to_pylist()`, `len()`, and
`.sql()` (server-side; requires a persisted entry — on a fresh
write-behind miss it raises until the background persist lands). The
rest of this section is the target design.
Expand Down Expand Up @@ -242,7 +242,7 @@ frame.meta # fingerprint, database_id, created_at, expires

## Decorator API

Implemented (first cut):
Implemented:

```python
from hotdata_materialized import materialize
Expand Down Expand Up @@ -353,7 +353,7 @@ synchronous — fine for WSGI; async views get `sync_to_async` wrappers
load → registry upsert; delete path). Pure SDK composition.
2. **`@materialize` + `MaterializedFrame`** with the three backings,
`.df()/.arrow()/.pl()/.sql()`, inline-payload short-circuit, fail-open.
*(shipped: first cut — arrow/df/to_pylist/sql, fail-open)*
*(shipped: arrow/df/to_pylist/sql, fail-open)*
3. **Chainable facade:** immutable lazy queryset compiler over the entry
table (Django lookup syntax).
4. **Freshness machinery:** SWR, building-row lock, sweep management command +
Expand Down
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,22 @@ persist leaves no registry row, and the next request simply misses again.
See [DESIGN.md](DESIGN.md) for the architecture and the accepted
trade-offs.

## Status / roadmap

First draft. Implemented: the `@materialize` decorator and
`MaterializedFrame` (first cut), fingerprinting, the remote registry, entry
store with write-behind persists, Arrow-native reads, and the TPC-H demo.
Next: stale-while-revalidate refresh, the sweep command, a chainable queryset
facade on the frame, and vector/BM25 index declarations.
## Roadmap

- [x] Content-addressed fingerprinting (querysets and function calls)
- [x] Remote registry — no migrations or local state in the host app
- [x] Entry store with write-behind persists
- [x] Arrow-native reads (inline payloads, persisted-result fetch)
- [x] `@materialize` decorator and `MaterializedFrame`
(`.arrow()/.df()/.to_pylist()/.sql()`)
- [x] TPC-H demo and benchmark
- [x] CI: pytest, mypy, flake8
- [ ] Stale-while-revalidate refresh (rebuild protocol)
- [ ] Sweep command for expired entries
- [ ] Chainable queryset facade on the frame (`.filter()/.order_by()`)
- [ ] Vector/BM25 index declarations and `frame.search()`
- [ ] Async view support (`await frame.aarrow()`)
- [ ] PyPI release

## Demo

Expand Down
Loading