Skip to content
HeliosDB HeliosDB Full

Protocol Quick Start Guides

Protocol Quick Start Guides

This directory contains concise getting-started guides for migrating to HeliosDB from various database systems.

Protocol Quick Starts

GuideDescription
GRAPHQL_QUICK_START.mdGraphQL API with queries, mutations, and subscriptions
CASSANDRA_QUICK_START.mdCassandra CQL protocol with drivers
CLICKHOUSE_QUICK_START.mdClickHouse analytical queries
DRDA_QUICK_START.mdIBM DB2 DRDA protocol for DB2 migration and mainframe integration
ORACLE_QUICK_START.mdOracle 23ai compatibility and PL/SQL
PINECONE_QUICK_START.mdPinecone vector database API for similarity search

Migration Guides

GuideDescription
MIGRATION_FROM_MYSQL_TO_HELIOSDB.mdMigrate from MySQL to HeliosDB
MIGRATION_FROM_MSSQL_TO_HELIOSDB.mdMigrate from SQL Server to HeliosDB
MIGRATION_FROM_SQLITE_TO_HELIOSDB.mdMigrate from SQLite to HeliosDB
SQL_COMMANDS_QUICK_REFERENCE.mdCommon SQL commands reference

Quick Connection Examples

PostgreSQL Protocol (Port 5432)

import psycopg2
conn = psycopg2.connect(
    host="localhost", port=5432,
    database="heliosdb", user="admin", password="password"
)

MySQL Protocol (Port 3306)

import mysql.connector
conn = mysql.connector.connect(
    host="localhost", port=3306,
    database="heliosdb", user="admin", password="password"
)

MongoDB Protocol (Port 27017)

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

Redis Protocol (Port 6379)

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

HTTP/REST API (Port 443)

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

GraphQL (Port 443)

# Access playground at https://localhost:443/graphql
query {
  users(limit: 10) {
    id
    name
    email
  }
}

Protocol Reference Documentation

For comprehensive protocol documentation, see:

ProtocolQuick StartFull Reference
PostgreSQLUse psycopg2/psycopg3/docs/reference/protocols/postgresql/
MySQLUse mysql-connector/docs/reference/protocols/mysql/
MongoDBUse PyMongo/docs/reference/protocols/mongodb/
RedisUse redis-py/docs/reference/protocols/redis/
CassandraCASSANDRA_QUICK_START.md/docs/reference/protocols/cassandra/
HTTP/RESTUse curl/requests/docs/reference/protocols/http-rest/
GraphQLGRAPHQL_QUICK_START.md/docs/reference/protocols/graphql/
SnowflakeUse snowflake-connector/docs/reference/protocols/snowflake/
ClickHouseCLICKHOUSE_QUICK_START.md/docs/reference/protocols/clickhouse/
DRDA/DB2DRDA_QUICK_START.md/docs/reference/protocols/drda/
OracleORACLE_QUICK_START.md/docs/reference/protocols/oracle/
PineconePINECONE_QUICK_START.md/docs/reference/protocols/pinecone/

Last Updated: January 2026