sqlx-cli

Command-line utility for SQLx, the Rust SQL toolkit


Keywords
mysql, rust, postgres, sql, async, sqlite, postgresql, mariadb, mssql, await
License
Other
Install
brew install sqlx-cli

Documentation

SQLx

🧰 The Rust SQL Toolkit


Built with ❤️ by The LaunchBadge team

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

  • Truly Asynchronous. Built from the ground-up using async-std using async streams for maximum concurrency.

  • Type-safe SQL (if you want it) without DSLs. Use the query!() macro to check your SQL and bind parameters at compile time. (You can stil use dynamic SQL queries if you like.)

  • Pure Rust. The Postgres and MySQL/MariaDB drivers are written in pure Rust using zero unsafe code.

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.

let row = sqlx::query("SELECT is_active FROM users WHERE id = ?")
    .bind(some_user_id)
    .fetch_one(&mut conn)
    .await?;
    
let is_active: bool = row.get("is_active");

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).

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 beginngins of a RealWorld implementation in examples/realworld-postgres.

Safety

This crate uses #[deny(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.