David Snelling
e838327a22
- 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.
4.4 KiB
4.4 KiB
User Guides
Comprehensive guides for using Brainy's features effectively in your applications.
📖 Available Guides
🔍 Search and Metadata Guide
Master advanced search techniques and metadata management.
- Field-specific search strategies
- JSON document search patterns
- Metadata optimization techniques
- Search performance tips
✏️ Write-Only Mode Implementation
Optimize data ingestion with write-only mode.
- High-throughput data loading
- Batch operation strategies
- Performance optimization for writes
- Use cases and implementations
🔒 Read-Only & Frozen Modes
Control immutability for different production scenarios.
- Read-only with optimizations (default)
- Completely frozen for compliance
- Dynamic mode switching
- Migration from older versions
💾 Cache Configuration
Configure caching for optimal performance.
- Multi-level caching strategies
- Memory optimization techniques
- Cache hit rate improvement
- Environment-specific settings
📄 JSON Document Search
Search within JSON document fields.
- Field prioritization strategies
- Service-based field mapping
- Cross-service search patterns
- Advanced querying techniques
🎯 HNSW Field Search
Field-specific vector search techniques.
- Targeted field searches
- Search scope optimization
- Performance considerations
- Integration patterns
🤖 Model Management
Manage AI models and embeddings effectively.
- Embedding model selection
- Custom embedding functions
- Model performance optimization
- Version management strategies
🚀 Production Migration Guide
Best practices for production deployment.
- Environment transition strategies
- Data migration techniques
- Performance monitoring setup
- Scaling considerations
🔌 Service Identification
Track and manage data from multiple services.
- Service-based data organization
- Cross-service search capabilities
- Data source attribution
- Integration patterns
📦 Optional Model Bundling
Optimize bundle size with selective model loading.
- Bundle size optimization
- Conditional model loading
- Performance trade-offs
- Deployment strategies
🎯 How to Use These Guides
For New Users
- Start with Search and Metadata Guide to understand core search concepts
- Review JSON Document Search for working with structured data
- Check Cache Configuration for performance optimization
For Production Deployments
- Read Production Migration Guide for deployment best practices
- Implement Write-Only Mode for high-throughput scenarios
- Configure Model Management for optimal AI model usage
For Advanced Use Cases
- Master HNSW Field Search for specialized search patterns
- Implement Service Identification for multi-service architectures
- Optimize with Optional Model Bundling for specific deployment needs
🔗 Related Documentation
- Getting Started - Basic setup and first steps
- Optimization Guides - Performance and scaling
- API Reference - Complete API documentation
- Examples - Practical code examples
💡 Pro Tips
- Read Guides in Order: Each guide builds on concepts from previous ones
- Test Examples: All guides include working code examples
- Check Performance: Monitor metrics after implementing guide recommendations
- Stay Updated: Guides are updated with new features and best practices
🆘 Need Help?
- Troubleshooting - Common issues and solutions
- GitHub Issues - Report bugs or request features
- GitHub Discussions - Community support and questions