API Reference
Full API documentation is generated from source code.
Rust Crates
| Crate | Description | Docs |
|---|---|---|
qail-core | AST, Builder, Parser | docs.rs |
qail-pg | PostgreSQL driver | docs.rs |
qail-gateway | Auto-REST gateway | docs.rs |
qail | CLI and tooling | docs.rs |
SDKs
| SDK | Status | Distribution |
|---|---|---|
TypeScript (@qail/client) | Supported | npm |
Swift (sdk/swift) | Supported | Source package |
Kotlin (sdk/kotlin) | Supported | Source module |
| Node.js native binding | Deferred | Not published |
| WASM binding | Deferred | Not published |
Generate Local Docs
cargo doc --no-deps --open
Key Types
qail-core
Qail- Query command builderOperator- Comparison operatorsSortOrder- ASC/DESCExpr- Expression AST nodesQailBuildError- Structured builder error type
qail-pg
PgDriver- Database connectionPgPool- Connection poolPgRow- Result rowPgError- Error types
1.0 API Notes
- Use
Qail::get/add/set/deland typed builder methods for normal database work. - Use
with_rls(&ctx)?; the oldertry_with_rls()alias is removed. - Use
join_on(...)?for schema-driven relation joins; the oldertry_join_on()alias is removed. - Use bytes-native PostgreSQL cancel-key APIs instead of legacy
i32wrappers. - Keep
QailBuildErrorstructured; 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: