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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
use std::pin::Pin;
use futures::stream::Stream;
use futures::stream::TryCollect;
use futures::Future;
use futures::{future, TryFutureExt, TryStreamExt};
use sqlx::database::HasArguments;
use sqlx::query::QueryAs;
use sqlx::{Database, Encode, Executor, FromRow, IntoArguments, Type};
/// Type alias for methods returning a single element. The future resolves to and
/// `Result<T, sqlx::Error>`.
pub type CrudFut<'e, T> = Pin<Box<dyn Future<Output = Result<T, sqlx::Error>> + 'e>>;
/// Type alias for a [`Stream`] returning items of type `Result<T, sqlxError>`.
pub type CrudStream<'e, T> =
Pin<Box<dyn Stream<Item = Result<T, sqlx::Error>> + std::marker::Send + 'e>>;
/// Type alias for a [`TryCollect`] future that resolves to `Result<Vec<T>, sqlx::Error>`.
pub type TryCollectFut<'e, T> = TryCollect<CrudStream<'e, T>, Vec<T>>;
/// Database schema information about a struct implementing sqlx [FromRow].
/// [Schema] defines methods for accessing the derived database schema
/// and query information.
///
/// This trait is implemented by the [SqlxCrud] derive macro.
///
/// # Example
///
/// ```rust
/// use sqlx::FromRow;
/// use sqlx_crud::SqlxCrud;
///
/// #[derive(FromRow, SqlxCrud)]
/// pub struct User {
/// user_id: i32,
/// name: String,
/// }
/// ```
///
/// [FromRow]: https://docs.rs/sqlx/latest/sqlx/trait.FromRow.html
pub trait Schema {
/// Type of the table primary key column.
type Id: Send;
/// Database name of the table. Used by the query generation code and
/// available for introspection. This is generated by taking the plural
/// _snake_case_ of the struct's name. See: [Inflector to_table_case].
///
/// ```rust
/// use sqlx::FromRow;
/// use sqlx_crud::{Schema, SqlxCrud};
///
/// #[derive(FromRow, SqlxCrud)]
/// struct GoogleIdToken {
/// id: i32,
/// audience: String,
/// }
///
/// assert_eq!("google_id_tokens", GoogleIdToken::table_name());
/// ```
///
/// [Inflector to_table_case]: https://docs.rs/Inflector/latest/inflector/cases/tablecase/fn.to_table_case.html
fn table_name() -> &'static str;
/// Returns the id of the current instance.
fn id(&self) -> Self::Id;
/// Returns the column name of the primary key.
fn id_column() -> &'static str;
/// Returns an array of column names.
fn columns() -> &'static [&'static str];
/// Returns the SQL string for a SELECT query against the table.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Schema;
///
/// assert_eq!(r#"SELECT "users"."user_id", "users"."name" FROM "users""#, User::select_sql());
/// # }}
/// ```
fn select_sql() -> &'static str;
/// Returns the SQL string for a SELECT query against the table with a
/// WHERE clause for the primary key.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Schema;
///
/// assert_eq!(
/// r#"SELECT "users"."user_id", "users"."name" FROM "users" WHERE "users"."user_id" = ? LIMIT 1"#,
/// User::select_by_id_sql()
/// );
/// # }}
/// ```
fn select_by_id_sql() -> &'static str;
/// Returns the SQL for inserting a new record in to the database. The
/// `#[external_id]` attribute may be used to specify IDs are assigned
/// outside of the database.
///
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx::FromRow;
/// use sqlx_crud::{Schema, SqlxCrud};
///
/// #[derive(Debug, FromRow, SqlxCrud)]
/// #[external_id]
/// pub struct UserExternalId {
/// pub user_id: i32,
/// pub name: String,
/// }
///
/// assert_eq!(r#"INSERT INTO "users" ("name") VALUES (?) RETURNING "users"."user_id", "users"."name""#, User::insert_sql());
/// assert_eq!(r#"INSERT INTO "user_external_ids" ("user_id", "name") VALUES (?, ?) RETURNING "user_external_ids"."user_id", "user_external_ids"."name""#, UserExternalId::insert_sql());
/// # }}
/// ```
fn insert_sql() -> &'static str;
/// Returns the SQL for updating an existing record in the database.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Schema;
///
/// assert_eq!(r#"UPDATE "users" SET "name" = ? WHERE "users"."user_id" = ? RETURNING "users"."user_id", "users"."name""#, User::update_by_id_sql());
/// # }}
/// ```
fn update_by_id_sql() -> &'static str;
/// Returns the SQL for deleting an existing record by ID from the database.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Schema;
///
/// assert_eq!(r#"DELETE FROM "users" WHERE "users"."user_id" = ?"#, User::delete_by_id_sql());
/// # }}
/// ```
fn delete_by_id_sql() -> &'static str;
}
/// Common Create, Read, Update, and Delete behaviors. This trait requires that
/// [Schema] and [FromRow] are implemented for Self.
///
/// This trait is implemented by the [SqlxCrud] derive macro. Implementors
/// define how to assign query insert and update bindings.
///
/// [FromRow]: https://docs.rs/sqlx/latest/sqlx/trait.FromRow.html
/// [Schema]: trait.Schema.html
/// [SqlxCrud]: ../derive.SqlxCrud.html
pub trait Crud<'e, E>
where
Self: 'e + Sized + Send + Unpin + for<'r> FromRow<'r, <E::Database as Database>::Row> + Schema,
<Self as Schema>::Id:
Encode<'e, <E as Executor<'e>>::Database> + Type<<E as Executor<'e>>::Database>,
E: Executor<'e> + 'e,
<E::Database as HasArguments<'e>>::Arguments: IntoArguments<'e, <E as Executor<'e>>::Database>,
{
/// Given a query returns a new query with parameters suitable for an
/// INSERT bound to it. The [SqlxCrud] implementation will bind the
/// primary key, and each additional field to the query.
///
/// # Example
///
/// Typically you would just use `<Self as Crud>::insert()` but if you
/// wanted to modify the query you could use something like:
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::{Crud, Schema};
///
/// let user = User { user_id: 1, name: "Test".to_string() };
/// let query = sqlx::query_as::<_, User>(User::insert_sql());
/// let query = user.insert_binds(query);
/// let user = query.fetch_one(&pool).await?;
/// assert_eq!("Test", user.name);
///
/// # }}
/// ```
///
/// This would bind `user_id`, `name` to the query in that order.
///
/// [SqlxCrud]: ../derive.SqlxCrud.html
fn insert_binds(
&'e self,
query: QueryAs<'e, E::Database, Self, <E::Database as HasArguments<'e>>::Arguments>,
) -> QueryAs<'e, E::Database, Self, <E::Database as HasArguments<'e>>::Arguments>;
/// Given a query returns a new query with parameters suitable for an
/// UPDATE bound to it. The [SqlxCrud] implementation will bind every
/// column except for the primary key followed by the primary key to
/// the query.
///
/// # Example
///
/// Typically you would just use `<Self as Crud>::update()` but if you
/// wanted to modify the query you could use something like:
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::{Crud, Schema};
///
/// let user = User { user_id: 1, name: "other".to_string() };
/// let query = sqlx::query_as::<_, User>(User::update_by_id_sql());
/// let query = user.update_binds(query);
/// let user = query.fetch_one(&pool).await?;
/// assert_eq!("other", user.name);
///
/// # }}
/// ```
///
/// This would bind `name`, `user_id` to the query in that order.
///
/// [SqlxCrud]: ../derive.SqlxCrud.html
fn update_binds(
&'e self,
query: QueryAs<'e, E::Database, Self, <E::Database as HasArguments<'e>>::Arguments>,
) -> QueryAs<'e, E::Database, Self, <E::Database as HasArguments<'e>>::Arguments>;
/// Returns a future that resolves to an insert or `sqlx::Error` of the
/// current instance.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::{Crud, Schema};
///
/// let user = User { user_id: 1, name: "test".to_string() };
/// let user = user.create(&pool).await?;
/// assert_eq!("test", user.name);
/// # }}
/// ```
fn create(&'e self, pool: E) -> CrudFut<'e, Self> {
Box::pin(async move {
let query = sqlx::query_as::<E::Database, Self>(<Self as Schema>::insert_sql());
let query = self.insert_binds(query);
let r = query.fetch_one(pool).await?;
Ok(r)
})
}
/// Queries all records from the table and returns a future that returns
/// to a [try_collect] stream, which resolves to a `Vec<Self>` or a
/// `sqlx::Error` on error.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Crud;
///
/// let all_users: Vec<User> = User::all(&pool).await?;
/// # }}
/// ```
///
/// [try_collect]: https://docs.rs/futures/latest/futures/stream/trait.TryStreamExt.html#method.try_collect
fn all(pool: E) -> TryCollectFut<'e, Self> {
let stream =
sqlx::query_as::<E::Database, Self>(<Self as Schema>::select_sql()).fetch(pool);
stream.try_collect()
}
#[doc(hidden)]
fn paged(_pool: E) -> TryCollectFut<'e, Self> {
unimplemented!()
}
/// Looks up a row by ID and returns a future that resolves an
/// `Option<Self>`. Returns `None` if and a record with the corresponding ID
/// cannot be found and `Some` if it exists.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Crud;
///
/// let user: Option<User> = User::by_id(&pool, 1).await?;
/// assert!(user.is_some());
/// # }}
/// ```
fn by_id(pool: E, id: <Self as Schema>::Id) -> CrudFut<'e, Option<Self>> {
Box::pin(
sqlx::query_as::<E::Database, Self>(<Self as Schema>::select_by_id_sql())
.bind(id)
.fetch_optional(pool),
)
}
/// Updates the database with the current instance state and returns a
/// future that resolves an `()` on success and `sqlx::Error` on error.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Crud;
///
/// if let Some(mut user) = User::by_id(&pool, 1).await? {
/// user.name = "Harry".to_string();
/// let user = user.update(&pool).await?;
/// assert_eq!("Harry", user.name);
/// }
/// # }}
/// ```
fn update(&'e self, pool: E) -> CrudFut<'e, Self> {
Box::pin(async move {
let query = sqlx::query_as::<E::Database, Self>(<Self as Schema>::update_by_id_sql());
let query = self.update_binds(query);
let r = query.fetch_one(pool).await?;
Ok(r)
})
}
/// Deletes a record from the database by ID and returns a future that
/// resolves to `()` on success or `sqlx::Error` on failure.
///
/// # Example
///
/// ```rust
/// # sqlx_crud::doctest_setup! { |pool| {
/// use sqlx_crud::Crud;
///
/// if let Some(user) = User::by_id(&pool, 1).await? {
/// user.delete(&pool).await?;
/// }
/// assert!(User::by_id(&pool, 1).await?.is_none());
/// # }}
/// ```
fn delete(self, pool: E) -> CrudFut<'e, ()> {
let query = sqlx::query(<Self as Schema>::delete_by_id_sql()).bind(self.id());
Box::pin(query.execute(pool).and_then(|_| future::ok(())))
}
}