Commit graph

10 commits

Author SHA1 Message Date
e5feae4104 feat(8.0): full query surface at historical generations via ephemeral index materialization
Historical Db values (now()/asOf() pins that history has moved past) now
serve the COMPLETE query surface - vector/hybrid search, graph traversal,
cursor pagination, and aggregation - by materializing ephemeral in-memory
indexes over the exact at-generation record set. The historical-query
throw is gone; NotYetSupportedAtHistoricalGenerationError is deleted.

Materializer (Brainy.materializeAtGeneration):
- Copies the at-G record set (live bytes for ids untouched since the pin,
  immutable before-images otherwise) into a fresh MemoryStorage; a final
  reconciliation pass under the commit mutex makes the copy exact even
  when transactions commit mid-build.
- Opens a read-only Brainy over the copy: init rebuilds the metadata and
  graph-adjacency indexes from the records; the vector index is built by
  inserting every at-G vector (the at-G HNSW graph never existed on disk,
  so there is nothing to restore). Host embedder and aggregate definitions
  are shared - no second model load, aggregates backfill at-G values.
- Cost is the documented contract: O(n at G) time and memory, ONCE per Db
  (handle cached; freed by release(), with a FinalizationRegistry backstop
  that also closes leaked readers). A native VersionedIndexProvider serves
  the same reads from retained segments with no rebuild.

Db routing (src/db/db.ts): metadata-level find()/related() keep the free
record path; index-only dimensions (query/vector/near/connected/cursor/
aggregate/includeRelations/non-metadata modes) route to the cached
materialization; unsupported where-operators on the record path re-route
there too instead of erroring. Speculative with() overlays keep the one
honest boundary - SpeculativeOverlayError (overlay entities carry no
embeddings, so index reads over them would be silently incomplete);
metadata find()/get()/filter related() work on overlays.

UpdateParams.vector contract now honored: an explicit pre-computed vector
applies directly (with dimension validation) in update() and transact
update ops, re-indexing HNSW - previously it was silently ignored unless
data also changed.

GraphAdjacencyIndex: adjacency now derives from the two verb-id LSM trees
filtered through the live-verb tombstone set (entity->entity edge trees
deleted - they carried no verb ids, so removeVerb could never tombstone
them and traversal served stale neighbors forever). Neighbor reads batch-
load live verbs via the unified cache; addVerb seeds the cache.

Proofs (tests/integration/db-mvcc.test.ts, 24 green): historical vector
search finds old vector placement including since-deleted entities;
historical graph traversal walks the old wiring after a rewire; historical
aggregation computes at-G group values; asOf() pins get the same surface;
the materialization builds once per Db and release() closes the ephemeral
reader (it refuses reads afterwards); overlays throw the documented error.
ADR-001 updated to the no-throws historical model.
2026-06-11 08:12:11 -07:00
adda1570f3 docs(8.0): Phase F — deep clean across 21 docs
Aligned every public doc to the 8.0 contract: filesystem + memory adapters
only, vector index provider terminology (config.vector with recall +
quantization + persistMode knobs), no cloud storage adapters, no closed-
source product names.

Tier 1 — heavier rewrites:
- docs/architecture/storage-architecture.md
- docs/architecture/data-storage-architecture.md
- docs/architecture/distributed-storage.md DELETED — content was 100%
  cloud-coordination examples with no 8.0 substance.
- docs/guides/distributed-system.md DELETED — same reason; no inbound refs.
- docs/SCALING.md rewritten for single-node guidance.
- docs/PLUGINS.md, docs/augmentations/{COMPLETE-REFERENCE,README}.md:
  HnswProvider→VectorIndexProvider, hnsw→vector key.
- docs/PERFORMANCE.md, docs/BATCHING.md cloud-detection + sharding
  sections replaced with single-node vector tuning + filesystem framing.

Tier 2 — surgical renames + cloud-section deletions:
- architecture/{index,initialization-and-rebuild,overview}.md
- transactions.md, DEVELOPER_LEARNING_PATH.md
- vfs/{VFS_API_GUIDE,COMMON_PATTERNS}.md
- api/README.md, guides/{inspection,import-flow}.md

