Struct UpdateManyModel

#[non_exhaustive]
pub struct UpdateManyModel {
    pub namespace: Namespace,
    pub filter: Document,
    pub update: UpdateModifications,
    pub array_filters: Option<Vec<Bson>>,
    pub collation: Option<Document>,
    pub hint: Option<Bson>,
    pub upsert: Option<bool>,
}

Updates multiple documents.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

namespace: Namespace

The namespace on which the update should be performed.

filter: Document

The filter to use. All documents matching this filter will be updated.

update: UpdateModifications

The update to perform.

array_filters: Option<Vec<Bson>>

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

collation: Option<Document>

The collation to use.

hint: Option<Bson>

The index to use. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index.

upsert: Option<bool>

Whether a new document should be created if no document matches the filter.

Defaults to false.

Implementations

impl UpdateManyModel

pub fn builder() -> UpdateManyModelBuilder<((), (), (), (), (), (), ())>

Create a builder for building UpdateManyModel. On the builder, call .namespace(...), .filter(...), .update(...), .array_filters(...)(optional), .collation(...)(optional), .hint(...)(optional), .upsert(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of UpdateManyModel.

Trait Implementations

impl Clone for UpdateManyModel

fn clone(&self) -> UpdateManyModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateManyModel

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

Formats the value using the given formatter.

impl From<UpdateManyModel> for WriteModel

fn from(model: UpdateManyModel) -> WriteModel

Converts to this type from the input type.

impl Serialize for UpdateManyModel

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.