Skip to content

HeliosDB v4.0 User Guides

HeliosDB v4.0 User Guides

Complete tutorial-style guides for all 12 breakthrough features in HeliosDB v4.0.

Overview

HeliosDB v4.0 introduces 12 innovative features that bring serverless scalability, advanced storage optimization, and enterprise-grade distributed database capabilities. This collection provides comprehensive, beginner-friendly guides with step-by-step instructions, SQL examples, troubleshooting tips, and best practices.

Feature Categories

Serverless & Scaling (Tier 1)

Core Innovation: Scale from 0 to maximum compute instantly while only paying for what you use.

  1. Git-Style Database Branching

    • Instant zero-copy database branches
    • Time-travel queries
    • Development/testing isolation
    • Branch creation: <1ms, zero storage overhead
  2. Scale-to-Zero Serverless Compute

    • Automatic suspend/resume
    • Sub-300ms resume time
    • 50-90% cost savings
    • Transparent to applications
  3. Dynamic Autoscaling (0-to-Max CU)

    • Real-time resource adjustment
    • Sub-10s scale-up, sub-60s scale-down
    • Intelligent damping (no oscillation)
    • 28%+ cost optimization

Distribution & High Availability (Tier 1)

Core Innovation: Query any node, automatic routing, and intelligent rebalancing.

  1. Query from Any Node

    • Connect to any cluster node
    • Automatic query routing
    • Load balancing
    • No single point of failure
  2. Smart Data Rebalancing

    • Automatic load balancing
    • Zero-downtime redistribution
    • Bandwidth throttling
    • Capacity and access-based strategies

Advanced Storage (Tier 2)

Core Innovation: Intelligent multi-tier storage and compression.

  1. Hybrid Columnar Compression (HCC)
    • 3-10x compression ratios
    • Oracle Exadata-style compression
    • Multiple algorithms (ZSTD, LZ4, Snappy)
    • Configurable per table/column

Sharding & Multi-Tenancy (Tier 2)

Core Innovation: Advanced sharding with tenant isolation.

  1. Schema-Based Sharding

    • Shard by schema/tenant
    • Perfect data isolation
    • Independent scaling per tenant
    • Compliance-friendly
  2. Distributed Foreign Keys

    • Cross-shard referential integrity
    • 2PC for ACID guarantees
    • Transparent FK validation
    • Multiple validation modes

Storage Optimization (Tier 3)

Core Innovation: Cost-optimized multi-tier storage.

  1. 3-Tier Storage (Hot/Warm/Cold)

    • NVMe (hot) / SATA (warm) / S3 (cold)
    • 80%+ cost reduction for 100TB+ databases
    • Automatic tiering policies
    • Sub-ms to 50ms latency tiers
  2. Safekeeper WAL Service

    • Dedicated fault-tolerant WAL storage
    • Instant compute recovery
    • Compute-storage separation
    • 3+ replica durability

Online Operations (Tier 3)

Core Innovation: Zero-downtime schema and infrastructure changes.

  1. Online Schema & Shard Changes

    • Zero-downtime shard key changes
    • Online shard splits
    • No application modifications
    • Automatic migration and validation
  2. Tenant Resource Quotas

    • Per-tenant CPU/memory/storage limits
    • QoS tiers (bronze/silver/gold)
    • Fair resource allocation
    • Usage tracking and billing

Quick Start

Choose Your Path

For Developers:

  1. Start with Branching - Create isolated dev environments
  2. Then Autoscaling - Optimize dev/staging costs
  3. Finally Tiered Storage - Reduce storage costs

For DBAs:

  1. Start with Query Routing - Understand distributed architecture
  2. Then Rebalancing - Maintain cluster health
  3. Finally Online Sharding - Scale without downtime

For SaaS Builders:

  1. Start with Schema Sharding - Tenant isolation
  2. Then Resource Quotas - Fair resource allocation
  3. Finally Distributed FK - Cross-tenant integrity

For Cost Optimization:

  1. Start with Scale-to-Zero - Eliminate idle costs
  2. Then Tiered Storage - 80% storage savings
  3. Finally Autoscaling - Dynamic right-sizing

Feature Matrix

FeatureComplexitySetup TimeCost ImpactProduction Ready
BranchingLow5 min0-10% storageYes
Scale-to-ZeroMedium15 min50-90% savingsYes
AutoscalingMedium20 min28%+ savingsYes
Query RoutingLow10 minNeutralYes
RebalancingLow10 minNeutralYes
CompressionLow5 min3-10x storageYes
Schema ShardingMedium30 minNeutralYes
Distributed FKHigh45 minSlight overheadYes
Tiered StorageHigh1 hour80%+ savingsYes
SafekeeperMedium30 minSlight increaseYes
Online ShardingHigh1 hourNeutralYes
QuotasMedium20 minRevenue protectionYes

Common Workflows

Development Environment Setup

Terminal window
# 1. Enable branching for feature isolation
heliosdb-cli config set branching.enabled=true
# 2. Enable autoscaling with scale-to-zero
heliosdb-cli config set autoscaling.min_cu=0.0
# 3. Create dev branch
heliosdb-cli branch create dev/feature-auth
# 4. Work in isolation, auto-suspends after 5min idle
# Cost: Near zero when not actively developing

