Skip to content

index.md

Latest commit

 

History

History
281 lines (196 loc) · 11.7 KB

index.md

File metadata and controls

281 lines (196 loc) · 11.7 KB
Raw
layout default
title Orbit-RS Documentation
subtitle The Next-Generation Distributed Database System
category home
permalink /

Orbit-RS Documentation

The Next-Generation Multi-Protocol Database Platform

Version License Build Status 148K+ Lines 1078+ Tests

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.

Development & API

For developers building applications with Orbit-RS.

Operations & Deployment

For system administrators and DevOps engineers.

Feature Guides

Deep dives into Orbit-RS capabilities.

Project Information

Project status, roadmap, and community information.

Current Status: Production Ready

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

Component Status Features
Actor System Complete In-process & distributed actors, persistence
Network Layer Complete gRPC, in-process communication, connection pooling
Transactions Complete 2PC, Saga pattern, distributed locks, ACID compliance
SQL Engine Complete Full DDL/DML/DCL/TCL, JOINs, aggregates, vector operations
Protocols Complete Redis, PostgreSQL, MySQL, CQL, REST, gRPC
Kubernetes Complete Operator, Helm charts, production deployment
AI Subsystems Complete 8 intelligent subsystems for autonomous optimization
Time Series Complete RedisTimeSeries compatible with 21 comprehensive tests

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

View Detailed Status | See Full PRD

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

Documentation

Development Resources

Community & Support

Get Help

Report Issues

Contributing

License & Legal

Orbit-RS is released under dual license: MIT or BSD-3-Clause.

Quick Links

Star us on GitHub: TuringWorks/orbit-rs

Questions? Reach out on GitHub Discussions

Enterprise? Contact us at enterprise@turingworks.com