soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

feat: add frozen flag for complete immutability and simplify README examples

Browse source 
- Add frozen flag to separate data immutability from performance optimizations
  - readOnly: prevents data mutations but allows index optimizations (default behavior)
  - frozen: prevents ALL changes including statistics and index updates
  - Smart default: frozen=false when readOnly=true for optimal performance

- Add comprehensive documentation for read-only and frozen modes
  - Created docs/guides/readonly-frozen-modes.md with detailed guide
  - Added examples for compliance, forensics, and testing use cases
  - Updated all documentation indexes with new guide links

- Simplify README.md to emphasize unified API
  - Clearer demonstration that same code works everywhere
  - Simplified framework examples showing consistent API
  - Better noun/verb examples for entities and relationships
  - Collapsible sections for cloud platform examples
  - Environment auto-detection table

- Add tests for frozen flag behavior
  - Test readOnly without frozen (allows optimizations)
  - Test frozen mode (complete immutability)
  - Test dynamic mode switching

BREAKING CHANGE: readOnly behavior changed - now allows optimizations by default.
To get old behavior (complete immutability), use readOnly: true with frozen: true.
This commit is contained in:
David Snelling 2025-08-06 09:52:45 -07:00
parent 8976f274f3
commit e838327a22
6 changed files with 726 additions and 570 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -17,6 +17,7 @@ Comprehensive guides for using Brainy features.
- **[Search and Metadata Guide](user-guides/SEARCH_AND_METADATA_GUIDE.md)** - Advanced search techniques
- **[Write-Only Mode](user-guides/WRITEONLY_MODE_IMPLEMENTATION.md)** - Optimized data ingestion
- **[Read-Only & Frozen Modes](guides/readonly-frozen-modes.md)** - Immutability control for production
- **[Cache Configuration](guides/cache-configuration.md)** - Memory and caching optimization
- **[JSON Document Search](guides/json-document-search.md)** - Searching within JSON documents
- **[HNSW Field Search](guides/hnsw-field-search.md)** - Field-specific vector search