SQLx
🧰 The Rust SQL ToolkitInstall | Usage | Docs | Ecosystem | Discord
Built with ❤️ by The LaunchBadge team
Have a question? Be sure to check the FAQ first!
SQLx is an async, pure Rust† SQL crate featuring compile-time checked queries without a DSL.
Truly Asynchronous. Built from the ground-up using async/await for maximum concurrency.
Compile-time checked queries (if you want). See SQLx is not an ORM.
Database Agnostic. Support for PostgreSQL, MySQL, MariaDB, SQLite.
- MSSQL was supported prior to version 0.7, but has been removed pending a full rewrite of the driver as part of our SQLx Pro initiative.
Pure Rust. The Postgres and MySQL/MariaDB drivers are written in pure Rust using zero unsafe†† code.
Runtime Agnostic. Works on different runtimes (
async-std/tokio/actix) and TLS backends (native-tls,rustls).
† The SQLite driver uses the libsqlite3 C library as SQLite is an embedded database (the only way we could be pure Rust for SQLite is by porting all of SQLite to Rust).
†† SQLx uses #![forbid(unsafe_code)] unless the sqlite feature is enabled.
The SQLite driver directly invokes the SQLite3 API via libsqlite3-sys, which requires unsafe.
Cross-platform. Being native Rust, SQLx will compile anywhere Rust is supported.
Built-in connection pooling with
sqlx::Pool.Row streaming. Data is read asynchronously from the database and decoded on demand.
Automatic statement preparation and caching. When using the high-level query API (
sqlx::query), statements are prepared and cached per connection.Simple (unprepared) query execution including fetching results into the same
Rowtypes used by the high-level API. Supports batch execution and returns results from all statements.Transport Layer Security (TLS) where supported (MySQL, MariaDB and PostgreSQL).
Asynchronous notifications using
LISTENandNOTIFYfor PostgreSQL.Nested transactions with support for save points.
Anydatabase driver for changing the database driver at runtime. AnAnyPoolconnects to the driver indicated by the URL scheme.
Install
SQLx is compatible with the async-std, tokio, and actix runtimes; and, the native-tls and rustls TLS backends. When adding the dependency, you must choose a runtime feature that is runtime + tls.
# Cargo.toml
[dependencies]
# PICK ONE OF THE FOLLOWING:
# tokio (no TLS)
sqlx = { version = "0.9", features = [ "runtime-tokio" ] }
# tokio + native-tls
sqlx = { version = "0.9", features = [ "runtime-tokio", "tls-native-tls" ] }
# tokio + rustls with ring and WebPKI CA certificates
sqlx = { version = "0.9", features = [ "runtime-tokio", "tls-rustls-ring-webpki" ] }
# tokio + rustls with ring and platform's native CA certificates
sqlx = { version = "0.9", features = [ "runtime-tokio", "tls-rustls-ring-native-roots" ] }
# tokio + rustls with aws-lc-rs
sqlx = { version = "0.9", features = [ "runtime-tokio", "tls-rustls-aws-lc-rs" ] }
# async-std (no TLS)
sqlx = { version = "0.9", features = [ "runtime-async-std" ] }
# async-std + native-tls
sqlx = { version = "0.9", features = [ "runtime-async-std", "tls-native-tls" ] }
# async-std + rustls with ring and WebPKI CA certificates
sqlx = { version = "0.9", features = [ "runtime-async-std", "tls-rustls-ring-webpki" ] }
# async-std + rustls with ring and platform's native CA certificates
sqlx = { version = "0.9", features = [ "runtime-async-std", "tls-rustls-ring-native-roots" ] }
# async-std + rustls with aws-lc-rs
sqlx = { version = "0.9", features = [ "runtime-async-std", "tls-rustls-aws-lc-rs" ] }
Cargo Feature Flags
For backward-compatibility reasons, the runtime and TLS features can either be chosen together as a single feature, or separately.
For forward compatibility, you should use the separate runtime and TLS features as the combination features may be removed in the future.
runtime-async-std: Use theasync-stdruntime without enabling a TLS backend.runtime-tokio: Use thetokioruntime without enabling a TLS backend.- Actix-web is fully compatible with Tokio and so a separate runtime feature is no longer needed.
tls-native-tls: Use thenative-tlsTLS backend (OpenSSL on *nix, SChannel on Windows, Secure Transport on macOS).tls-rustls: Use therustlsTLS backend (cross-platform backend, only supports TLS 1.2 and 1.3).tls-rustls-aws-lc-rs: Use therustlsTLS backend withaws-lc-rs.postgres: Add support for the Postgres database server.mysql: Add support for the MySQL/MariaDB database server.Note: RSA auth without TLS requires
mysql-rsa(not enabled bymysql).mysql-rsa: Enable RSA password encryption forcaching_sha2_password/sha256_passwordwhen TLS is off. Only enable it if you must connect without TLS to servers that require RSA auth. Prefer using TLS.mssql: Add support for the MSSQL database server.sqlite: Add support for the self-contained SQLite database engine with SQLite bundled and statically-linked.sqlite-unbundled: The same as above (sqlite), but link SQLite from the system instead of the bundled version.- Allows updating SQLite independently of SQLx or using forked versions.
- You must have SQLite installed on the system or provide a path to the library at build time.
See the
rusqliteREADME for details. - May result in link errors if the SQLite version is too old. Version
3.20.0or newer is recommended. - Can increase build time due to the use of bindgen.
sqlite-preupdate-hook: enables SQLite's preupdate hook API.- Exposed as a separate feature because it's generally not enabled by default.
- Using this feature with
sqlite-unbundledmay cause linker failures if the system SQLite version does not support it.
any: Add support for theAnydatabase driver, which can proxy to a database driver at runtime.derive: Add support for the derive family macros, those areFromRow,Type,Encode,Decode.macros: Add support for thequery*!macros, which allows compile-time checked queries.migrate: Add support for the migration management andmigrate!macro, which allow compile-time embedded migrations.uuid: Add support for UUID.chrono: Add support for date and time types fromchrono.time: Add support for date and time types fromtimecrate (alternative tochrono, which is preferred byquery!macro, if both enabled)