Tier 3 — light edits:
- docs/README.md, architecture/augmentation-system-audit.md

MIGRATION-V3-TO-V4.md untouched (internal migration doc, no stale terms).
2026-06-09 16:13:35 -07:00
f024e56ee7 feat: add aggregation engine with incremental SUM/COUNT/AVG/MIN/MAX, GROUP BY, and time windows
Add a write-time incremental aggregation engine that maintains running
totals on every add/update/delete for O(1) read performance. Integrates
into brain.find({ aggregate }) for a unified query API.

Core features:
- AggregationIndex with defineAggregate()/removeAggregate() API
- Five aggregation operations: SUM, COUNT, AVG, MIN, MAX
- GROUP BY with multiple dimensions including time windows
- Time window bucketing: hour, day, week, month, quarter, year, custom
- Materialization of results as NounType.Measurement entities
- Debounced persistence of definitions and state to storage
- Definition change detection via FNV-1a hashing with auto-rebuild
- Infinite loop prevention for materialized entities
- 'aggregation' plugin provider key for native acceleration
- Lazy initialization (created on first defineAggregate() call)
- 73 tests (unit + integration) covering all functionality

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-16 16:57:53 -08:00
364360d447 fix: exclude __words__ keyword index from corruption detection and getStats()
The __words__ keyword index stores 50-5000 entries per entity (one per
word), which inflated avg entries/entity well above the corruption
threshold of 100. This caused:

1. validateConsistency() to falsely detect corruption on every startup,
   triggering unnecessary clearAllIndexData() + rebuild() cycles
2. getStats() to log false "Metadata index may be corrupted" warnings
   and report inflated totalEntries/totalIds stats

Both methods now skip __words__ when counting, so stats and health
checks reflect metadata fields only (noun, type, createdAt, etc.).
Keyword search is unaffected since the __words__ field index itself
is not modified.
2026-01-27 15:38:21 -08:00
a78f3bb0d2 docs: update architecture docs and README for hybrid search 2026-01-26 17:16:49 -08:00
67039fcf1f docs: update index architecture documentation for v5.7.7 lazy loading
Updated index architecture documentation to accurately reflect the current implementation:

**Index Architecture Changes:**
- Clarified 3-tier architecture: 3 main indexes + ~50+ sub-indexes
- Removed DeletedItemsIndex (not currently integrated)
- Added TypeAwareHNSWIndex with 42 type-specific indexes
- Documented MetadataIndexManager sub-components (ChunkManager, EntityIdMapper, etc.)
- Documented GraphAdjacencyIndex with 4 LSM-trees
- Added comprehensive summary section with index hierarchy

**Lazy Loading Documentation:**
- Added Mode 1 (Auto-Rebuild) vs Mode 2 (Lazy Loading) comparison
- Documented ensureIndexesLoaded() implementation with concurrency control
- Added lazy loading performance characteristics (0-10ms init, 50-200ms first query)
- Added use cases for each mode (serverless, development, large datasets)
- Documented mutex-based concurrency safety

**Files Updated:**
- docs/architecture/index-architecture.md
- docs/architecture/initialization-and-rebuild.md
- docs/PERFORMANCE.md

All documentation now accurately reflects v5.7.7 lazy loading implementation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-13 10:10:39 -08:00
b2afcad00e fix: migrate from roaring (native C++) to roaring-wasm for universal compatibility
Replace native dependency 'roaring' with WebAssembly implementation 'roaring-wasm'
to eliminate build tool requirements and ensure compatibility across all environments.

This resolves the "missing dependency" issue reported in v3.43.0 where users on
systems without python/gcc/node-gyp would experience installation failures.

**Changes**:
- Replace 'roaring@2.4.0' with 'roaring-wasm@1.1.0' in package.json
- Update all imports from 'roaring' to 'roaring-wasm' (4 source files, 2 test files)
- Update documentation to explain WebAssembly benefits

**Benefits**:
-  Works in all environments (Node.js, browsers, serverless, Docker)
-  No build tools required (no python, make, gcc/g++)
-  No native compilation errors
-  Same API (RoaringBitmap32 interface unchanged)
-  Same performance (90% memory savings, hardware-accelerated operations)
-  Better developer experience (npm install just works)

