Struct sea_query::query::Returning

pub struct Returning;

Shorthand for constructing ReturningClause

Implementations

impl Returning

pub fn new() -> Self

Constructs a new Returning.

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 *"#
);

pub fn column<C>(&self, col: C) -> ReturningClausewhere
    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""#
);

pub fn columns<T, I>(self, cols: I) -> ReturningClausewhere
    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""#
);

pub fn expr<T>(&self, expr: T) -> ReturningClausewhere
    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""#
);

pub fn exprs<T, I>(self, exprs: I) -> ReturningClausewhere
    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

impl Clone for Returning

fn clone(&self) -> Returning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Returning

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

Formats the value using the given formatter.

impl Default for Returning

fn default() -> Returning

Returns the “default value” for a type.