Commit graph

5 commits

Author SHA1 Message Date
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