Skip to content

Installation

Library

Add surql as a dependency:

cargo add oneiriq-surql

Or, in Cargo.toml:

[dependencies]
oneiriq-surql = "0.2"

Feature flags

Short overview; the full matrix and recipes live on the Feature flags page.

Feature Default What it adds
client yes Async SurrealDB client (tokio, surrealdb 3.x).
cli no surql binary (implies client, orchestration, settings).
cache no In-process MemoryCache backend + CacheManager.
cache-redis no Redis backend for the cache manager (implies cache).
settings no Layered Settings / SettingsBuilder.
orchestration no Multi-database deployment strategies + environment registry.
watcher no Filesystem watcher for schema / migration files. 
[dependencies]
# library-only, no client
oneiriq-surql = { version = "0.2", default-features = false }

# binary + client
oneiriq-surql = { version = "0.2", features = ["cli"] }

CLI

cargo install oneiriq-surql --features cli

Subcommand reference: CLI.

Requirements

  • Rust 1.90 or newer.
  • For the client feature: SurrealDB 3.0 or newer.

What's next