Struct sea_query::query::Returning

source ยท
pub struct Returning;
Expand description

Shorthand for constructing ReturningClause

Implementationsยง

sourceยง

impl Returning

source

pub fn new() -> Self

Constructs a new Returning.

source

pub fn all(&self) -> ReturningClause

Constructs a new ReturningClause::All.

Examples
use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::returning().all())
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING *"#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING *"#
);
source

pub fn column<C>(&self, col: C) -> ReturningClause
where C: IntoColumnRef,

Constructs a new ReturningClause::Columns.

Examples
use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::returning().column(Glyph::Id))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
source

pub fn columns<T, I>(self, cols: I) -> ReturningClause
where T: IntoColumnRef, I: IntoIterator<Item = T>,

Constructs a new ReturningClause::Columns.

Examples
use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::returning().columns([Glyph::Id, Glyph::Image]))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id", "image""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id", "image""#
);
source

pub fn expr<T>(&self, expr: T) -> ReturningClause
where T: Into<SimpleExpr>,

Constructs a new ReturningClause::Exprs.

Examples
use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::returning().expr(Expr::col(Glyph::Id)))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
source

pub fn exprs<T, I>(self, exprs: I) -> ReturningClause
where T: Into<SimpleExpr>, I: IntoIterator<Item = T>,

Constructs a new ReturningClause::Exprs.

Examples
use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::returning().exprs([Expr::col(Glyph::Id), Expr::col(Glyph::Image)]))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id", "image""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id", "image""#
);

Trait Implementationsยง

sourceยง

impl Clone for Returning

sourceยง

fn clone(&self) -> Returning

Returns a copy of the value. Read more
1.0.0 ยท sourceยง

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
sourceยง

impl Debug for Returning

sourceยง

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
sourceยง

impl Default for Returning

sourceยง

fn default() -> Returning

Returns the โ€œdefault valueโ€ for a type. Read more

Auto Trait Implementationsยง

Blanket Implementationsยง

sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
sourceยง

impl<T> From<T> for T

sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

sourceยง

impl<T> ToOwned for T
where T: Clone,

ยง

type Owned = T

The resulting type after obtaining ownership.
sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

ยง

type Error = Infallible

The type returned in the event of a conversion error.
sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

ยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.