HeliosDB Tutorials

HeliosDB Tutorials

Learn by doing - Hands-on tutorials for every skill level

---

Tutorial Levels

Basic (6 tutorials) - 10-15 minutes each

Perfect for getting started with HeliosDB fundamentals.

1. Basic CRUD Operations ⭐ START HERE

   • Create, read, update, delete
   • Transactions and rollbacks
   • Basic data types

2. SHOW Commands & Introspection 🆕

   • 100+ SHOW commands for database exploration
   • Storage internals, caches, protocols
   • FLUSH commands for cache management

3. Advanced Queries

   • Joins (inner, outer, cross)
   • Aggregations and GROUP BY
   • Common Table Expressions (CTEs)

4. Multi-Protocol Magic

   • Connect via PostgreSQL, Oracle, MySQL
   • Same data, different protocols
   • Protocol-specific features

5. Vector Similarity Search

   • Semantic search with embeddings
   • HNSW index creation
   • Real-world product recommendations

6. Distributed Queries

   • Sharded tables
   • Partitioning strategies
   • Query routing

Intermediate (12 tutorials) - 15-20 minutes each

Deep dive into HeliosDB’s enterprise features.

6. EXPLAIN Plans & Query Analysis 🆕

   • 7 output formats (Text, JSON, YAML, XML, HTML, GraphViz, Mermaid)
   • Feature detection, “Why Not” analysis
   • Optimizer decisions with reasoning

7. Redis Protocol 🆕

   • 104+ commands: Strings, Hashes, Lists, Sets, Sorted Sets
   • Streams, Geo, HLL, Bitmaps, Lua scripting
   • BullMQ-compatible queues, Pub/Sub, ACL

8. CDC Events & Storage Tiering 🆕

   • Change Data Capture on INSERT/UPDATE/DELETE
   • Hot/warm/cold storage tiering
   • CDC connectors and Redis Streams bridge

9. Multi-Protocol Access 🆕

   • 14 protocol adapters simultaneously
   • Protocol auto-detection
   • REST admin API (16 endpoints)

10. MongoDB Protocol & AI Commands 🆕

    • Wire-compatible mongosh access (CRUD, aggregation, transactions)
    • AI commands: vectorSearch, nlQuery, schemaAnalyze, indexRecommend
    • GridFS, change streams, cross-protocol queries

11. Oracle PL/SQL Compatibility

• PL/SQL procedures and functions
• DBMS packages (OUTPUT, UTL_FILE)
• Triggers and sequences

7. MySQL Feature Compatibility

   • MySQL stored procedures
   • AUTO_INCREMENT and LAST_INSERT_ID
   • MySQL-specific functions

8. MVCC Transactions

   • ACID guarantees
   • Isolation levels (Serializable, Snapshot)
   • Deadlock handling

9. Indexing & Optimization

   • B-tree, Hash, HNSW, GiST indexes
   • Query plan analysis
   • Autonomous index advisor

10. Backup & Point-in-Time Recovery

    • Continuous archiving
    • PITR (Point-in-Time Recovery)
    • Disaster recovery

11. High Availability Replication

    • Multi-master CRDT replication
    • Failover and split-brain resolution
    • Read replicas

12. Monitoring with Prometheus & Grafana

    • Metrics export
    • Dashboard setup
    • Alerting rules

13. Security: TDE & Row-Level Security

    • Transparent Data Encryption (TDE)
    • Row-Level Security (RLS)
    • Audit logging

Advanced (9 tutorials) - 20-30 minutes each

Cutting-edge features for advanced users.

14. Security, Compliance & Multi-Tenancy 🆕

    • RBAC, RLS, compliance (GDPR/HIPAA/SOC2)
    • Multi-tenancy, encryption key rotation
    • Audit logging, threat detection

15. AI/ML, Vector Search & RAG 🆕

    • HNSW/IVF vector indexes, embeddings
    • RAG pipelines, NL2SQL
    • Cluster, federation, WASM, lineage

16. Federated Learning Platform

    • Privacy-preserving ML
    • Multi-party training
    • GDPR/HIPAA compliance

17. Autonomous Tuning

    • AI-driven optimization
    • Self-healing queries
    • Performance baselines

18. GraphQL API Server

    • Auto-generated GraphQL schema
    • Subscriptions (real-time)
    • Mutations and queries

19. Streaming with Apache Flink

    • Real-time data pipelines
    • Change Data Capture (CDC)
    • Stream processing

