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. |
||
|---|---|---|
| .. | ||
| api-reference | ||
| archive | ||
| development | ||
| examples | ||
| getting-started | ||
| guides | ||
| optimization-guides | ||
| technical | ||
| tools/claude-commit | ||
| user-guides | ||
| brainy-distributed-enhancements-revised.md | ||
| brainy-distributed-enhancements.md | ||
| distributed-deployment-scenario.md | ||
| distributed-usage-guide.md | ||
| docker-deployment.md | ||
| PERFORMANCE_AND_LOGGING_FIXES.md | ||
| PERFORMANCE_FEATURES.md | ||
| quick-start-docker.md | ||
| README.md | ||
| STORAGE_MIGRATION_GUIDE.md | ||
Brainy Documentation
Welcome to the comprehensive documentation for Brainy - the intelligent vector graph database with zero-configuration setup and production-scale performance.
📚 Documentation Structure
🚀 Getting Started
Quick setup guides and first steps with Brainy.
- Quick Start Guide - Get up and running in minutes
- Installation Guide - Installation options and requirements
- Environment Setup - Configure your development environment
- First Steps - Your first Brainy application
📖 User Guides
Comprehensive guides for using Brainy features.
- Search and Metadata Guide - Advanced search techniques
- Write-Only Mode - Optimized data ingestion
- Read-Only & Frozen Modes - Immutability control for production
- Cache Configuration - Memory and caching optimization
- JSON Document Search - Searching within JSON documents
- HNSW Field Search - Field-specific vector search
- Model Management - Managing AI models and embeddings
- Production Migration - Moving to production
⚡ Optimization Guides
Performance optimization and scaling strategies.
- Large-Scale Optimizations - Enterprise-grade performance
- Auto-Configuration System - Zero-config intelligence
- Semantic Partitioning - Intelligent data clustering
- Distributed Search - Parallel processing
- Memory Optimization - Efficient memory usage
- Storage Optimization - S3 and storage strategies
- S3 Migration Guide - Migrating existing data with shared buckets
🔧 API Reference
Complete API documentation and examples.
- Core API - Main BrainyData class methods
- Vector Operations - Vector storage and search
- Graph Operations - Noun and verb relationships
- Configuration API - System configuration options
- Storage Adapters - Storage backend interfaces
- Augmentations API - Extension system
🛠️ Development
Development, testing, and contribution guides.
- Developer Guide - Setting up development environment
- Testing Guide - Running and writing tests
- Documentation Standards - Documentation conventions
- Publishing CLI - CLI package publishing
- Expected Test Messages - Test output reference
🔬 Technical Reference
Deep technical documentation and implementation details.
- Technical Guides Overview - Technical documentation index
- Architecture - System architecture overview
- HNSW Implementation - Vector index details
- Threading - Multi-threading implementation
- Storage Systems - Storage architecture
- Performance Analysis - Performance benchmarks
- Compatibility - Platform compatibility matrix
💡 Examples
Code examples and tutorials.
- Basic Usage - Simple examples to get started
- Advanced Patterns - Complex use cases
- Integration Examples - Third-party integrations
- Performance Examples - Optimization examples
🔍 Troubleshooting
Common issues and solutions.
- Common Issues - Frequently encountered problems
- Performance Issues - Performance troubleshooting
- Environment Issues - Platform-specific problems
- Error Messages - Error code reference
🗺️ Quick Navigation
New to Brainy?
- Installation Guide - Install Brainy
- Quick Start Guide - Your first vector database
- Basic Usage Examples - Simple code examples
Need Performance?
- Large-Scale Optimizations - Enterprise features
- Auto-Configuration - Zero-config setup
- Performance Examples - Optimization patterns
Building Applications?
- API Reference - Complete API documentation
- User Guides - Feature documentation
- Integration Examples - Real-world usage
Contributing?
- Developer Guide - Development setup
- Documentation Standards - Writing docs
- Testing Guide - Testing practices
🔄 Recently Updated
- S3 Migration Guide - NEW: Complete migration guide for shared S3 buckets
- Large-Scale Optimizations - Complete rewrite with auto-configuration
- Quick Start Guide - Updated with zero-config setup
- API Reference - New auto-configuration APIs
📞 Getting Help
- GitHub Issues - Bug reports and feature requests
- Discussions - Community support
- Examples - Code examples and tutorials
📝 Note: This documentation is automatically organized and regularly updated. All guides include practical examples and are tested with the latest version of Brainy.