1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
//! Support crate for SQLx's proc macros.
//!
//! ### Note: Semver Exempt API
//! The API of this crate is not meant for general use and does *not* follow Semantic Versioning.
//! The only crate that follows Semantic Versioning in the project is the `sqlx` crate itself.
//! If you are building a custom SQLx driver, you should pin an exact version of this and
//! `sqlx-core` to avoid breakages:
//!
//! ```toml
//! sqlx-core = "=0.6.2"
//! sqlx-macros-core = "=0.6.2"
//! ```
//!
//! And then make releases in lockstep with `sqlx-core`. We recommend all driver crates, in-tree
//! or otherwise, use the same version numbers as `sqlx-core` to avoid confusion.
#![cfg_attr(
any(sqlx_macros_unstable, procmacro2_semver_exempt),
feature(track_path)
)]
#[cfg(feature = "macros")]
use crate::query::QueryDriver;
pub type Error = Box<dyn std::error::Error>;
pub type Result<T> = std::result::Result<T, Error>;
mod common;
mod database;
#[cfg(feature = "derive")]
pub mod derives;
#[cfg(feature = "macros")]
pub mod query;
#[cfg(feature = "macros")]
// The compiler gives misleading help messages about `#[cfg(test)]` when this is just named `test`.
pub mod test_attr;
#[cfg(feature = "migrate")]
pub mod migrate;
#[cfg(feature = "macros")]
pub const FOSS_DRIVERS: &[QueryDriver] = &[
#[cfg(feature = "mysql")]
QueryDriver::new::<sqlx_mysql::MySql>(),
#[cfg(feature = "postgres")]
QueryDriver::new::<sqlx_postgres::Postgres>(),
#[cfg(feature = "sqlite")]
QueryDriver::new::<sqlx_sqlite::Sqlite>(),
];
pub fn block_on<F>(f: F) -> F::Output
where
F: std::future::Future,
{
#[cfg(feature = "_rt-tokio")]
{
use once_cell::sync::Lazy;
use tokio::runtime::{self, Runtime};
// We need a single, persistent Tokio runtime since we're caching connections,
// otherwise we'll get "IO driver has terminated" errors.
static TOKIO_RT: Lazy<Runtime> = Lazy::new(|| {
runtime::Builder::new_current_thread()
.enable_all()
.build()
.expect("failed to start Tokio runtime")
});
TOKIO_RT.block_on(f)
}
#[cfg(all(feature = "_rt-async-std", not(feature = "tokio")))]
{
async_std::task::block_on(f)
}
#[cfg(not(any(feature = "_rt-async-std", feature = "tokio")))]
sqlx_core::rt::missing_rt(f)
}