Skip to main content

Crate heliosdb_proxy

Crate heliosdb_proxy 

Source
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§

NodeEndpoint
Node endpoint information
NodeId
Node identifier

Enums§

NodeRole
Node role in the cluster
ProxyError
Proxy error types

Constants§

DEFAULT_ADMIN_PORT
Default admin port
DEFAULT_PORT
Default listen port
VERSION
Proxy version

Type Aliases§

Result