Production Multi-Tenant SaaS

Terminal window
# 1. Enable schema-based sharding
heliosdb-cli config set sharding.strategy=schema_based
# 2. Configure resource quotas
heliosdb-cli quota create gold_tier cpu=50 memory=16GB
# 3. Enable distributed FK for referential integrity
heliosdb-cli config set distributed_fk.enabled=true
# 4. Set up tiered storage for cost optimization
heliosdb-cli tier configure hot=1TB warm=5TB cold=s3://bucket

Large-Scale Analytics

Terminal window
# 1. Enable tiered storage (archive old data to S3)
heliosdb-cli tier configure \
hot=2TB,7days \
warm=10TB,30days \
cold=s3://analytics-archive
# 2. Enable HCC compression
heliosdb-cli config set compression.default=zstd
# 3. Configure autoscaling for query workload
heliosdb-cli autoscale configure \
min=2.0 max=32.0 target_cpu=75
# Result: 80% storage savings + dynamic compute scaling

Performance Targets

Achieved in v4.0

MetricTargetAchievedStatus
Branch creation<100ms<1ms100x faster
Resume time<300ms~170ms43% faster
Scale-up time<10s<2s5x faster
Storage savings80%85%Exceeded
Cost reduction28%28%+Met

Troubleshooting

Common Issues

Feature Not Available:

-- Check HeliosDB version
SELECT version(); -- Must be v3.2+
-- Check feature enablement
SELECT * FROM heliosdb.features WHERE enabled = true;

Performance Issues:

-- Check resource utilization
SELECT * FROM heliosdb.resource_usage;
-- Check autoscaling status
SELECT * FROM heliosdb.autoscale_status;
-- Check tier performance
SELECT * FROM heliosdb.tier_performance;

Configuration Problems:

Terminal window
# Validate configuration
heliosdb-cli config validate
# Check logs
tail -f /var/log/heliosdb/heliosdb.log
# Test connectivity
heliosdb-cli cluster status

Best Practices Summary

General Guidelines

  1. Start Conservative: Begin with default settings, tune based on metrics
  2. Monitor First: Observe for 1 week before optimization
  3. Test in Staging: Always validate changes in non-production first
  4. Document Changes: Keep track of configuration modifications
  5. Set Alerts: Configure Prometheus/Grafana alerts for critical metrics

Security Considerations

-- Restrict branch creation to admins
REVOKE EXECUTE ON FUNCTION heliosdb.create_branch FROM public;
GRANT EXECUTE ON FUNCTION heliosdb.create_branch TO admin_role;
-- Audit all configuration changes
CREATE TABLE config_audit (
timestamp TIMESTAMPTZ DEFAULT now(),
user_name TEXT,
parameter TEXT,
old_value TEXT,
new_value TEXT
);

Cost Optimization Checklist

  • Enable scale-to-zero for dev/staging
  • Configure autoscaling for production
  • Set up tiered storage (hot/warm/cold)
  • Enable HCC compression
  • Monitor CU-hour consumption
  • Review resource quotas monthly
  • Clean up old branches regularly

Integration Examples

With Kubernetes

apiVersion: v1
kind: ConfigMap
metadata:
name: heliosdb-config
data:
heliosdb.yaml: |
autoscaling:
enabled: true
min_cu: 0.0
max_cu: 16.0
tiered_storage:
enabled: true
cold_tier:
type: s3
bucket: ${S3_BUCKET}

With Terraform

resource "heliosdb_cluster" "main" {
name = "production"
autoscaling {
enabled = true
min_cu = 2.0
max_cu = 32.0
}
tiered_storage {
hot_size_gb = 1000
warm_size_gb = 5000
cold_bucket = aws_s3_bucket.cold_tier.id
}
}

With Prometheus

prometheus.yml
scrape_configs:
- job_name: 'heliosdb'
static_configs:
- targets: ['heliosdb:9090']
metrics_path: '/metrics'
scrape_interval: 15s

Monitoring Dashboard

Key Metrics to Track

Autoscaling:

  • Current CU level
  • CPU/memory utilization
  • Scaling events frequency
  • Cost per hour

Tiered Storage:

  • Per-tier usage
  • Migration rate
  • Cold tier latency
  • Cost savings

Branching:

  • Active branch count
  • Branch storage overhead
  • Branch age distribution

Cluster Health:

  • Node availability
  • Rebalancing status
  • Query routing latency
  • Resource quota utilization

Additional Resources

Documentation

Community

Support

Release Information

Version: 4.0.0 Release Date: October 2025 Status: Production Ready License: Apache-2.0

What’s Next

v4.1 (Q1 2026):

  • Enhanced ML-based autoscaling
  • Cross-region tiered storage
  • Advanced quota policies
  • Improved compression algorithms

v4.2 (Q2 2026):

  • Multi-cluster branching
  • Predictive scaling
  • Tiered compute (hot/warm/cold compute nodes)
  • Enhanced observability

Feedback

We value your feedback! Please report issues, suggest improvements, or share success stories:


HeliosDB v4.0 User Guides

Complete guide collection for all 12 breakthrough features.

Last Updated: October 24, 2025