SQLx

🧰 The Rust SQL Toolkit


Crates.io version Download docs.rs docs actions status


Built with ❤️ by The LaunchBadge team


SQLx is a modern SQL client built from the ground up for Rust, in Rust.

Examples

The sqlx::query function provides general-purpose prepared statement execution. The result is an implementation of the Row trait. Values can be efficiently accessed by index or name.

```rust let row = sqlx::query("SELECT isactive FROM users WHERE id = ?") .bind(someuserid) .fetchone(&mut conn) .await?;

let isactive: bool = row.get("isactive"); ```

The sqlx::query! macro prepares the SQL query and interprets the result in order to constrain input types and infer output types. The result of query! is an anoymous struct (or named tuple).

rust let countries = sqlx::query!( "SELECT country, COUNT(*) FROM users GROUP BY country WHERE organization = ?", organization ) .fetch(&mut conn) // -> impl Stream<Item = { country: String, count: i64 }> .map_ok(|rec| (rec.country, rec.count)) .collect::<HashMap<_>>() // -> HashMap<String, i64> .await?;

See the beginnings of a RealWorld implementation in examples/realworld-postgres.

Safety

This crate uses #[forbid(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.