mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-09 01:35:18 +02:00
Splits the 990-line AGENTS.md into a 184-line map (architecture, where-to-find index, always-on invariants, capability matrix, maintenance contract) plus 18 new docs/*.md files holding the deep content per topic (storage, schema and query languages, indexes, embeddings, branches/commits, runs, merge, changes, execution, policy, server, CLI reference, audit, errors, CI, constants, v0.3.1 notes). Adds scripts/check-agents-md.sh and a check_agents_md CI job that verifies every docs/ link in AGENTS.md resolves and every doc in the canonical set is linked. CLAUDE.md remains a symlink to AGENTS.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1.7 KiB
1.7 KiB
Indexes
L1 — Lance index types OmniGraph exposes
| Index | Use | Notes |
|---|---|---|
| BTREE scalar | range / equality on any scalar | created on @key, @index(...), and on key columns by ensure_indices() |
| Inverted (FTS) | search, fuzzy, match_text, bm25 |
created on text columns referenced by FTS queries |
| Vector | nearest() k-NN |
Lance picks IVF_PQ vs HNSW family by configuration; OmniGraph stores as FixedSizeList(Float32, dim) |
L2 — OmniGraph orchestration
ensure_indices()/ensure_indices_on(branch)— idempotent build of BTREE + inverted indexes for the current head; safe to re-run.- Indexes are built on the branch head (not on a snapshot), so reads always see the current index state.
- Lazy branch forking for indexes: a branch that hasn't mutated a sub-table doesn't need its own index — the main lineage's index is reused until the first write triggers a copy-on-write fork.
- Vector index parameters (metric, nlist, nprobe, etc.) are not exposed in the schema; they default at the Lance layer and are picked up automatically when an index is asked for on a Vector column.
L2 — Graph topology index (graph_index/mod.rs)
This is OmniGraph-specific (not Lance):
TypeIndex: denseu32 ↔ String idmapping per node type.CsrIndex: Compressed Sparse Row representation of edges per edge type —offsets[i]..offsets[i+1]slices intotargets.GraphIndex { type_indices, csr (out), csc (in) }— built on demand from a snapshot's edge tables.- Cached in
RuntimeCache::graph_indices(LRU, max 8 entries, keyed by snapshot id + edge table versions). - Built only when an
ExpandorAntiJoinIR op is present in the lowered query, so pure scans skip it.