Struct Update

pub struct Update<'a> { /* private fields */ }

Update documents matching a query. Construct with Collection::update_many or Collection::update_one.

Implementations

impl<'a> Update<'a>

pub fn session(self, value: impl Into<&'a mut ClientSession>) -> Self

Use the provided session when running the operation.

pub fn with_options(self, value: impl Into<Option<UpdateOptions>>) -> Self

Set all options. Note that this will replace all previous values set.

pub fn array_filters(self, value: impl IntoIterator<Item = Document>) -> Self

A set of filters specifying to which array elements an update should apply.

See the documentation here for more information on array filters.

pub fn bypass_document_validation(self, value: bool) -> Self

Opt out of document-level validation.

pub fn upsert(self, value: bool) -> Self

If true, insert a document if no matching document is found.

pub fn collation(self, value: Collation) -> Self

The collation to use for the operation.

See the documentation for more information on how to use this option.

pub fn hint(self, value: Hint) -> Self

A document or string that specifies the index to use to support the query predicate.

Only available in MongoDB 4.2+. See the official MongoDB documentation for examples.

pub fn write_concern(self, value: WriteConcern) -> Self

The write concern for the operation.

pub fn let_vars(self, value: Document) -> Self

Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. “$$var”).

Only available in MongoDB 5.0+.

pub fn comment(self, value: impl Into<Bson>) -> Self

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

This option is only available on server versions 4.4+.

pub fn sort(self, value: Document) -> Self

Specify which document the operation updates if the query matches multiple documents. The first document matched by the sort order will be updated.

Only available in MongoDB 8.0+.

impl<'a> Update<'a>

pub fn run(self) -> Result<UpdateResult>

Available on crate feature sync only.

Synchronously execute this action.

Trait Implementations

impl<'a> Action for Update<'a>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a> IntoFuture for Update<'a>

type Output = Result<UpdateResult, Error>

The output that the future will produce on completion.

type IntoFuture = UpdateFuture<'a>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.