Skip to content
HeliosDB HeliosDB Full

HeliosDB Complete Documentation Index

HeliosDB Complete Documentation Index

Version 3.0 - Enterprise-Grade Distributed HTAP Database

This is the complete consolidated documentation for HeliosDB, organized into logical categories for easy navigation.

Documentation Organization

All documentation is organized across multiple directories:

Table of Contents

1. Getting Started

Start here for quick installation, setup, and first steps with HeliosDB.

DocumentDescription
Main READMEProject overview and feature list
Quick StartGet running in 5 minutes
Quick Start RecoveryRecovery quick reference
Quick ReferenceCommand quick reference
Quickstart IndexQuickstart documentation index
Getting Started DetailedDetailed getting started guide
User Guide - Getting StartedUser-focused getting started
CLI Quick StartCommand-line interface quick start
Protocols Quick StartMulti-protocol quick start
Vector Quick StartVector search quick start
Geospatial Quick StartGeospatial features quick start
Java Quick StartJava client quick start
Tools Quick StartDevelopment tools quick start
Backup Quick StartBackup/restore quick start
Online Aggregation Quick StartOnline aggregation quick start
Arrow Flight Quick StartArrow Flight quick start
Tutorial Quick StartTutorial quick start

Total Files: 17

2. Architecture & Design

Deep dive into HeliosDB’s architecture, design principles, and system internals.

DocumentDescription
Main ArchitectureCore system architecture
ConfigurationSystem configuration guide
Series A Roadmapv5.5 and v6.0 roadmap

Available Files: 3 (See implementation plans for detailed architecture docs)

3. User Guide

Comprehensive guides for using HeliosDB features and capabilities.

DocumentDescription
ConnectingConnection methods and protocols
Data TypesSupported data types
QueryingQuery syntax and examples
ShardingUsing sharded tables
Vector SearchVector similarity search guide
TutorialStep-by-step tutorial
PostgreSQL Client GuideUsing psql with HeliosDB
Complete GuideComprehensive user guide
How-To IndexHow-to documentation index
Python Implementation GuidePython client implementation
Python Quick ReferencePython client quick reference
CLI Usage GuideCLI detailed usage guide
Test Execution GuideRunning tests
Feature Testing GuideTesting features
HNSW GuideHNSW vector index guide
IVF GuideIVF vector index guide

Total Files: 16

4. Operations

Deployment, configuration, monitoring, and operational procedures.

DocumentDescription
DeploymentDeployment procedures
ConfigurationConfiguration reference
MonitoringMonitoring and metrics
Backup & RecoveryBackup and recovery procedures
Deployment GuideDetailed deployment guide
Backup & RestoreBackup and restore operations
TroubleshootingCommon issues and solutions
MetricsMetrics and observability
Docker DeploymentDocker deployment guide
Docker Deployment READMEDocker deployment readme
Docker Deployment StatusDocker deployment status
Docker StatusDocker status
Helm READMEKubernetes Helm charts
Prometheus MetricsPrometheus metrics implementation
Dashboards READMEGrafana dashboards
ODBC Build InstructionsBuilding ODBC driver

Total Files: 16

5. Implementation Plans

Detailed implementation plans for v5.5 and v6.0 features.

v5.5 Implementation (15 Features)

DocumentDescription
Phase 1 - Developer ExperienceNL2SQL, Vector Search, Git Branching, etc.
Phase 2 - Distributed SystemsMulti-Master CRDT, Edge Caching, Query Routing
Phase 3 - Autonomous OperationsSelf-Healing, Autonomous Tuning, Conversational DBA

v6.0 Implementation (20 Features)

DocumentDescription
Phase 1 - Lakehouse & PlatformIceberg, Delta Lake, Unified Catalog
Phase 2 - AI/ML IntegrationRAG, Embeddings, ML Training
Phase 3 - ExtensibilityWASM, GraphQL, Zero-Code Apps
Phase 4 - Launch PreparationSecurity, Compliance, Hardening

See Implementation Index for complete feature list.

6. User Guides by Version

Feature-specific user guides organized by version.

v3-v4 Features (20 guides)

v5 Features (51 guides)

Developer Experience
Autonomous Operations
Privacy & Security
Distributed Systems

And 37 more features…

7. Series A & Business Materials

Investor materials, financial models, and business documentation.

DocumentDescription
One PagerExecutive summary
Elevator Pitch60-second pitch
Pitch DeckFull investor presentation
Investor PresentationDetailed presentation
Database ValuationMarket analysis & valuation
18-Month Financial ModelRevenue projections
Investor Meeting Schedule12-week meeting plan

Total Files: 7

8. Analysis & Research

Technical analysis, feature audits, and research reports.

DocumentDescription
Master Feature AuditComplete feature inventory
Audit Executive SummaryHigh-level audit summary
Patent Research ReportPatent analysis
v5.5/v6.0 RoadmapProduct roadmap
v5.5 Implementation Phasesv5.5 planning
v6.0 Implementation Phasesv6.0 planning

Total Files: 6

9. Archives

Historical documentation, completed deliverables, and archived materials.

DocumentDescription
DeliverablesProject deliverables
Documentation SummaryDocumentation summary
Final SummaryArchived final summary
Project StatusHistorical project status
Protocol IntegrationProtocol integration summary
Session ReportsHive Mind session reports

Total Files: 10+

10. Additional Resources

DocumentDescription
Link Validation SummaryDocumentation link health
Reorganization SummaryDocumentation reorganization notes
Phase Execution GuideImplementation phase guide

Total Files: 3

Summary Statistics

CategoryFile CountDescription
Getting Started17Quick starts and initial setup
Architecture & Design3Core architecture docs
User Guide16General user guides
Operations16Deployment and operations
Implementation Plans58v5.5 and v6.0 feature specs
User Guides (v3-v4)20Version 3-4 feature guides
User Guides (v5)51Version 5 feature guides
Series A Materials7Business & investor docs
Analysis & Research6Technical analysis
Archives10+Historical documentation
TOTAL200+Complete documentation set

Essential Reading

Implementation & Roadmap

Operations

Series A Materials

Documentation Organization

All documentation is in Markdown format organized as follows:

  • docs/guides/ - User guides, quickstarts, and operations
  • docs/user-guides/ - Version-specific feature guides (v3-v4, v5)
  • docs/implementation/ - v5.5 and v6.0 implementation plans
  • docs/series-a/ - Business and investor materials
  • docs/analysis/ - Technical analysis and research
  • docs/archive/ - Historical documentation

All internal links use relative paths suitable for GitHub viewing.

Contributing to Documentation

  1. Edit Markdown Files: Find the appropriate file in the directory structure
  2. Test Links: Ensure all relative links work
  3. Update Indexes: Update relevant index files if adding new documents
  4. Submit PR: Include description of changes

License

Documentation is licensed under Apache-2.0, same as the HeliosDB project.

HeliosDB v3.0 - The Universal Data Platform

Complete Documentation - 219 Files Across 10 Categories