Skip to main content

Update

Struct Update 

Source
pub struct Update<M> { /* private fields */ }
Expand description

A bulk UPDATE over model M, created with Model::update_all or Select::update.

Managed columns are maintained automatically unless you set them yourself: updated_at = now() for models with timestamps and version = version + 1 for models with optimistic locking. Soft-deleted rows are skipped unless the query used with_trashed/only_trashed.

Implementations§

Source§

impl<M> Update<M>
where M: Model,

Source

pub fn all_tenants(self) -> Update<M>

Update every tenant’s rows, ignoring the current tenant scope.

Source

pub fn unscoped(self) -> Update<M>

Ignore the model’s default scope.

Source

pub fn filter(self, expr: Expr<M>) -> Update<M>

Add a WHERE condition. Multiple calls are combined with AND.

Source

pub fn with_trashed(self) -> Update<M>

Also update soft-deleted rows.

Source

pub fn set(self, column: Column<M>, value: impl Into<Value>) -> Update<M>

SET column = value

Source

pub fn set_raw<V>( self, column: Column<M>, sql: impl Into<String>, params: impl IntoIterator<Item = V>, ) -> Update<M>
where V: Into<Value>,

SET column = <raw sql>, binding each ? to the next parameter.

ⓘ
Post::update_all().set_raw(Post::PUBLISHED_AT, "now()", [] as [i32; 0])
Source

pub fn increment(self, column: Column<M>, by: impl Into<Value>) -> Update<M>

SET column = column + by

Source

pub fn decrement(self, column: Column<M>, by: impl Into<Value>) -> Update<M>

SET column = column - by

Source

pub fn to_sql(&self) -> Sql

Render the UPDATE statement.

Source

pub async fn exec<'e, E>(self, executor: E) -> Result<u64, Error>
where E: Executor<'e>,

Run the update and return the number of affected rows.

Source

pub async fn returning<'e, E>(self, executor: E) -> Result<Vec<M>, Error>
where E: Executor<'e>,

Run the update and return the updated rows.

Trait Implementations§

Source§

impl<M> Clone for Update<M>

Source§

fn clone(&self) -> Update<M>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M> Debug for Update<M>
where M: Model,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M> !RefUnwindSafe for Update<M>

§

impl<M> !UnwindSafe for Update<M>

§

impl<M> Freeze for Update<M>
where PhantomData<fn() -> M>: Freeze,

§

impl<M> Send for Update<M>
where PhantomData<fn() -> M>: Send,

§

impl<M> Sync for Update<M>
where PhantomData<fn() -> M>: Sync,

§

impl<M> Unpin for Update<M>
where PhantomData<fn() -> M>: Unpin,

§

impl<M> UnsafeUnpin for Update<M>
where PhantomData<fn() -> M>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<M> InScope<(M, ()), Here> for M

Source§

impl<M, Rest, N> InScope<(M, (Rest, N)), Last> for N

Source§

impl<X, M, Rest, N, I> InScope<(M, (Rest, N)), There<I>> for X
where X: InScope<(M, Rest), I>,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more