20. Edge Deployment & Caching

    • 4-tier edge caching
    • Edge compute functions
    • Global distribution

21. Homomorphic Encryption Queries

    • Compute on encrypted data
    • CKKS scheme
    • Healthcare/finance use cases

22. Quantum-Inspired Optimization

    • Complex query optimization
    • 100x speedup on joins
    • Annealing algorithms

---

How to Use These Tutorials

Prerequisites

• Docker installed (Get Docker)
• Basic SQL knowledge (helpful but not required)
• 5 minutes to complete Quickstart

Tutorial Format

Each tutorial follows this structure:

1. Time Estimate - How long it takes
2. What You’ll Learn - Key takeaways
3. Prerequisites - What you need
4. Setup - Environment preparation
5. Step-by-Step Guide - Hands-on walkthrough
6. Troubleshooting - Common issues
7. Next Steps - Where to go next
8. Complete Code - Full working example

Running Examples

All tutorial code is tested and runnable:

# Clone repository
git clone https://github.com/heliosdb/heliosdb
cd heliosdb

# Start HeliosDB
docker-compose up -d

# Run tutorial examples
cd examples/tutorials
cargo run --example 01_basic_crud

---

Learning Paths

Path 1: Application Developer

Goal: Build apps with HeliosDB

1. Basic CRUD Operations
2. Advanced Queries
3. Vector Similarity Search
4. Indexing & Optimization
5. GraphQL API Server

Time: ~2 hours

Path 2: Database Administrator

Goal: Deploy and manage HeliosDB in production

1. Multi-Protocol Magic
2. MVCC Transactions
3. Backup & Point-in-Time Recovery
4. High Availability Replication
5. Monitoring with Prometheus
6. Security: TDE & RLS
7. Autonomous Tuning

Time: ~3 hours

Path 3: Oracle Migrator

Goal: Migrate from Oracle to HeliosDB

1. Multi-Protocol Magic
2. Oracle PL/SQL Compatibility
3. MVCC Transactions
4. Migration Guide: Oracle → HeliosDB

Time: ~1.5 hours

Path 4: ML/AI Developer

Goal: Build AI-powered applications

1. Vector Similarity Search
2. Federated Learning Platform
3. Homomorphic Encryption Queries

Time: ~1.5 hours

Path 5: Data Engineer

Goal: Build real-time data pipelines

1. Distributed Queries
2. Streaming with Apache Flink
3. Edge Deployment & Caching

Time: ~1.5 hours

---

Tutorial Status

Tutorial	Status	Priority	ETA
01-basic-crud	Complete	P0	-
02-advanced-queries	Complete	P0	-
03-multi-protocol	Complete	P0	-
04-vector-search	Complete	P0	-
05-distributed-queries	Complete	P0	-
06-oracle-plsql	⚠ In Progress	P0	Week 2
07-mysql-compatibility	📋 Planned	P1	Week 2
08-transactions-mvcc	📋 Planned	P1	Week 2
09-indexing-optimization	📋 Planned	P1	Week 3
10-backup-restore	📋 Planned	P1	Week 3
11-replication-ha	📋 Planned	P1	Week 3
12-monitoring-metrics	📋 Planned	P1	Week 3
13-security-tde	📋 Planned	P1	Week 4
14-federated-learning	📋 Planned	P2	Week 4
15-autonomous-tuning	📋 Planned	P2	Week 4
16-graphql-api	📋 Planned	P2	Week 5
17-streaming-flink	📋 Planned	P2	Week 5
18-edge-deployment	📋 Planned	P2	Week 5
19-homomorphic-encryption	📋 Planned	P2	Week 6
20-quantum-optimization	📋 Planned	P2	Week 6

---

Get Help

• Stuck on a tutorial? Check Troubleshooting Guide
• Have questions? See FAQ
• Need support? Join Discord or GitHub Discussions

---

Contributing Tutorials

Want to write a tutorial? We’d love your help!

1. Check open tutorial issues
2. Follow the Tutorial Template
3. Submit a PR with your tutorial

Tutorial Quality Standards:

• All code must be tested and runnable
• Clear step-by-step instructions
• Troubleshooting section
• Time estimate accurate (±20%)
• Screenshots/diagrams where helpful

---

Happy Learning!

Start with the Quickstart Guide or dive into Tutorial 01: Basic CRUD.