sea-orm/src/query/traits.rs
ForzenString 744e063222 add SelectColumns only modify select columns
add `PartialModelTrait` for a part of model

re-export `PartialModelTrait`

cargo fmt

add fn`into_partial_model` on `Select`&`SelectTwo`

add `DerivePartialModel` to impl `PartialModel`

add macro `DerivePartialModel` to `sea-orm`

disambiguate `SelectColumns` function

fix macro error

cargo fmt && cargo clippy

move `SelectColumns` from helper.rs to traits.rs

cargo fmt

Reduce nest hell of load attribute argument fetch

 test `DerivePartialModel`  input parse

`DerivePartialModel` not derive with generic

fix `DerivePartialModel` code generate error

remove unused use

cargo fmt

add `into_partial_model` for `SelectTwoMany`
2023-04-26 18:28:44 +08:00

91 lines
2.7 KiB
Rust

use crate::{ColumnTrait, DbBackend, IntoIdentity, IntoSimpleExpr, QuerySelect, Statement};
use sea_query::QueryStatementBuilder;
/// A Trait for any type performing queries on a Model or ActiveModel
pub trait QueryTrait {
/// Constrain the QueryStatement to [QueryStatementBuilder] trait
type QueryStatement: QueryStatementBuilder;
/// Get a mutable ref to the query builder
fn query(&mut self) -> &mut Self::QueryStatement;
/// Get an immutable ref to the query builder
fn as_query(&self) -> &Self::QueryStatement;
/// Take ownership of the query builder
fn into_query(self) -> Self::QueryStatement;
/// Build the query as [`Statement`]
fn build(&self, db_backend: DbBackend) -> Statement {
let query_builder = db_backend.get_query_builder();
Statement::from_string_values_tuple(
db_backend,
self.as_query().build_any(query_builder.as_ref()),
)
}
/// Apply an operation on the [QueryTrait::QueryStatement] if the given `Option<T>` is `Some(_)`
///
/// # Example
///
/// ```
/// use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};
///
/// assert_eq!(
/// cake::Entity::find()
/// .apply_if(Some(3), |mut query, v| {
/// query.filter(cake::Column::Id.eq(v))
/// })
/// .apply_if(Some(100), QuerySelect::limit)
/// .apply_if(None, QuerySelect::offset::<Option<u64>>) // no-op
/// .build(DbBackend::Postgres)
/// .to_string(),
/// r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "cake"."id" = 3 LIMIT 100"#
/// );
/// ```
fn apply_if<T, F>(self, val: Option<T>, if_some: F) -> Self
where
Self: Sized,
F: FnOnce(Self, T) -> Self,
{
if let Some(val) = val {
if_some(self, val)
} else {
self
}
}
}
/// Select specific column for partial model queries
pub trait SelectColumns {
/// Add a select column
///
/// For more detail, please visit [QuerySelect::column]
fn select_column<C: ColumnTrait>(self, col: C) -> Self;
/// Add a select column with alias
///
/// For more detail, please visit [QuerySelect::column_as]
fn select_column_as<C, I>(self, col: C, alias: I) -> Self
where
C: IntoSimpleExpr,
I: IntoIdentity;
}
impl<S> SelectColumns for S
where
S: QuerySelect,
{
fn select_column<C: ColumnTrait>(self, col: C) -> Self {
QuerySelect::column(self, col)
}
fn select_column_as<C, I>(self, col: C, alias: I) -> Self
where
C: IntoSimpleExpr,
I: IntoIdentity,
{
QuerySelect::column_as(self, col, alias)
}
}