Orbit-RS Documentation
The Next-Generation Multi-Protocol Database Platform
Quick Start
New to Orbit-RS? Get up and running in 30 seconds:
# Clone and build
git clone https://github.com/TuringWorks/orbit-rs.git
cd orbit-rs
cargo build --release
# Start multi-protocol server
./target/release/orbit-server --dev-mode
# Connect with any client:
# PostgreSQL: psql -h localhost -p 5432 -U orbit -d actors
# Redis: redis-cli -h localhost -p 6379
# MySQL: mysql -h localhost -P 3306 -u orbit
| Full Quick Start Guide | See Project Overview | Architecture (PRD) |
Documentation Sections
Getting Started
Perfect for developers new to Orbit-RS or distributed databases.
- Quick Start Guide - Get running in 30 seconds
- Project Overview - Architecture, features, and use cases
- Product Requirements Document (PRD) - Complete architecture and module reference
- Architecture Details - Understanding Orbit-RS design
- Development Guide - Setup and configuration
Development & API
For developers building applications with Orbit-RS.
- API Reference - Complete API documentation
- Protocol Support - Network layer and protocol details
- Testing Guide - Writing and running tests
- Contributing - How to contribute to Orbit-RS
- Development Setup - Setting up development environment
Operations & Deployment
For system administrators and DevOps engineers.
- Kubernetes Deployment - Production Kubernetes setup
- Configuration Reference - Complete configuration guide
- Storage Architecture - Storage backends and tiering
- Security - Security policies and practices
- Operations Runbook - Monitoring and troubleshooting
- Performance Tuning - Optimization guide
Feature Guides
Deep dives into Orbit-RS capabilities.
- SQL Engine - PostgreSQL wire protocol and SQL
- Time Series - RedisTimeSeries compatibility
- Graph Database - Graph data models and queries
- Vector Operations - AI/ML vector database
- Redis Commands - 124+ RESP commands
- MySQL Protocol - MySQL wire protocol
- CQL Protocol - Cassandra Query Language
- Hardware Acceleration - GPU/Neural compute
- AQL Reference - ArangoDB Query Language support
- GraphRAG Integration - AI and graph analytics
Project Information
Project status, roadmap, and community information.
- Features - Complete feature list
- Project Status - Current implementation status
- Changelog - Version history and changes
- Migration Guide - Migrating from other databases
- Contributing - Community guidelines and support
Current Status
Orbit-RS is a distributed database that speaks several wire protocols over one durable, replicated store. Its goal is full compatibility with PostgreSQL 18, measured against the PostgreSQL 18 conformance corpus; each other protocol layer targets the latest version of the system it imitates (see the protocol table in Project Overview). Compatibility, maturity and performance are stated only as measured: a conformance pass rate with its date, a maturity label with its evidence, and benchmark results with their method.
| Component | Maturity | Measured |
|---|---|---|
| PostgreSQL wire and SQL engine | Preview | 789 of 816 conformance records (96.7%), 2026-10-27 |
| Other protocols (MySQL, CQL, AQL, MongoDB, Redis RESP, Cypher/Bolt) | Experimental | First corpora, 2026-10-25: MySQL 20.0%, CQL 30.3%, AQL 36.4%, MongoDB 44.0%, Redis 37.1%, Cypher/Bolt 7.8% |
| REST, gRPC, OrbitQL | Experimental | Not yet measured |
| Actor system, transactions, Kubernetes, AI subsystems, time series | Experimental | unit and integration tests; see Maturity |
Figures: 3,986 test functions and 457,233 non-blank lines of Rust (scripts/project_facts.py, commit 222ac1c2, 2026-10-25); performance is not yet benchmarked.
Key Features
Multi-Protocol Database
One server, all protocols - replace PostgreSQL + MySQL + Redis + Cassandra with a single process.
- PostgreSQL Wire Protocol: Full SQL with pgvector, JSONB, spatial functions
- Redis RESP Protocol: 124+ commands with time series and vectors
- MySQL Wire Protocol: MySQL client compatibility
- CQL Protocol: Cassandra Query Language support
- HTTP REST API: JSON API with health and metrics
- gRPC Services: High-performance actor communication
AI-Native Subsystems
8 intelligent subsystems for autonomous database optimization.
- AI Master Controller: Central orchestration (10-second control loop)
- Intelligent Query Optimizer: Cost-based optimization with ML
- Predictive Resource Manager: Workload forecasting
- Smart Storage Manager: Hot/warm/cold tiering
- Adaptive Transaction Manager: Dynamic concurrency control
- Learning Engine: Model improvement
- Decision Engine: Policy-based decisions
- Knowledge Base: Pattern storage
Advanced SQL Engine
SQL engine on a durable, replicated store (PostgreSQL 18 compatibility is the goal; see Status).
- Complete SQL Support: DDL, DML, DCL, TCL operations
- Vector Database: High-performance similarity search with HNSW/IVFFLAT
- Complex Queries: JOINs, subqueries, CTEs, window functions
- Transaction Support: ACID compliance with distributed transactions
- JSONB Support: JSON storage, indexing, and querying
- Spatial Functions: PostGIS-compatible spatial operations
Cloud-Native
Designed for modern cloud and Kubernetes deployments.
- Kubernetes Operator: Custom resources for cluster management
- Helm Charts: Deployment templates (Experimental)
- Auto-scaling: Dynamic cluster scaling based on workload
- Multi-platform: Support for linux/amd64, linux/arm64, and Apple Silicon
- Enterprise Security: RBAC, JWT authentication, audit trails
Hardware Acceleration
Powerful heterogeneous compute engine for maximum performance.
- CPU SIMD: AVX-512, NEON optimization with 3-8x speedups
- GPU Acceleration: Metal, CUDA, Vulkan, ROCm with 5-50x speedups
- Neural Engines: Apple ANE integration for AI workloads
- Auto-Detection: Intelligent hardware discovery and workload routing
- Cross-Platform: macOS, Windows, Linux support
Learning Resources
Tutorials
- Getting Started Tutorial - Your first Orbit-RS application
- SQL Tutorial - SQL features and vector operations
- Time Series Tutorial - Time series data management
- Transaction Programming - Building with distributed transactions
- Kubernetes Deployment - Production deployment guide
Documentation
- Architecture Overview - Understanding Orbit-RS design principles
- Product Requirements Document - Complete architecture and module reference
- Performance Guide - Optimization and tuning
- Storage Architecture - Storage backends and tiering
Development Resources
- Development Guide - Understanding the codebase
- Migration Guide - Moving from other databases
- Security Guide - Security best practices
- Operations Runbook - Monitoring and troubleshooting
Community & Support
Get Help
- GitHub Issues - Bug reports and questions
- GitHub Discussions - Community Q&A
- Contact Email - General inquiries
Report Issues
- Bug Reports
- Feature Requests
- Security Issues - Responsible disclosure
Contributing
- Contribution Guide - How to contribute code
- Documentation - Documentation structure and guides
- Testing - Adding tests and benchmarks
- Development - Development workflow
License & Legal
Orbit-RS is released under dual license: MIT or BSD-3-Clause.
Quick Links
For Developers:
For Operators:
For Decision Makers: