Struct mongod::query::Update

pub struct Update<C: Collection> { /* fields omitted */ }

A querier to update documents in a MongoDB collection.

Examples

Updates some documents in a collection.

#[derive(Bson, Mongo)]
#[mongo(collection="users", field, filter, update)]
pub struct User {
    name: String,
    age: Option<u32>,
    email: Option<String>,
}
use mongod::{AsFilter, Comparator, AsUpdate};

let client = mongod::Client::new();

let mut filter = User::filter();
filter.name = Some(Comparator::Eq("foo".to_owned()));

let mut update = User::update();
update.name = Some("bar".to_owned());

let updates = mongod::Updates {
    set: Some(update),
    ..Default::default()
};

let updated = mongod::query::Update::<User>::new()
    .filter(filter)
    .unwrap()
    .query(&client, updates)
    .await
    .unwrap();

println!("updated {} documents", updated);

Implementations

impl<C: Collection> Update<C>

pub fn new() -> Self

Constructs an Update querier.

pub fn array_filters(self, filters: Vec<Document>) -> Self

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

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

Opt out of document-level validation.

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

The collation to use for the operation.

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

pub fn filter<F>(self, filter: F) -> Result<Self, Error> where
    C: AsFilter<F>,
    F: Filter, 

The filter to use for the operation.

Errors

This method errors if the filter could not be converted into a BSON Document.

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

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

pub fn many(self, enable: bool) -> Self

Enable update many for this operation.

Removes all documents that match the filter from a collection.

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

Insert a document if no matching document is found.

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

The write concern for the operation.

pub async fn query<U>(
    self,
    client: &Client,
    updates: Updates<U>
) -> Result<i64, Error> where
    C: AsUpdate<U>,
    U: Update, 

Query the database with this querier.

Errors

This method fails if:

• the updates could not be converted into a BSON Document.
• the mongodb encountered an error.

pub fn blocking<U>(
    self,
    client: &Client,
    updates: Updates<U>
) -> Result<i64, Error> where
    C: AsUpdate<U>,
    U: Update, 

Query the database with this querier in a blocking context.

Optional

This requires the optional blocking feature to be enabled.

Errors

This method fails if:

• the updates could not be converted into a BSON Document.
• the mongodb encountered an error.

Trait Implementations

impl<C: Clone + Collection> Clone for Update<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Collection> Default for Update<C>

fn default() -> Self

Returns the "default value" for a type.