Skip to main content

Installation

Prerequisitesโ€‹

  • Rust 1.83+
  • A database: PostgreSQL, MySQL, or SQLite

Add Dependenciesโ€‹

[dependencies]
ryx-rs = "0.1"
ryx-macro = "0.1"
tokio = { version = "1", features = ["full"] }

Or via cargo:

cargo add ryx-rs ryx-macro
cargo add tokio --features full

Database Backendsโ€‹

Enable backends as Cargo features:

# All backends
ryx-rs = { version = "0.1", features = ["postgres", "mysql", "sqlite"] }

# Single backend
ryx-rs = { version = "0.1", features = ["postgres"] }

The default includes SQLite only.

Verifyโ€‹

cargo check

You should see a successful build.

Next Stepsโ€‹