Expand description
HeliosDB Proxy - Standalone Connection Router
A standalone proxy for HeliosDB-Lite providing:
- Connection pooling
- Load balancing (read/write splitting)
- Health monitoring
- Transaction Replay (TR)
§Deployment Options
- Standalone binary: Run as a separate process
- Kubernetes sidecar: Deploy alongside your application
- Embedded library: Use as a library in your application
§Quick Start
# Start with config file
heliosdb-proxy --config /etc/heliosdb/proxy.toml
# Start with command line options
heliosdb-proxy \
--listen 0.0.0.0:5432 \
--primary db-primary:5432 \
--standby db-standby-1:5432 \
--standby db-standby-2:5432§Configuration Example
[proxy]
listen_address = "0.0.0.0:5432"
admin_address = "0.0.0.0:9090"
[pool]
min_connections = 5
max_connections = 100
idle_timeout_secs = 300
[load_balancer]
strategy = "round_robin" # or "least_connections", "latency_based"
read_write_split = true
[health]
check_interval_secs = 5
failure_threshold = 3
[[nodes]]
host = "db-primary"
port = 5432
role = "primary"
[[nodes]]
host = "db-standby-1"
port = 5432
role = "standby"Modules§
- admin
- Admin API
- analytics
- Query Analytics & Slow Query Log
- anomaly
- Anomaly detection (T3.1).
- auth
- Authentication Proxy Module
- backend
- Backend PostgreSQL client used by TR-management code paths.
- batch
- INSERT Batching for HeliosProxy
- cache
- Query Caching Module
- circuit_
breaker - Circuit Breaker Pattern for HeliosProxy
- config
- Proxy Configuration
- connection_
pool - Connection Pool - HeliosProxy
- cursor_
restore - Cursor Restore - TR (Transaction Replay)
- distribcache
- Helios-DistribCache - Intelligent Distributed Caching Layer
- edge
- Edge / geo proxy mode (T3.2).
- failover_
controller - Failover Controller - HeliosProxy
- failover_
replay - Failover Replay - TR (Transaction Replay)
- graphql
- GraphQL-to-SQL Gateway
- health_
checker - Health Checker - HeliosProxy
- lag
- Replica Lag-Aware Routing Module
- load_
balancer - Load Balancer - HeliosProxy
- multi_
tenancy - Multi-Tenancy Support for HeliosProxy
- pipeline
- Request Pipeline for HeliosProxy
- plugins
- WASM Plugin System
- pool
- Connection Pooling Modes - HeliosProxy
- primary_
tracker - Primary Tracker - Tracks current primary node for query routing
- protocol
- Protocol Handling
- rate_
limit - Rate Limiting & Query Throttling Module
- replay
- Time-travel replay engine.
- request
- Per-Request View
- rewriter
- Query Rewriting Module
- routing
- Query Routing Hints - HeliosProxy Feature 03
- schema_
routing - Schema-Aware Routing
- server
- Proxy Server Implementation
- session_
migrate - Session Migrate - TR (Transaction Replay)
- shadow_
execute - Shadow-execution module (T3.4 R&D).
- switchover_
buffer - Switchover Buffer - Query buffering during controlled switchover
- transaction_
journal - Transaction Journal - TR (Transaction Replay)
- upgrade_
orchestrator - Zero-downtime PostgreSQL major-version upgrade orchestrator (T2.1).
Structs§
- Node
Endpoint - Node endpoint information
- NodeId
- Node identifier
Enums§
- Node
Role - Node role in the cluster
- Proxy
Error - Proxy error types
Constants§
- DEFAULT_
ADMIN_ PORT - Default admin port
- DEFAULT_
PORT - Default listen port
- VERSION
- Proxy version