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

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: Production Ready

Orbit-RS has delivered a comprehensive multi-protocol database platform:

Performance Metrics:

• Throughput: 500K+ messages/second per core
• Code Quality: 148,780+ lines of production-ready Rust
• Test Coverage: 1,078+ tests ensuring reliability
• Protocols: 7 complete protocols with RocksDB persistence
• Zero Warnings: Strict code quality policy enforced

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

Enterprise-grade SQL engine with modern capabilities.

• 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: Production-ready deployment templates
• 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.

• License
• Security Policy
• Code of Conduct

Quick Links