Struct UpdateQuery 

pub struct UpdateQuery {
    pub with: With,
    pub table: TableRef,
    pub set: Set,
    pub from: TableRef,
    pub extra_from: Vec<TableRef>,
    pub where_: Where,
    pub returning: Returning,
}

A PostgreSQL UPDATE.

From https://www.postgresql.org/docs/17/sql-update.html:

[ WITH [ RECURSIVE ] with_query [, ...] ]
UPDATE [ ONLY ] table_name [ * ] [ [ AS ] alias ]
    SET { column_name = { expression | DEFAULT }
        | ( column_name [, ...] ) = [ ROW ] ( { expression | DEFAULT } [, ...] )
        | ( column_name [, ...] ) = ( sub-SELECT ) } [, ...]
    [ FROM from_item [, ...] ]
    [ WHERE condition | WHERE CURRENT OF cursor_name ]
    [ RETURNING … ]

ONLY lives on TableRef::only, because that is where the shared clause puts it and because the same flag decorates a FROM item.

The assignment list is not optional: UPDATE t with no SET is not a statement, so an empty Set is a recorded Error::Incomplete rather than a clause that renders nothing.

Fields

with: With

WITH ….

table: TableRef

The table being updated.

set: Set

SET ….

from: TableRef

The first FROM item, with its joins.

extra_from: Vec<TableRef>

Further comma-separated FROM items.

where_: Where

WHERE ….

returning: Returning

RETURNING ….

Implementations

impl UpdateQuery

pub fn new() -> UpdateQuery

An UPDATE with nothing set yet.

pub fn apply(&mut self, mods: impl Mod<UpdateQuery>)

Apply more mods to an existing query.

Trait Implementations

impl Clone for UpdateQuery

fn clone(&self) -> UpdateQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateQuery

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

Formats the value using the given formatter.

impl Default for UpdateQuery

fn default() -> UpdateQuery

Returns the “default value” for a type.

impl Expression for UpdateQuery

fn write_sql(&self, w: &mut SqlWriter<'_>)

Append this fragment to w.

impl HasExtraTables for UpdateQuery

fn extra_tables_mut(&mut self) -> &mut Vec<TableRef>

The additional from-items to modify.

impl HasJoins for UpdateQuery

fn joins_mut(&mut self) -> &mut Vec<Join>

The join list to modify.

impl HasReturning for UpdateQuery

fn returning_mut(&mut self) -> &mut Returning

The RETURNING clause to modify.

impl HasSet for UpdateQuery

fn set_mut(&mut self) -> &mut Set

The assignment list to modify.

impl HasTableRef for UpdateQuery

fn table_ref_mut(&mut self) -> &mut TableRef

The table reference to modify.

impl HasTargetTable for UpdateQuery

fn target_table_mut(&mut self) -> &mut TableRef

The target table to modify.

impl HasWhere for UpdateQuery

fn where_mut(&mut self) -> &mut Where

The WHERE clause to modify.

impl HasWith for UpdateQuery

fn with_mut(&mut self) -> &mut With

The WITH clause to modify.

impl IntoExpr for UpdateQuery

fn into_expr(self) -> Expr

Perform the conversion.

impl IntoExprList for UpdateQuery

fn into_expr_list(self) -> Vec<Expr>

Perform the conversion.

impl Query for UpdateQuery

fn query_type(&self) -> QueryType

Which statement this renders.

fn dialect(&self) -> &dyn Dialect

The dialect this query renders itself in.

fn build(&self) -> Result<(String, Vec<Value>), Error>

Render to SQL and arguments, numbering placeholders from 1.

fn build_from(&self, start: usize) -> Result<(String, Vec<Value>), Error>

build with a different first placeholder position, for splicing into a statement that already has arguments — bob’s BuildN.

impl<H, L, M> QueryExtensions<H, L, M> for UpdateQuery

fn hooks(&self) -> &[Hook]

Hooks to run before this query executes.

fn loaders(&self) -> &[Loader]

Loaders to run after this query executes, for eagerly loaded relations.

fn mapper_mods(&self) -> &[MapperMod]

Adjustments to the row mapper, for relations loaded in the same query.