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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/// Statically checked SQL query with `println!()` style syntax. /// /// This expands to an instance of [QueryAs] that outputs an ad-hoc anonymous struct type, /// if the query has output columns, or `()` (unit) otherwise: /// /// ```rust /// # #[cfg(all(feature = "mysql", feature = "runtime-async-std"))] /// # #[async_std::main] /// # async fn main() -> sqlx::Result<()>{ /// # let db_url = dotenv::var("DATABASE_URL").expect("DATABASE_URL must be set"); /// # /// # if !(db_url.starts_with("mysql") || db_url.starts_with("mariadb")) { return Ok(()) } /// # let mut conn = sqlx::MySqlConnection::open(db_url).await?; /// // let mut conn = <impl sqlx::Executor>; /// let account = sqlx::query!("select (1) as id, 'Herp Derpinson' as name") /// .fetch_one(&mut conn) /// .await?; /// /// // anonymous struct has `#[derive(Debug)]` for convenience /// println!("{:?}", account); /// println!("{}: {}", account.id, account.name); /// /// # Ok(()) /// # } /// # /// # #[cfg(any(not(feature = "mysql"), not(feature = "runtime-async-std")))] /// # fn main() {} /// ``` /// /// ## Query Arguments /// Like `println!()` and the other formatting macros, you can add bind parameters to your SQL /// and this macro will typecheck passed arguments and error on missing ones: /// /// ```rust /// # #[cfg(all(feature = "mysql", feature = "runtime-async-std"))] /// # #[async_std::main] /// # async fn main() -> sqlx::Result<()>{ /// # let db_url = dotenv::var("DATABASE_URL").expect("DATABASE_URL must be set"); /// # /// # if !(db_url.starts_with("mysql") || db_url.starts_with("mariadb")) { return Ok(()) } /// # let mut conn = sqlx::mysql::MySqlConnection::open(db_url).await?; /// // let mut conn = <impl sqlx::Executor>; /// let account = sqlx::query!( /// // just pretend "accounts" is a real table /// "select * from (select (1) as id, 'Herp Derpinson' as name) accounts where id = ?", /// 1i32 /// ) /// .fetch_one(&mut conn) /// .await?; /// /// println!("{:?}", account); /// println!("{}: {}", account.id, account.name); /// # Ok(()) /// # } /// # /// # #[cfg(any(not(feature = "mysql"), not(feature = "runtime-async-std")))] /// # fn main() {} /// ``` /// /// Bind parameters in the SQL string are specific to the database backend: /// /// * Postgres: `$N` where `N` is the 1-based positional argument index /// * MySQL: `?` which matches arguments in order that it appears in the query /// /// ## Requirements /// * The `DATABASE_URL` environment variable must be set at build-time to point to a database /// server with the schema that the query string will be checked against. (All variants of /// `query!()` use [dotenv] so this can be in a `.env` file instead.) /// /// * The query must be a string literal or else it cannot be introspected (and thus cannot /// be dynamic or the result of another macro). /// /// * The `QueryAs` instance will be bound to the same database type as `query!()` was compiled /// against (e.g. you cannot build against a Postgres database and then run the query against /// a MySQL database). /// /// * The schema of the database URL (e.g. `postgres://` or `mysql://`) will be used to /// determine the database type. /// /// [dotenv]: https://crates.io/crates/dotenv /// ## See Also /// * [query_as!] if you want to use a struct you can name, /// * [query_file!] if you want to define the SQL query out-of-line, /// * [query_file_as!] if you want both of the above. #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))] macro_rules! query ( // by emitting a macro definition from our proc-macro containing the result tokens, // we no longer have a need for `proc-macro-hack` ($query:literal) => ({ #[macro_use] mod _macro_result { $crate::sqlx_macros::query!($query); } macro_result!() }); ($query:literal, $($args:expr),*) => ({ #[macro_use] mod _macro_result { $crate::sqlx_macros::query!($query, $($args),*); } macro_result!($($args),*) }) ); /// A variant of [query!] where the SQL query is stored in a separate file. /// /// Useful for large queries and potentially cleaner than multiline strings. /// /// The syntax and requirements (see [query!]) are the same except the SQL string is replaced by a /// file path. /// /// The file must be relative to the project root (the directory containing `Cargo.toml`), /// unlike `include_str!()` which uses compiler internals to get the path of the file where it /// was invoked. /// /// ----- /// /// `examples/queries/account-by-id.sql`: /// ```sql /// select * from (select (1) as id, 'Herp Derpinson' as name) accounts /// where id = ? /// ``` /// /// `src/my_query.rs`: /// ```rust /// # #[cfg(all(feature = "mysql", feature = "runtime-async-std"))] /// # #[async_std::main] /// # async fn main() -> sqlx::Result<()>{ /// # let db_url = dotenv::var("DATABASE_URL").expect("DATABASE_URL must be set"); /// # /// # if !(db_url.starts_with("mysql") || db_url.starts_with("mariadb")) { return Ok(()) } /// # let mut conn = sqlx::MySqlConnection::open(db_url).await?; /// // let mut conn = <impl sqlx::Executor>; /// let account = sqlx::query_file!("examples/queries/account-by-id.sql", 1i32) /// .fetch_one(&mut conn) /// .await?; /// /// println!("{:?}", account); /// println!("{}: {}", account.id, account.name); /// /// # Ok(()) /// # } /// # /// # #[cfg(any(not(feature = "mysql"), not(feature = "runtime-async-std")))] /// # fn main() {} /// ``` #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))] macro_rules! query_file ( ($query:literal) => (#[allow(dead_code)]{ #[macro_use] mod _macro_result { $crate::sqlx_macros::query_file!($query); } macro_result!() }); ($query:literal, $($args:expr),*) => (#[allow(dead_code)]{ #[macro_use] mod _macro_result { $crate::sqlx_macros::query_file!($query, $($args),*); } macro_result!($($args),*) }) ); /// A variant of [query!] which takes a path to an explicitly defined struct as the output type. /// /// This lets you return the struct from a function or add your own trait implementations. /// /// No trait implementations are required; the macro maps rows using a struct literal /// where the names of columns in the query are expected to be the same as the fields of the struct /// (but the order does not need to be the same). The types of the columns are based on the /// query and not the corresponding fields of the struct, so this is type-safe as well. /// /// This enforces a few things: /// * The query must output at least one column. /// * The column names of the query must match the field names of the struct. /// * Neither the query nor the struct may have unused fields. /// /// The only modification to the syntax is that the struct name is given before the SQL string: /// ```rust /// # #[cfg(all(feature = "mysql", feature = "runtime-async-std"))] /// # #[async_std::main] /// # async fn main() -> sqlx::Result<()>{ /// # let db_url = dotenv::var("DATABASE_URL").expect("DATABASE_URL must be set"); /// # /// # if !(db_url.starts_with("mysql") || db_url.starts_with("mariadb")) { return Ok(()) } /// # let mut conn = sqlx::MySqlConnection::open(db_url).await?; /// #[derive(Debug)] /// struct Account { /// id: i32, /// name: String /// } /// /// // let mut conn = <impl sqlx::Executor>; /// let account = sqlx::query_as!( /// Account, /// "select * from (select (1) as id, 'Herp Derpinson' as name) accounts where id = ?", /// 1i32 /// ) /// .fetch_one(&mut conn) /// .await?; /// /// println!("{:?}", account); /// println!("{}: {}", account.id, account.name); /// /// # Ok(()) /// # } /// # /// # #[cfg(any(not(feature = "mysql"), not(feature = "runtime-async-std")))] /// # fn main() {} /// ``` #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))] macro_rules! query_as ( ($out_struct:path, $query:literal) => (#[allow(dead_code)] { #[macro_use] mod _macro_result { $crate::sqlx_macros::query_as!($out_struct, $query); } macro_result!() }); ($out_struct:path, $query:literal, $($args:expr),*) => (#[allow(dead_code)] { #[macro_use] mod _macro_result { $crate::sqlx_macros::query_as!($out_struct, $query, $($args),*); } macro_result!($($args),*) }) ); /// Combines the syntaxes of [query_as!] and [query_file!]. /// /// Enforces requirements of both macros; see them for details. /// /// ```rust /// # #[cfg(all(feature = "mysql", feature = "runtime-async-std"))] /// # #[async_std::main] /// # async fn main() -> sqlx::Result<()>{ /// # let db_url = dotenv::var("DATABASE_URL").expect("DATABASE_URL must be set"); /// # /// # if !(db_url.starts_with("mysql") || db_url.starts_with("mariadb")) { return Ok(()) } /// # let mut conn = sqlx::MySqlConnection::open(db_url).await?; /// #[derive(Debug)] /// struct Account { /// id: i32, /// name: String /// } /// /// // let mut conn = <impl sqlx::Executor>; /// let account = sqlx::query_file_as!(Account, "examples/queries/account-by-id.sql", 1i32) /// .fetch_one(&mut conn) /// .await?; /// /// println!("{:?}", account); /// println!("{}: {}", account.id, account.name); /// /// # Ok(()) /// # } /// # /// # #[cfg(any(not(feature = "mysql"), not(feature = "runtime-async-std")))] /// # fn main() {} /// ``` #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))] macro_rules! query_file_as ( ($out_struct:path, $query:literal) => (#[allow(dead_code)] { #[macro_use] mod _macro_result { $crate::sqlx_macros::query_file_as!($out_struct, $query); } macro_result!() }); ($out_struct:path, $query:literal, $($args:expr),*) => (#[allow(dead_code)] { #[macro_use] mod _macro_result { $crate::sqlx_macros::query_file_as!($out_struct, $query, $($args),*); } macro_result!($($args),*) }) );