HeliosDB Protocol Documentation Hub¶

This directory is the canonical reference for all HeliosDB protocol documentation. HeliosDB supports 9 production-ready protocols, enabling seamless integration with existing applications and tools.

Protocol Overview¶

Production Protocols (9)¶

Protocol	Port	Compatibility	Status	Documentation
PostgreSQL 17	5432	100%	Production	postgresql/
MySQL	3306	80%+	Production	mysql/
MongoDB	27017	100%	Production	mongodb/
Redis RESP3	6379	90%	Production	redis/
Cassandra CQL	9042	100%	Production	cassandra/
HTTP/REST	443/8080	75%+	Production	http-rest/
GraphQL	443/8080	80%+	Production	graphql/
Snowflake	443	90%+	Production	snowflake/
ClickHouse	9000/8123	85%	Production	clickhouse/

Additional Protocols¶

Protocol	Port	Compatibility	Status	Documentation
Oracle 23ai	1521	95%+	Production	oracle/
DRDA (DB2)	50000	95%	Production	drda/
Pinecone Vector	8080	100%	Production	pinecone/

Documentation Structure¶

Each protocol has a standardized 4-file documentation set:

[protocol]/
├── README.md         # Overview and quick start (< 3 pages)
├── CONFIGURATION.md  # Comprehensive configuration reference
├── COMPATIBILITY.md  # Feature compatibility matrix
└── EXAMPLES.md       # Code examples and patterns

SQL Protocols¶

PostgreSQL - Full PostgreSQL 17 wire protocol with all advanced features
MySQL - MySQL wire protocol v10 with prepared statements and transactions
Snowflake - Snowflake SQL API with Time Travel, VARIANT, and FLATTEN
Oracle - Oracle 23ai TNS protocol with PL/SQL support
DRDA - IBM DB2 DRDA Level 5 protocol
ClickHouse - ClickHouse native and HTTP protocols

NoSQL Protocols¶

MongoDB - MongoDB Wire Protocol 6.0+ with aggregation pipeline
Redis - Redis RESP3 with all data structures and Pub/Sub
Cassandra - CQL Binary Protocol v4/v5 with LWT support

API Protocols¶

HTTP/REST - RESTful API with OpenAPI 3.0 specification
GraphQL - Auto-generated schemas with subscriptions and federation

Vector Protocols¶

Pinecone - Pinecone Vector REST API compatible

Quick Start Examples¶

PostgreSQL¶

import psycopg2
conn = psycopg2.connect(host="localhost", port=5432, database="heliosdb", user="admin", password="password")
cursor = conn.cursor()
cursor.execute("SELECT * FROM users")

MySQL¶

import mysql.connector
conn = mysql.connector.connect(host="localhost", port=3306, database="heliosdb", user="admin", password="password")
cursor = conn.cursor()
cursor.execute("SELECT * FROM users")

MongoDB¶

from pymongo import MongoClient
client = MongoClient("mongodb://admin:password@localhost:27017/heliosdb")
db = client.heliosdb
users = db.users.find()

Redis¶

import redis
client = redis.Redis(host='localhost', port=6379, password='password')
client.set('key', 'value')

HTTP/REST¶

curl -X POST https://localhost:443/api/v1/query \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"sql": "SELECT * FROM users LIMIT 10"}'

GraphQL¶

query {
  users(limit: 10) {
    id
    name
    email
  }
}

Cross-Protocol Resources¶

Resource	Description
PROTOCOL_COMPATIBILITY_MATRIX.md	Unified compatibility overview for all protocols
MIGRATION_GUIDE.md	General database migration strategies
migrations/	Database-specific migration guides

Quick Start Guides¶

For concise getting-started guides, see: - /docs/quick-starts/protocols/ - Protocol quick-start guides - Migration guides for MySQL, MSSQL, SQLite - SQL commands quick reference

User Guides¶

For detailed user documentation: - /docs/guides/user/ - User documentation - CONNECTING.md - Connection guide - GETTING_STARTED.md - Getting started

Architecture¶

For technical deep-dives: - /docs/architecture/ - Architecture documentation

Migration Guides¶

Source Database	Migration Guide
MySQL	migrations/MIGRATION_FROM_MYSQL_TO_HELIOSDB.md
SQL Server	migrations/MIGRATION_FROM_MSSQL_TO_HELIOSDB.md
SQLite	migrations/MIGRATION_FROM_SQLITE_TO_HELIOSDB.md

Driver Compatibility Matrix¶

Driver	PostgreSQL	MySQL	MongoDB	Cassandra	Redis
Python	psycopg2/3	mysql-connector	PyMongo	cassandra-driver	redis-py
Node.js	node-postgres	mysql2	mongodb	cassandra-driver	ioredis
Java	JDBC	JDBC	MongoDB Driver	DataStax	Jedis
Go	lib/pq	go-sql-driver	mongo-go	gocql	go-redis
Rust	rust-postgres	mysql	mongodb	-	redis-rs
C#	Npgsql	MySqlConnector	MongoDB.Driver	CassandraCSharpDriver	StackExchange.Redis

Protocol Selection Guide¶

Best for OLTP (High Concurrency)¶

PostgreSQL or MySQL protocols
Benefits: Deadlock detection, connection pooling, ACID transactions

Best for Document Storage¶

MongoDB protocol
Benefits: Aggregation pipeline, change streams, flexible schemas

Best for Caching and Real-Time¶

Redis protocol
Benefits: All data structures, Pub/Sub, sub-millisecond latency

Best for Analytics¶

Snowflake or ClickHouse protocols
Benefits: Time travel, columnar optimization, OLAP functions

Best for API Integration¶

HTTP/REST or GraphQL protocols
Benefits: Universal access, auto-generated schemas, subscriptions

Archive¶

Legacy protocol documentation and historical compliance reports have been archived to: - /docs/archive/protocols/ - See archive README for details

Statistics¶

Metric	Count
Total Protocols	12
Production Protocols	9
Protocol Directories	12
Documentation Files	48+

Last Updated: January 2026 Consolidation Status: Complete