Skip to content
HeliosDB HeliosDB Full

HeliosDB API Documentation

HeliosDB API Documentation

Complete API documentation for HeliosDB 7.0.

Directory Structure

/rest/

RESTful API endpoint documentation and examples.

/openapi/

OpenAPI (Swagger) specifications for automated documentation generation:

  • Use with Swagger UI for interactive API exploration
  • Generate client SDKs with OpenAPI Generator
  • Import into API testing tools (Postman, Insomnia)

Documentation Files

Core API Reference

  • API_REFERENCE.md - Primary comprehensive reference
    • Rust Native APIs: Storage, Vector, Graph, Document, Time-Series, Replication, Cache, Transaction
    • Advanced features: Self-Healing, Materialized Views, ETL, Multi-Master, Quantum Computing
    • Authentication and Protocol Compatibility
    • REST and GraphQL API usage examples
    • Performance tuning and security best practices

SQL Reference

  • SQL_API_REFERENCE.md - PostgreSQL-compatible SQL interface
    • DDL, DML, TCL statements
    • Multi-model extensions (Vector, Graph, Document, Time-Series, Spatial)
    • Built-in functions and full-text search
    • Performance tips and examples

Quick Reference

  • QUICK_REFERENCE.md - Condensed quick reference
    • Fast lookup for common operations
    • Code snippets and examples
    • Common patterns and best practices
    • Complete working examples for each component

HTTP API References

OpenAPI Specification

  • openapi/heliosdb_v7_openapi.yaml
    • Full REST API specification in OpenAPI 3.0 format
    • Authentication (API Key and JWT)
    • All endpoints with request/response schemas
    • Rate limiting documentation
    • Use with Swagger UI or other OpenAPI tools

API Coverage

Storage Operations

  • LSM Storage Engine (put, get, delete, scan)
  • HCC Compression (v1 and v2)
  • Time-Series Engine
  • Temporal Tables (bi-temporal)
  • Cloud Tiering (S3)

Vector Database

  • HNSW Index (approximate nearest neighbor)
  • IVF Index (inverted file with quantization)
  • Hybrid Search (vector + metadata + text)
  • Distance Metrics (L2, Cosine, Inner Product, etc.)
  • Embedding Services

Graph Database

  • Node and Edge Operations
  • Graph Traversal (BFS, DFS)
  • Path Finding (shortest path, all paths)
  • Cycle Detection
  • Connected Components
  • Cypher Query Support

Document Store

  • CRUD Operations
  • Schema Validation (JSON Schema)
  • Aggregation Pipeline
  • Change Streams (real-time)
  • Full-Text Search Integration

Time-Series

  • Point Writing and Querying
  • Windowed Aggregations
  • Retention Policies
  • Downsampling
  • Multi-Dimensional Tag Indexing
  • Forecasting

Replication

  • Read Replica Management
  • Load Balancing Strategies
  • WAL Streaming (PostgreSQL compatible)
  • Lag Monitoring
  • Automatic Failover

Caching

  • Unified Cache Manager
  • ML-Based Eviction
  • Tiered Storage (L1/L2/L3)
  • Compression
  • Stampede Protection
  • Prefetching

Transactions

  • ACID Transactions
  • Multiple Isolation Levels
  • XA Protocol (distributed transactions)
  • Two-Phase Commit

Advanced Features

  • Self-Healing Database
  • Intelligent Materialized Views
  • Automated ETL Pipelines
  • Multi-Master Replication (CRDT)
  • Distributed Query Optimizer
  • Global Distributed Cache
  • Deadlock Detection
  • Quantum Computing Integration
  • Neuromorphic Computing
  • Energy-Aware Optimization

Usage Examples

Rust API

use heliosdb_storage::{LsmStorageEngine, StorageConfig};
use heliosdb_vector::{HnswIndex, DistanceMetric};
use heliosdb_graph::{GraphEngine, GraphConfig};


#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Storage
    let engine = LsmStorageEngine::new("/data", StorageConfig::default()).await?;


    // Vector search
    let mut index = HnswIndex::new(768, 16, 200, DistanceMetric::Cosine);
    index.insert(1, vec![0.1; 768]).await?;


    // Graph queries
    let graph = GraphEngine::new(GraphConfig::default()).await?;


    Ok(())
}

REST API

Terminal window
# Query
curl -X POST http://localhost:8080/api/v1/query \
  -H "X-API-Key: your-key" \
  -H "Content-Type: application/json" \
  -d '{"query": "SELECT * FROM users LIMIT 10"}'


# Vector search
curl -X POST http://localhost:8080/api/v1/vector/search \
  -H "X-API-Key: your-key" \
  -H "Content-Type: application/json" \
  -d '{"vector": [0.1, 0.2, 0.3], "k": 10}'

GraphQL API

query {
  users(where: { age: { gt: 25 } }, orderBy: { name: ASC }, take: 10) {
    id
    name
    email
    age
  }
}

Additional Resources

API Versioning

Current API version: 7.0.0

Breaking changes are documented in:

Archived Documentation

Previously duplicate API documentation files have been consolidated. Archived files are available at:

Support

Generated: January 4, 2026 Version: 7.0.0