Skip to content

PostgreSQL Protocol Documentation

This directory contains consolidated documentation for HeliosDB’s PostgreSQL 17 protocol support and compatibility.

Quick Start

Connect to HeliosDB using any PostgreSQL client:

Terminal window
# Using psql
psql -h localhost -p 5432 -U helios -d heliosdb
# Using connection string
psql "postgresql://helios:password@localhost:5432/heliosdb"

Contents

FileDescription
README.mdOverview and quick start (this file)
CONFIGURATION.mdConnection and protocol configuration
COMPATIBILITY.mdPostgreSQL 17 feature compatibility matrix
EXAMPLES.mdSQL examples and usage patterns

Feature Overview

Wire Protocol Support

HeliosDB implements PostgreSQL wire protocol v3.0 with full feature support:

  • Authentication: Password, MD5, SCRAM-SHA-256
  • Extended Query Protocol: Prepare, Bind, Execute, Describe
  • COPY Protocol: Binary and text formats, streaming
  • Replication Protocol: Logical and physical replication
  • Notification: LISTEN/NOTIFY support

PostgreSQL 17 Features

FeatureAvailabilityDescription
JSON_TABLESupportedSQL/JSON table conversion
MERGE with RETURNINGSupportedUpsert with result capture
COPY with ON_ERRORSupportedError handling during bulk load
Incremental BackupPlannedBlock-level incremental backups
Slot FailoverPlanned (with replication)Logical replication HA
Vacuum OptimizationPlanned (VACUUM is accepted and returns immediately today)20x memory reduction

SQL Compatibility

  • DDL: CREATE, ALTER, DROP (tables, indexes, views, functions)
  • DML: INSERT, UPDATE, DELETE, MERGE, COPY
  • Queries: SELECT, CTEs, window functions, subqueries
  • Transactions: MVCC, isolation levels, savepoints
  • Extensions: Common extensions compatibility

Connection Parameters

ParameterDefaultDescription
hostlocalhostServer hostname
port5432PostgreSQL wire protocol port
databasepostgresDefault database
user-Username for authentication
password-Password for authentication
sslmodepreferSSL connection mode

Performance Characteristics

MetricValue
Connection handshake1 RTT
Auth overhead1-2 RTT
Query latencyComparable to PostgreSQL
Bulk load (COPY)100K+ rows/sec

Client Compatibility

Tested with:

  • CLI: psql, pgcli
  • GUI: pgAdmin, DBeaver, DataGrip
  • Languages: psycopg2/3 (Python), node-postgres (JS), lib/pq (Go), JDBC (Java)
  • ORMs: SQLAlchemy, Prisma, ActiveRecord, GORM

Migration from PostgreSQL

HeliosDB is designed as a drop-in replacement for PostgreSQL:

  1. No schema changes required
  2. Standard pg_dump import supported
  3. Connection string compatible
  4. Client libraries work without modification

See EXAMPLES.md for migration patterns.