Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

Full API documentation is generated from source code.

Rust Crates

CrateDescriptionDocs
qail-coreAST, Builder, Parserdocs.rs
qail-pgPostgreSQL driverdocs.rs
qail-gatewayAuto-REST gatewaydocs.rs
qailCLI and toolingdocs.rs

SDKs

SDKStatusDistribution
TypeScript (@qail/client)Supportednpm
Swift (sdk/swift)SupportedSource package
Kotlin (sdk/kotlin)SupportedSource module
Node.js native bindingDeferredNot published
WASM bindingDeferredNot published

Generate Local Docs

cargo doc --no-deps --open

Key Types

qail-core

  • Qail - Query command builder
  • Operator - Comparison operators
  • SortOrder - ASC/DESC
  • Expr - Expression AST nodes
  • QailBuildError - Structured builder error type

qail-pg

  • PgDriver - Database connection
  • PgPool - Connection pool
  • PgRow - Result row
  • PgError - Error types

1.0 API Notes

  • Use Qail::get/add/set/del and typed builder methods for normal database work.
  • Use with_rls(&ctx)?; the older try_with_rls() alias is removed.
  • Use join_on(...)? for schema-driven relation joins; the older try_join_on() alias is removed.
  • Use bytes-native PostgreSQL cancel-key APIs instead of legacy i32 wrappers.
  • Keep QailBuildError structured; broad string conversion is no longer part of the stable API.
  • Avoid raw SQL builder APIs on the public runtime path. Session settings should use session AST commands.

Source Code

View the source on GitHub: