HeliosDB User Documentation Index
Multi-Model Database Server
Quick Navigation
| I Want To⦠| Go To |
|---|---|
| Get started quickly | Quick Start Guide |
| Deploy to production | Production Deployment |
| Migrate from PostgreSQL | PostgreSQL Migration |
| Migrate from MongoDB | MongoDB Migration |
| Migrate from Oracle | Oracle Migration |
| Use AI/ML features | AI Features |
| Optimize performance | Performance Tuning |
| Configure security | Security Reference |
| Scale the database | Scaling Operations Runbook |
1. Getting Started
First Steps
- Quick Start Guide - 5-minute setup
- Getting Started - Comprehensive introduction
- Configuration Guide - System configuration
- Configuration Quick Reference
- Connecting to HeliosDB - Connection methods and clients
- Data Types Reference - Supported data types
Installation & Deployment
- Docker Deployment - Container setup
- Production Deployment - Full production guide
- Deployment Runbook - Operational procedures
Tutorials
2. Protocols & Migration
Production SQL Protocols
- PostgreSQL 17 - 100% wire protocol compatible (Primary)
- MySQL - 90%+ wire protocol v10 compatible
- Snowflake - planned (the HTTP gateway answers
/snowflake/with 501 today) - SQL Commands 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
- ClickHouse - planned (no listener today)
API Protocols
- GraphQL - Full GraphQL with subscriptions and federation
- HTTP/REST - RESTful API with OpenAPI 3.0 spec
Oracle Compatibility
- Oracle 23ai Compatibility Guide - what the Oracle listener runs today and what to rewrite
- 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 |
| MongoDB | Migration Guide |
| Cassandra | Migration Guide |
| Oracle | Migration Guide |
| Redis | Migration Guide |
| MySQL | Migration Guide |
| SQL Server | Migration Guide |
| SQLite | Migration Guide |
- Migration Toolkit Guide - Comprehensive migration tools
- Migration Overview
- Zero-Code Developer Guide - Zero-code protocol migration
3. Core Features
SQL & Transactions
- Transactions User Guide - Comprehensive transaction guide
- EXPLAIN Plan Guide - Query analysis and optimization
- SQL Command Extensions
- Query Optimization
MVCC (Multi-Version Concurrency Control)
Storage & Indexing
- Index Types Comparison - B-Tree, LSM-Tree, hybrid indexes
- Compaction Strategy Guide
- LSM Tuning Guide
Time-Travel & Historical Queries
- Time-Travel Debugging Guide - Historical data queries
4. Advanced Features
Time-Series Data
Vector Search & Embeddings
- Multimodal Vector Search - 8-modality support
- HNSW indexing with 99%+ recall
Materialized Views
Automated ETL
Graph & GraphRAG
Full-Text Search
Geospatial
Sharding & Multi-Region
Streaming & Real-Time Analytics
Change Data Capture (CDC)
5. AI/ML Features
Natural Language Queries
- Performance Optimization
- Production Deployment
- SQL-Native RAG - Retrieval-augmented generation
- NL2SQL User Guide
Machine Learning Integration
- Federated Learning Guide - Privacy-preserving ML
- Advanced ML Integration Guide
- AI Schema Architect - AI-powered schema design
- Tier 2/3 AI/ML User Guide - Neural planner, schema AI, RL cache, and more
Blockchain & CRDT
6. Operations & Administration
Operational Runbooks
| Runbook | Description |
|---|---|
| Scaling Operations | Horizontal and vertical scaling procedures |
| Multi-Region Replication | Cross-region replication setup and management |
| Point-in-Time Recovery (PITR) | Backup and recovery procedures |
| Schema Evolution | Online schema changes and migrations |
| Backup & Restore | Backup and restore operations |
| Database Maintenance | Routine maintenance tasks |
| Incident Response | Incident handling procedures |
| Performance Troubleshooting | Performance issue diagnosis |
| GPU Operations | GPU resource management |
| Multi-Region Operations | Multi-region deployment operations |
High Availability
- High Availability Operational Procedures
- Multi-Master Replication Operations
- 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 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
Monitoring & Health
Multi-Tenancy
Autonomous Operations
7. Performance Tuning
Query Optimization
Performance Guides
- Performance Tuning Guide - Comprehensive tuning
- Performance Tuning Playbook
- Quantum Optimization Guide
SIMD & Hardware Optimization
Caching & Connection Pooling
Resource Management
- Workload Management Guide - Query scheduling and SLA enforcement
- Resource Limits Reference
- Resource Leak Prevention
- Deadlock Prevention Operations Guide
Workload Management Components
8. Security
Security Configuration
Authentication & Authorization
SQL Injection Protection
Data Protection
Encryption
- TLS 1.3 in transit
- AES-256 at rest
- Homomorphic encryption (beta)
- Post-quantum cryptography ready
Compliance
- 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
- 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
Client Libraries
Storage Attribution
Edge Computing
10. Multi-Model Data
Document Store
Data Quality
11. Reference Documentation
Quick References by Category
- Quick Starts Index - All quick start guides
Architecture & Design
FAQ & Troubleshooting
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; 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