--- title: "HeliosDB User Documentation Index" --- # HeliosDB User Documentation Index ## Multi-Model Database Server --- ## Quick Navigation | I Want To... | Go To | |--------------|-------| | **Get started quickly** | [Quick Start Guide](https://www.heliosdb.com/docs/full/quick-starts/getting-started/quickstart/) | | **Deploy to production** | [Production Deployment](https://www.heliosdb.com/docs/full/quick-starts/deployment/production_deployment_guide/) | | **Migrate from PostgreSQL** | [PostgreSQL Migration](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_postgresql_to_heliosdb/) | | **Migrate from MongoDB** | [MongoDB Migration](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_mongodb_to_heliosdb/) | | **Migrate from Oracle** | [Oracle Migration](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_oracle_to_heliosdb/) | | **Use AI/ML features** | [AI Features](#5-aiml-features) | | **Optimize performance** | [Performance Tuning](https://www.heliosdb.com/docs/full/guides/user/performance_tuning_guide/) | | **Configure security** | Security Reference | | **Scale the database** | [Scaling Operations Runbook](https://www.heliosdb.com/docs/full/operations/runbooks/scaling_operations_runbook/) | --- ## 1. Getting Started ### First Steps - [Quick Start Guide](https://www.heliosdb.com/docs/full/quick-starts/getting-started/quickstart/) - 5-minute setup - [Getting Started](https://www.heliosdb.com/docs/full/quick-starts/getting-started/getting_started/) - Comprehensive introduction - [Configuration Guide](https://www.heliosdb.com/docs/full/guides/user/configuration_guide/) - System configuration - [Configuration Quick Reference](https://www.heliosdb.com/docs/full/quick-starts/getting-started/configuration_quick_reference/) - [Connecting to HeliosDB](https://www.heliosdb.com/docs/full/guides/user/connecting/) - Connection methods and clients - [Data Types Reference](https://www.heliosdb.com/docs/full/guides/user/data_types/) - Supported data types ### Installation & Deployment - [Docker Deployment](https://www.heliosdb.com/docs/full/quick-starts/deployment/docker_deployment_guide/) - Container setup - [Production Deployment](https://www.heliosdb.com/docs/full/quick-starts/deployment/production_deployment_guide/) - Full production guide - [Deployment Runbook](https://www.heliosdb.com/docs/full/operations/runbooks/deployment_runbook/) - Operational procedures ### Tutorials --- ## 2. Protocols & Migration ### Production SQL Protocols - **PostgreSQL 17** - 100% wire protocol compatible (Primary) - [Advisory Locks Guide](https://www.heliosdb.com/docs/full/guides/user/postgresql_17_advisory_locks_guide/) - **MySQL** - 90%+ wire protocol v10 compatible - **Snowflake** - planned (the HTTP gateway answers `/snowflake/` with 501 today) - [SQL Commands Reference](https://www.heliosdb.com/docs/full/quick-starts/protocols/sql_commands_quick_reference/) ### NoSQL Protocols - **MongoDB** - listener connects and authenticates (SCRAM-SHA-256); reads and writes of HeliosDB tables are planned; GridFS and capped collections are planned - **Redis** - RESP listener with an in-memory keyspace that is not persisted - **Cassandra CQL** - listener connects and authenticates; reads and writes of HeliosDB tables and DataStax-driver connections are planned - [Cassandra Quick Start](https://www.heliosdb.com/docs/full/quick-starts/protocols/cassandra_quick_start/) - **ClickHouse** - planned (no listener today) - [ClickHouse Quick Start](https://www.heliosdb.com/docs/full/quick-starts/protocols/clickhouse_quick_start/) ### API Protocols - **GraphQL** - Full GraphQL with subscriptions and federation - [GraphQL Quick Start](https://www.heliosdb.com/docs/full/quick-starts/protocols/graphql_quick_start/) - **HTTP/REST** - RESTful API with OpenAPI 3.0 spec ### Oracle Compatibility - [Oracle 23ai Compatibility Guide](https://www.heliosdb.com/docs/full/guides/user/oracle_23ai_compatibility_guide/) - what the Oracle listener runs today and what to rewrite - [Oracle Quick Start](https://www.heliosdb.com/docs/full/quick-starts/protocols/oracle_quick_start/) - DBMS packages, hierarchical queries, PIVOT/UNPIVOT support; PL/SQL execution through the Oracle listener is on the roadmap ### Migration Guides | Source Database | Migration Guide | |-----------------|-----------------| | PostgreSQL | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_postgresql_to_heliosdb/) | | MongoDB | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_mongodb_to_heliosdb/) | | Cassandra | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_cassandra_to_heliosdb/) | | Oracle | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_oracle_to_heliosdb/) | | Redis | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_redis_to_heliosdb/) | | MySQL | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_mysql_to_heliosdb/) | | SQL Server | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_mssql_to_heliosdb/) | | SQLite | [Migration Guide](https://www.heliosdb.com/docs/full/reference/protocols/migrations/migration_from_sqlite_to_heliosdb/) | - [Migration Toolkit Guide](https://www.heliosdb.com/docs/full/migration/migration_toolkit_guide/) - Comprehensive migration tools - [Migration Overview](https://www.heliosdb.com/docs/full/reference/protocols/migration_guide/) - [Zero-Code Developer Guide](https://www.heliosdb.com/docs/full/guides/user/zero_code_developer_guide/) - Zero-code protocol migration --- ## 3. Core Features ### SQL & Transactions - [Transactions User Guide](https://www.heliosdb.com/docs/full/guides/user/transactions_user_guide/) - Comprehensive transaction guide - [EXPLAIN Plan Guide](https://www.heliosdb.com/docs/full/guides/user/explain_plan_guide/) - Query analysis and optimization - [SQL Command Extensions](https://www.heliosdb.com/docs/full/features/sql-interface/sql_command_extensions/) - [Query Optimization](https://www.heliosdb.com/docs/full/features/advanced/14-query-optimization/) ### MVCC (Multi-Version Concurrency Control) - [MVCC Configuration Guide](https://www.heliosdb.com/docs/full/features/mvcc/mvcc_configuration_guide/) - [MVCC Quick Start](https://www.heliosdb.com/docs/full/quick-starts/features/mvcc_quick_start/) - [Transaction Isolation Levels](https://www.heliosdb.com/docs/full/features/advanced/01-transaction-isolation/) ### Storage & Indexing - [Index Types Comparison](https://www.heliosdb.com/docs/full/quick-starts/performance/index_types_comparison/) - B-Tree, LSM-Tree, hybrid indexes - [Compaction Strategy Guide](https://www.heliosdb.com/docs/full/features/storage/compaction_strategy_guide/) - [LSM Tuning Guide](https://www.heliosdb.com/docs/full/features/storage/lsm_tuning_guide/) ### Time-Travel & Historical Queries - [Time-Travel Debugging Guide](https://www.heliosdb.com/docs/full/guides/user/time_travel_debugging_user_guide/) - Historical data queries --- ## 4. Advanced Features ### Time-Series Data ### Vector Search & Embeddings - [Multimodal Vector Search](https://www.heliosdb.com/docs/full/guides/user/multimodal_vector_search_user_guide/) - 8-modality support - HNSW indexing with 99%+ recall ### Materialized Views - [Materialized Views Runbook](https://www.heliosdb.com/docs/full/operations/runbooks/materialized_views_runbook/) ### Automated ETL ### Graph & GraphRAG - [GraphRAG User Guide](https://www.heliosdb.com/docs/full/features/graphrag/user_guide/) - [GraphRAG Quick Start](https://www.heliosdb.com/docs/full/quick-starts/features/graphrag_quick_start/) - [Cypher Reference](https://www.heliosdb.com/docs/full/features/graphrag/cypher_reference/) - [Neo4j Migration Guide](https://www.heliosdb.com/docs/full/features/graphrag/neo4j_migration_guide/) ### Full-Text Search - [Full-Text Search Tuning Guide](https://www.heliosdb.com/docs/full/guides/user/full_text_search_tuning_guide/) ### Geospatial - [Geospatial Operations Guide](https://www.heliosdb.com/docs/full/guides/user/geospatial_operations_guide/) ### Sharding & Multi-Region - [Sharding Strategy Decision Guide](https://www.heliosdb.com/docs/full/guides/user/sharding_strategy_decision_guide/) - [Multi-Cloud Federation Guide](https://www.heliosdb.com/docs/full/guides/user/multi_cloud_federation_guide/) ### Streaming & Real-Time Analytics ### Change Data Capture (CDC) --- ## 5. AI/ML Features ### Natural Language Queries - [Performance Optimization](https://www.heliosdb.com/docs/full/guides/user/conversational_bi_performance_optimization_guide/) - [Production Deployment](https://www.heliosdb.com/docs/full/guides/user/conversational_bi_production_deployment/) - [SQL-Native RAG](https://www.heliosdb.com/docs/full/guides/user/sql_native_rag_user_guide/) - Retrieval-augmented generation - [NL2SQL User Guide](https://www.heliosdb.com/docs/full/features/nl2sql/nl2sql_user_guide/) ### Machine Learning Integration - [Federated Learning Guide](https://www.heliosdb.com/docs/full/guides/user/federated_learning_user_guide/) - Privacy-preserving ML - [Advanced ML Integration Guide](https://www.heliosdb.com/docs/full/guides/user/advanced_ml_integration_guide/) - [AI Schema Architect](https://www.heliosdb.com/docs/full/guides/user/ai_schema_architect_user_guide/) - AI-powered schema design - [Tier 2/3 AI/ML User Guide](https://www.heliosdb.com/docs/full/guides/user/tier2_tier3_ai_ml_user_guide/) - Neural planner, schema AI, RL cache, and more ### Blockchain & CRDT --- ## 6. Operations & Administration ### Operational Runbooks | Runbook | Description | |---------|-------------| | [Scaling Operations](https://www.heliosdb.com/docs/full/operations/runbooks/scaling_operations_runbook/) | Horizontal and vertical scaling procedures | | [Multi-Region Replication](https://www.heliosdb.com/docs/full/operations/runbooks/multi_region_operations_runbook/) | Cross-region replication setup and management | | [Point-in-Time Recovery (PITR)](https://www.heliosdb.com/docs/full/operations/runbooks/backup_restore_runbook/) | Backup and recovery procedures | | [Schema Evolution](https://www.heliosdb.com/docs/full/operations/runbooks/schema_evolution_runbook/) | Online schema changes and migrations | | [Backup & Restore](https://www.heliosdb.com/docs/full/operations/runbooks/backup_restore_runbook/) | Backup and restore operations | | [Database Maintenance](https://www.heliosdb.com/docs/full/operations/runbooks/database_maintenance_runbook/) | Routine maintenance tasks | | [Incident Response](https://www.heliosdb.com/docs/full/operations/runbooks/incident_response_runbook/) | Incident handling procedures | | [Performance Troubleshooting](https://www.heliosdb.com/docs/full/operations/runbooks/performance_troubleshooting_runbook/) | Performance issue diagnosis | | [GPU Operations](https://www.heliosdb.com/docs/full/operations/runbooks/gpu_operations_runbook/) | GPU resource management | | [Multi-Region Operations](https://www.heliosdb.com/docs/full/operations/runbooks/multi_region_operations_runbook/) | Multi-region deployment operations | ### High Availability - [High Availability Operational Procedures](https://www.heliosdb.com/docs/full/guides/user/high_availability_operational_procedures/) - [Multi-Master Replication Operations](https://www.heliosdb.com/docs/full/guides/user/multi_master_replication_operations/) - [Replication Operations Guide](https://www.heliosdb.com/docs/full/guides/user/replication_operations_guide/) - HeliosDB Full runs as a single server. Multi-region replication and automatic failover are planned with Full clustering, so the replication guides above describe planned features. - Placed in front of Full, [HeliosProxy](/docs/proxy/) reconnects sessions, restores tracked SET state and, depending on `tr_mode`, replays safe reads or an uncommitted transaction; a COMMIT with unknown outcome is not retried. Session migration and cursor restore are planned. ### Backup & Recovery - [Backup & Recovery Guide](https://www.heliosdb.com/docs/full/guides/user/backup_recovery_guide/) - [PITR Runbook](https://www.heliosdb.com/docs/full/operations/runbooks/backup_restore_runbook/) - [Backup Encryption Guide](https://www.heliosdb.com/docs/full/guides/user/backup_encryption_consumer_protection_guide/) ### Monitoring & Health - [Health Check Guide](https://www.heliosdb.com/docs/full/user/operations/health_check_guide/) - [Incident Response](https://www.heliosdb.com/docs/full/operations/runbooks/incident_response_runbook/) ### Multi-Tenancy ### Autonomous Operations - [Autonomous Database Operations Guide](https://www.heliosdb.com/docs/full/guides/user/autonomous_database_operations_guide/) --- ## 7. Performance Tuning ### Query Optimization - [Query Optimization Troubleshooting](https://www.heliosdb.com/docs/full/guides/user/query_optimization_troubleshooting_guide/) - [Query Optimization Reference](https://www.heliosdb.com/docs/full/features/advanced/14-query-optimization/) ### Performance Guides - [Performance Tuning Guide](https://www.heliosdb.com/docs/full/guides/user/performance_tuning_guide/) - Comprehensive tuning - [Performance Tuning Playbook](https://www.heliosdb.com/docs/full/guides/user/performance_tuning_playbook/) - [Quantum Optimization Guide](https://www.heliosdb.com/docs/full/guides/user/quantum_optimization_guide/) ### SIMD & Hardware Optimization - [SIMD Quick Reference](https://www.heliosdb.com/docs/full/quick-starts/performance/simd_quick_reference/) ### Caching & Connection Pooling - [Caching Configuration Guide](https://www.heliosdb.com/docs/full/guides/user/caching_configuration_guide/) ### Resource Management - [Workload Management Guide](https://www.heliosdb.com/docs/full/guides/user/workload_management_user_guide/) - Query scheduling and SLA enforcement - [Resource Limits Reference](https://www.heliosdb.com/docs/full/quick-starts/performance/resource_limits_reference/) - [Resource Leak Prevention](https://www.heliosdb.com/docs/full/quick-starts/performance/resource_leak_prevention_quick_reference/) - [Deadlock Prevention Operations Guide](https://www.heliosdb.com/docs/full/guides/user/deadlock_prevention_operations_guide/) ### Workload Management Components - [Admission Control](https://www.heliosdb.com/docs/full/features/workload-management/admission_control/) - [Graceful Degradation](https://www.heliosdb.com/docs/full/features/workload-management/graceful_degradation/) - [Query Scheduler](https://www.heliosdb.com/docs/full/features/workload-management/query_scheduler/) - [Resource Manager](https://www.heliosdb.com/docs/full/features/workload-management/resource_manager/) --- ## 8. Security ### Security Configuration - [Security Best Practices (full guide)](https://www.heliosdb.com/docs/full/features/security/security-best-practices/) - [Security Quick Start](https://www.heliosdb.com/docs/full/quick-starts/features/security_quick_start/) - [Security Best Practices](https://www.heliosdb.com/docs/full/features/advanced/15-security-best-practices/) ### Authentication & Authorization - [Key Management](https://www.heliosdb.com/docs/full/quick-starts/security/key_management/) ### SQL Injection Protection ### Data Protection - [Data Masking & PII Quick Start](https://www.heliosdb.com/docs/full/quick-starts/security/data_masking_pii_quick_start/) - [Column-Level Encryption](https://www.heliosdb.com/docs/full/features/encryption/column_level_encryption/) ### Encryption - TLS 1.3 in transit - AES-256 at rest - Homomorphic encryption (beta) - Post-quantum cryptography ready ### Compliance - [Backup Encryption Regulatory Compliance Matrix](https://www.heliosdb.com/docs/full/guides/user/backup_encryption_regulatory_compliance_matrix/) - SOC 2 Type II ready - GDPR compliant - HIPAA compliant - PCI-DSS ready --- ## 9. Integrations ### Cloud & Data Catalogs - [Lakehouse Integration Guide](https://www.heliosdb.com/docs/full/guides/user/lakehouse_integration_user_guide/) - AWS, GCP, Azure native integrations - Apache Iceberg and Delta Lake support (planned) ### Streaming & CDC - Change-event log (`SHOW CDC EVENTS`); CDC connectors planned - Kafka and Pulsar integration (planned) ### External Data - [Federation Quick Start](https://www.heliosdb.com/docs/full/quick-starts/features/federation_quick_start/) ### Client Libraries - [Python Client](https://www.heliosdb.com/docs/full/features/packages/27-python-client-readme/) - [Java Client](https://www.heliosdb.com/docs/full/features/packages/28-java-client-readme/) - [ODBC Driver](https://www.heliosdb.com/docs/full/features/packages/29-odbc-driver-readme/) ### Storage Attribution ### Edge Computing --- ## 10. Multi-Model Data ### Document Store - [Document Store Guide](https://www.heliosdb.com/docs/full/guides/user/document_store_guide/) - [Multi-Model Data Guide](https://www.heliosdb.com/docs/full/guides/user/multi_model_data_guide/) ### Data Quality - [Data Quality Management Guide](https://www.heliosdb.com/docs/full/guides/user/data_quality_management_guide/) --- ## 11. Reference Documentation ### Quick References by Category - [Quick Starts Index](https://www.heliosdb.com/docs/full/quick-starts/readme/) - All quick start guides ### Architecture & Design ### FAQ & Troubleshooting - [Frequently Asked Questions](https://www.heliosdb.com/docs/full/guides/user/faq/) --- ## Feature Highlights ### Highlighted Capabilities | Capability | Status | |------------|--------| | Quantum-Inspired Query Optimization | Planned | | Neuromorphic Pattern Recognition | Planned | | Cognitive Database Agents | Planned | | WASM Polyglot Procedures | Planned | | ML-Based Self-Healing | Planned | | Agentic NL2SQL | Planned | | Homomorphic Encryption | Planned | | Federated Learning | Planned | | GPU Query Engine | NVIDIA CUDA in builds on request; not enabled in the public release build (ROCm planned) | | Multi-Protocol Gateway | 7 database wire protocols + HTTP gateway (MongoDB, Cassandra and SQL Server table access planned) | | Oracle 23ai Compatibility | Core data access over the Oracle listener; Oracle-specific syntax and PL/SQL partly need rewriting | | WASM Edge Computing | Planned | ### Performance Benchmarks Benchmark figures measured on representative fixtures are published on [benchmarks](https://www.heliosdb.com/benchmarks.html); reproduce them on your own hardware before relying on them. HeliosDB Full runs as a single server, so clustering and availability targets are planned, and so are graph traversal SQL functions. --- ## Support ### Feedback - Documentation feedback: support@heliosdb.com --- **HeliosDB** - AI-assisted, multi-model distributed database