pub struct Select<E>where
E: EntityTrait,{ /* private fields */ }
Expand description
Defines a structure to perform select operations
Implementations§
§impl<E> Select<E>where
E: EntityTrait,
impl<E> Select<E>where E: EntityTrait,
pub fn from_raw_sql(
self,
stmt: Statement
) -> SelectorRaw<SelectModel<<E as EntityTrait>::Model>>
pub fn from_raw_sql( self, stmt: Statement ) -> SelectorRaw<SelectModel<<E as EntityTrait>::Model>>
Perform a Select operation on a Model using a Statement
pub fn into_model<M>(self) -> Selector<SelectModel<M>>where
M: FromQueryResult,
pub fn into_model<M>(self) -> Selector<SelectModel<M>>where M: FromQueryResult,
Return a Selector from Self
that wraps a SelectModel
pub fn into_values<T, C>(self) -> Selector<SelectGetableValue<T, C>>where
T: TryGetableMany,
C: IntoEnumIterator + Iden,
pub fn into_values<T, C>(self) -> Selector<SelectGetableValue<T, C>>where T: TryGetableMany, C: IntoEnumIterator + Iden,
use sea_orm::{entity::*, query::*, tests_cfg::cake, DeriveColumn, EnumIter};
#[derive(Copy, Clone, Debug, EnumIter, DeriveColumn)]
enum QueryAs {
CakeName,
}
let res: Vec<String> = cake::Entity::find()
.select_only()
.column_as(cake::Column::Name, QueryAs::CakeName)
.into_values::<_, QueryAs>()
.all(&db)
.await?;
assert_eq!(
res,
vec!["Chocolate Forest".to_owned(), "New York Cheese".to_owned()]
);
assert_eq!(
db.into_transaction_log(),
vec![Transaction::from_sql_and_values(
DbBackend::Postgres,
r#"SELECT "cake"."name" AS "cake_name" FROM "cake""#,
vec![]
)]
);
use sea_orm::{entity::*, query::*, tests_cfg::cake, DeriveColumn, EnumIter};
#[derive(Copy, Clone, Debug, EnumIter, DeriveColumn)]
enum QueryAs {
CakeName,
NumOfCakes,
}
let res: Vec<(String, i64)> = cake::Entity::find()
.select_only()
.column_as(cake::Column::Name, QueryAs::CakeName)
.column_as(cake::Column::Id.count(), QueryAs::NumOfCakes)
.group_by(cake::Column::Name)
.into_values::<_, QueryAs>()
.all(&db)
.await?;
assert_eq!(res, vec![("Chocolate Forest".to_owned(), 2i64)]);
assert_eq!(
db.into_transaction_log(),
vec![Transaction::from_sql_and_values(
DbBackend::Postgres,
vec![
r#"SELECT "cake"."name" AS "cake_name", COUNT("cake"."id") AS "num_of_cakes""#,
r#"FROM "cake" GROUP BY "cake"."name""#,
]
.join(" ")
.as_str(),
vec![]
)]
);
pub async fn one<'a, C>(
self,
db: &C
) -> impl Future<Output = Result<Option<<E as EntityTrait>::Model>, DbErr>>where
C: ConnectionTrait,
pub async fn one<'a, C>( self, db: &C ) -> impl Future<Output = Result<Option<<E as EntityTrait>::Model>, DbErr>>where C: ConnectionTrait,
Get one Model from the SELECT query
pub async fn all<'a, C>(
self,
db: &C
) -> impl Future<Output = Result<Vec<<E as EntityTrait>::Model, Global>, DbErr>>where
C: ConnectionTrait,
pub async fn all<'a, C>( self, db: &C ) -> impl Future<Output = Result<Vec<<E as EntityTrait>::Model, Global>, DbErr>>where C: ConnectionTrait,
Get all Models from the SELECT query
pub async fn stream<'a, 'b, C>(
self,
db: &'a C
) -> impl Future<Output = Result<impl Stream<Item = Result<<E as EntityTrait>::Model, DbErr>> + Send + 'b, DbErr>>where
'a: 'b,
C: ConnectionTrait + StreamTrait<'a> + Send,
pub async fn stream<'a, 'b, C>( self, db: &'a C ) -> impl Future<Output = Result<impl Stream<Item = Result<<E as EntityTrait>::Model, DbErr>> + Send + 'b, DbErr>>where 'a: 'b, C: ConnectionTrait + StreamTrait<'a> + Send,
Stream the results of a SELECT operation on a Model
§impl<E> Select<E>where
E: EntityTrait,
impl<E> Select<E>where E: EntityTrait,
pub fn select_also<F>(self, _: F) -> SelectTwo<E, F>where
F: EntityTrait,
pub fn select_also<F>(self, _: F) -> SelectTwo<E, F>where F: EntityTrait,
Selects and Entity and returns it together with the Entity from Self
pub fn select_with<F>(self, _: F) -> SelectTwoMany<E, F>where
F: EntityTrait,
pub fn select_with<F>(self, _: F) -> SelectTwoMany<E, F>where F: EntityTrait,
Makes a SELECT operation in conjunction to another relation
§impl<E> Select<E>where
E: EntityTrait,
impl<E> Select<E>where E: EntityTrait,
pub fn left_join<R>(self, _: R) -> Select<E>where
R: EntityTrait,
E: Related<R>,
pub fn left_join<R>(self, _: R) -> Select<E>where R: EntityTrait, E: Related<R>,
Left Join with a Related Entity.
pub fn right_join<R>(self, _: R) -> Select<E>where
R: EntityTrait,
E: Related<R>,
pub fn right_join<R>(self, _: R) -> Select<E>where R: EntityTrait, E: Related<R>,
Right Join with a Related Entity.
pub fn inner_join<R>(self, _: R) -> Select<E>where
R: EntityTrait,
E: Related<R>,
pub fn inner_join<R>(self, _: R) -> Select<E>where R: EntityTrait, E: Related<R>,
Inner Join with a Related Entity.
pub fn reverse_join<R>(self, _: R) -> Select<E>where
R: EntityTrait + Related<E>,
pub fn reverse_join<R>(self, _: R) -> Select<E>where R: EntityTrait + Related<E>,
Join with an Entity Related to me.
Left Join with a Related Entity and select both Entity.
Left Join with a Related Entity and select the related Entity as a Vec
pub fn find_also_linked<L, T>(self, l: L) -> SelectTwo<E, T>where
L: Linked<FromEntity = E, ToEntity = T>,
T: EntityTrait,
pub fn find_also_linked<L, T>(self, l: L) -> SelectTwo<E, T>where L: Linked<FromEntity = E, ToEntity = T>, T: EntityTrait,
Left Join with a Linked Entity and select both Entity.
Trait Implementations§
§impl<E> Clone for Select<E>where
E: Clone + EntityTrait,
impl<E> Clone for Select<E>where E: Clone + EntityTrait,
§impl<E, M> CursorTrait for Select<E>where
E: EntityTrait<Model = M>,
M: FromQueryResult + Send + Sync,
impl<E, M> CursorTrait for Select<E>where E: EntityTrait<Model = M>, M: FromQueryResult + Send + Sync,
§type Selector = SelectModel<M>
type Selector = SelectModel<M>
Select operation
§fn cursor_by<C>(
self,
order_columns: C
) -> Cursor<<Select<E> as CursorTrait>::Selector>where
C: IntoIdentity,
fn cursor_by<C>( self, order_columns: C ) -> Cursor<<Select<E> as CursorTrait>::Selector>where C: IntoIdentity,
Convert current type into a cursor
§impl<E> Debug for Select<E>where
E: Debug + EntityTrait,
impl<E> Debug for Select<E>where E: Debug + EntityTrait,
§impl<'db, C, M, E> PaginatorTrait<'db, C> for Select<E>where
C: ConnectionTrait,
E: EntityTrait<Model = M>,
M: FromQueryResult + Send + Sync + 'db,
impl<'db, C, M, E> PaginatorTrait<'db, C> for Select<E>where C: ConnectionTrait, E: EntityTrait<Model = M>, M: FromQueryResult + Send + Sync + 'db,
§impl<E> QueryFilter for Select<E>where
E: EntityTrait,
impl<E> QueryFilter for Select<E>where E: EntityTrait,
type QueryStatement = SelectStatement
§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Add the query to perform a FILTER on
§fn filter<F>(self, filter: F) -> Selfwhere
F: IntoCondition,
fn filter<F>(self, filter: F) -> Selfwhere F: IntoCondition,
Add an AND WHERE expression Read more
§fn belongs_to<M>(self, model: &M) -> Selfwhere
M: ModelTrait,
fn belongs_to<M>(self, model: &M) -> Selfwhere M: ModelTrait,
Apply a where condition using the model’s primary key
§fn belongs_to_tbl_alias<M>(self, model: &M, tbl_alias: &str) -> Selfwhere
M: ModelTrait,
fn belongs_to_tbl_alias<M>(self, model: &M, tbl_alias: &str) -> Selfwhere M: ModelTrait,
Perform a check to determine table belongs to a Model through it’s name alias
§impl<E> QueryOrder for Select<E>where
E: EntityTrait,
impl<E> QueryOrder for Select<E>where E: EntityTrait,
type QueryStatement = SelectStatement
§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Add the query to perform an ORDER BY operation
§fn order_by<C>(self, col: C, ord: Order) -> Selfwhere
C: IntoSimpleExpr,
fn order_by<C>(self, col: C, ord: Order) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression Read more
§fn order_by_asc<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn order_by_asc<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression (ascending) Read more
§fn order_by_desc<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn order_by_desc<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression (descending) Read more
§impl<E> QuerySelect for Select<E>where
E: EntityTrait,
impl<E> QuerySelect for Select<E>where E: EntityTrait,
type QueryStatement = SelectStatement
§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Add the select SQL statement
§fn select_only(self) -> Self
fn select_only(self) -> Self
Clear the selection list
§fn column<C>(self, col: C) -> Selfwhere
C: ColumnTrait,
fn column<C>(self, col: C) -> Selfwhere C: ColumnTrait,
Add a select column Read more
§fn column_as<C, I>(self, col: C, alias: I) -> Selfwhere
C: IntoSimpleExpr,
I: IntoIdentity,
fn column_as<C, I>(self, col: C, alias: I) -> Selfwhere C: IntoSimpleExpr, I: IntoIdentity,
Add a select column with alias Read more
§fn group_by<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn group_by<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add a group by column Read more
§fn having<F>(self, filter: F) -> Selfwhere
F: IntoCondition,
fn having<F>(self, filter: F) -> Selfwhere F: IntoCondition,
Add an AND HAVING expression Read more
§fn join(self, join: JoinType, rel: RelationDef) -> Self
fn join(self, join: JoinType, rel: RelationDef) -> Self
Join via
RelationDef
.§fn join_rev(self, join: JoinType, rel: RelationDef) -> Self
fn join_rev(self, join: JoinType, rel: RelationDef) -> Self
Join via
RelationDef
but in reverse direction.
Assume when there exist a relation A to B.
You can reverse join B from A.§fn join_as<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere
I: IntoIden,
fn join_as<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere I: IntoIden,
Join via
RelationDef
with table alias.§fn join_as_rev<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere
I: IntoIden,
fn join_as_rev<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere I: IntoIden,
Join via
RelationDef
with table alias but in reverse direction.
Assume when there exist a relation A to B.
You can reverse join B from A.Select lock shared
§fn lock_exclusive(self) -> Self
fn lock_exclusive(self) -> Self
Select lock exclusive
§impl<E> QueryTrait for Select<E>where
E: EntityTrait,
impl<E> QueryTrait for Select<E>where E: EntityTrait,
§type QueryStatement = SelectStatement
type QueryStatement = SelectStatement
Constrain the QueryStatement to QueryStatementBuilder trait
§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Get a mutable ref to the query builder
§fn as_query(&self) -> &SelectStatement
fn as_query(&self) -> &SelectStatement
Get an immutable ref to the query builder
§fn into_query(self) -> SelectStatement
fn into_query(self) -> SelectStatement
Take ownership of the query builder
§fn build(&self, db_backend: DatabaseBackend) -> Statement
fn build(&self, db_backend: DatabaseBackend) -> Statement
Build the query as
Statement