**Testing**:
- All 25 roaring bitmap integration tests passing
- 489/500 unit tests passing (97.8% pass rate)
- Zero TypeScript compilation errors
- Verified multi-field intersection queries work correctly

**Technical Details**:
- Uses WebAssembly instead of native C++ bindings
- Maintains identical RoaringBitmap32 API (zero breaking changes)
- Portable serialization format unchanged (compatible with Java/Go implementations)
- No changes to core functionality or performance characteristics

Fixes: #3.43.0-missing-dependency

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-14 10:24:59 -07:00
2f6ab9559a feat: optimize metadata indexing with roaring bitmaps for 90% memory reduction
Replace JavaScript Sets with hardware-accelerated RoaringBitmap32 for metadata indexes.

Key improvements:
- 1.4x average speedup, up to 3.3x on 10K entities
- 90% memory reduction (40 bytes/UUID → 4 bytes/int)
- Hardware-accelerated multi-field intersection via SIMD (AVX2/SSE4.2)
- EntityIdMapper for bidirectional UUID ↔ integer mapping
- Portable serialization format

Benchmark results (1,000 queries):
- 10K entities: 3.74ms → 1.14ms (3.3x faster, 90% memory savings)
- 100K entities: 2.60ms → 1.78ms (1.5x faster, 88% memory savings)

Implementation:
- Add EntityIdMapper class for UUID/int mapping with persistence
- Modify ChunkData to use Map<string, RoaringBitmap32>
- Add getIdsForMultipleFields() for fast bitmap intersection
- Include comprehensive tests (25 tests passing)
- Add performance benchmark comparing Set vs Roaring

Technical details:
- roaring@2.4.0 dependency
- Maintains backward compatibility
- All queries still return UUID strings
- Automatic persistence via storage adapter
2025-10-13 16:39:06 -07:00
b7dfc52e94 feat: replace flat file indexing with adaptive chunked sparse indexing
Major refactor of metadata indexing system for production scalability:

Performance improvements:
- 630x file reduction: 560,000 flat files → 89 chunk files
- O(1) exact match queries with bloom filters (1% false positive rate)
- O(log n) range queries with zone maps (ClickHouse-inspired)
- Adaptive chunking: ~50 values per chunk optimizes I/O

Technical changes:
- NEW: src/utils/metadataIndexChunking.ts
  - BloomFilter: Probabilistic membership testing (FNV-1a + DJB2)
  - SparseIndex: Directory of chunks with metadata
  - ChunkManager: Handles chunk CRUD operations
  - AdaptiveChunkingStrategy: Field-specific optimization
  - ZoneMap: Min/max tracking for range query optimization

- REFACTORED: src/utils/metadataIndex.ts
  - Removed indexCache (flat file entry cache)
  - Removed dirtyEntries (flat file dirty tracking)
  - Removed sortedIndices (sorted index for range queries)
  - Removed 13 obsolete methods (sorted index operations, flat file I/O)
  - Simplified flush() to only flush field indexes
  - All fields now use chunked sparse indexing exclusively

- UPDATED: docs/architecture/index-architecture.md
  - Documented new chunked sparse index architecture
  - Added bloom filter and zone map explanations
  - Updated query algorithm examples
  - Added v3.42.0 version history

Benefits:
- Single code path (no more dual flat file + chunks)
- Immediate chunk flushing (no dirty tracking needed)
- Better I/O patterns (chunk-based instead of per-value files)
- Production-ready for billions of entities
- Zero breaking changes to public API

All tests passing. Ready for production.
2025-10-13 15:31:03 -07:00
75b4b02610 docs: add comprehensive index architecture documentation
Add detailed documentation explaining Brainy's 4-index architecture:
- MetadataIndex: inverted indexing with temporal bucketing (v3.41.0)
- HNSWIndex: hierarchical vector similarity search
- GraphAdjacencyIndex: O(1) bidirectional relationship traversal
- DeletedItemsIndex: soft-delete tracking

Includes explanation of UnifiedCache for coordinated memory management
across all indexes, integration patterns, performance characteristics,
and best practices for developers.

Updated overview.md to reference the new index architecture documentation.
2025-10-13 13:42:04 -07:00