athena_rs 3.23.0

Hyper performant polyglot Database driver
Documentation

Athena RS 3.23.0

current version: 3.23.0

Athena

Athena is the Rust gateway and runtime behind athena_rs: multi-backend data access, admin APIs, provisioning, background workers, realtime transport, and the operator surfaces that sit around them.

Start here

Repository shape

  • src/ holds the root athena_rs server/runtime and the Rust SDK surface.
  • crates/ contains 23 package directories, including 22 root-workspace members and 1 adjacent crate.
  • apps/ contains 8 operator, docs, desktop, marketing, and edge-delivery surfaces.
  • sql/ contains runnable provision and migration SQL.
  • docs/ contains repo-local architecture, runtime, and workspace documentation.
  • openapi.yaml and openapi-wss.yaml capture the HTTP and WebSocket contracts.

Common workflows

  • Inspect the runtime CLI from the repo root with cargo run --bin athena_rs -- --help.
  • Run Rust tests and heavier Rust verification from WSL2 on this machine rather than the Windows toolchain.
  • Use the folder READMEs when changing one surface; use the MANIFEST files when you need the whole workspace map.

Local Docker stack

  • docker compose up --build now boots the local gateway stack with the shared logging Postgres, Redis, Typesense, MinIO-backed backup storage, Loki, Prometheus, Grafana, pgAdmin, the WSS gateway, and the dedicated Athena worker processes as separate containers.
  • Worker containers run the real binaries directly: athena_daemon_legacy_workers, athena_clone_worker, athena_backup_worker, athena_deferred_query_worker, and athena_typesense_worker.
  • The local logging database stays wired through the existing config.yaml contract via POSTGRES_ATHENA_LOGGING_URI=postgres://athena:athena@postgres:5432/athena_logging.
  • Use docker compose --profile tools up -d athena-pg-tools when you want a long-lived container with pg_dump, pg_restore, and psql available on the same network for manual backup or restore work.

Deep reference