UpdateBuilder Class

A builder for creating update modifiers.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.BuildersBuilderBase
MongoDB.Driver.BuildersUpdateBuilder

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2

Syntax

Copy

[SerializableAttribute]
public class UpdateBuilder : BuilderBase, 
	IMongoUpdate

<SerializableAttribute>
Public Class UpdateBuilder
	Inherits BuilderBase
	Implements IMongoUpdate

[<SerializableAttribute>]
type UpdateBuilder =  
    class
        inherit BuilderBase
        interface IMongoUpdate
    end

The UpdateBuilder type exposes the following members.

Constructors

	Name	Description
	UpdateBuilder	Initializes a new instance of the UpdateBuilder class.

Top

Methods

	Name	Description
	AddToSet	Adds a value to a named array element if the value is not already in the array (see $addToSet).
	AddToSetEach(String, BsonArray)	Adds a list of values to a named array element adding each value only if it not already in the array (see $addToSet and $each).
	AddToSetEach(String, BsonValue)	Adds a list of values to a named array element adding each value only if it not already in the array (see $addToSet and $each).
	AddToSetEach(String, IEnumerableBsonValue)	Adds a list of values to a named array element adding each value only if it not already in the array (see $addToSet and $each).
	AddToSetEachWrappedT(String, T)	Adds a list of wrapped values to a named array element adding each value only if it not already in the array (see $addToSet and $each).
	AddToSetEachWrappedT(String, IEnumerableT)	Adds a list of wrapped values to a named array element adding each value only if it not already in the array (see $addToSet and $each).
	AddToSetWrappedT	Adds a wrapped value to a named array element if the value is not already in the array (see $addToSet).
	BitwiseAnd(String, Int32)	Sets the named element to the bitwise and of its value with another value (see $bit with "and").
	BitwiseAnd(String, Int64)	Sets the named element to the bitwise and of its value with another value (see $bit with "and").
	BitwiseOr(String, Int32)	Sets the named element to the bitwise or of its value with another value (see $bit with "or").
	BitwiseOr(String, Int64)	Sets the named element to the bitwise or of its value with another value (see $bit with "or").
	BitwiseXor(String, Int32)	Sets the named element to the bitwise xor of its value with another value (see $bit with "xor").
	BitwiseXor(String, Int64)	Sets the named element to the bitwise xor of its value with another value (see $bit with "xor").
	Combine	Combines another UpdateBuilder into this one.
	CurrentDate(String)	Sets the value of the named element to the current date (see $currentDate).
	CurrentDate(String, UpdateCurrentDateType)	Sets the value of the named element to the current date (see $currentDate).
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Inc(String, Double)	Increments the named element by a value (see $inc).
	Inc(String, Int32)	Increments the named element by a value (see $inc).
	Inc(String, Int64)	Increments the named element by a value (see $inc).
	Max	Updates the named element if and only if the provided value is greater than its current value (see $max).
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Min	Updates the named element if and only if the provided value is less than its current value (see $max).
	Mul(String, Double)	Multiplies the named element by a value (see $mul).
	Mul(String, Int32)	Multiplies the named element by a value (see $mul).
	Mul(String, Int64)	Multiplies the named element by a value (see $mul).
	PopFirst	Removes the first value from the named array element (see $pop).
	PopLast	Removes the last value from the named array element (see $pop).
	Pull(String, BsonValue)	Removes all values from the named array element that are equal to some value (see $pull).
	Pull(String, IMongoQuery)	Removes all values from the named array element that match some query (see $pull).
	PullAll(String, BsonArray)	Removes all values from the named array element that are equal to any of a list of values (see $pullAll).
	PullAll(String, BsonValue)	Removes all values from the named array element that are equal to any of a list of values (see $pullAll).
	PullAll(String, IEnumerableBsonValue)	Removes all values from the named array element that are equal to any of a list of values (see $pullAll).
	PullAllWrappedT(String, T)	Removes all values from the named array element that are equal to any of a list of wrapped values (see $pullAll).
	PullAllWrappedT(String, IEnumerableT)	Removes all values from the named array element that are equal to any of a list of wrapped values (see $pullAll).
	PullWrappedT	Removes all values from the named array element that are equal to some wrapped value (see $pull).
	Push	Adds a value to the end of the named array element (see $push).
	PushAll(String, BsonArray)	Adds a list of values to the end of the named array element (see $pushAll).
	PushAll(String, BsonValue)	Adds a list of values to the end of the named array element (see $pushAll).
	PushAll(String, IEnumerableBsonValue)	Adds a list of values to the end of the named array element (see $pushAll).
	PushAllWrappedT(String, T)	Adds a list of wrapped values to the end of the named array element (see $pushAll).
	PushAllWrappedT(String, IEnumerableT)	Adds a list of wrapped values to the end of the named array element (see $pushAll).
	PushEach(String, BsonArray)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEach(String, BsonValue)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEach(String, IEnumerableBsonValue)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEach(String, PushEachOptions, BsonArray)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEach(String, PushEachOptions, BsonValue)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEach(String, PushEachOptions, IEnumerableBsonValue)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEachWrappedT(String, T)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEachWrappedT(String, IEnumerableT)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEachWrappedT(String, PushEachOptions, T)	Adds a list of values to the end of the named array element (see $push and $each).
	PushEachWrappedT(String, PushEachOptions, IEnumerableT)	Adds a list of values to the end of the named array element (see $push and $each).
	PushWrappedT	Adds a wrapped value to the end of the named array element (see $push).
	Rename	Renames an element (see $rename).
	Set	Sets the value of the named element to a new value (see $set).
	SetOnInsert	Sets the value of the named element to the specified value only when an insert occurs as part of an upsert operation (see $setOnInsert).
	SetWrappedT	Sets the value of the named element to a new wrapped value (see $set).
	ToBsonDocument	Returns the result of the builder as a BsonDocument. (Overrides BuilderBaseToBsonDocument.)
	ToString	Returns a string representation of the settings. (Inherited from BuilderBase.)
	Unset	Removes the named element from the document (see $unset).

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Builders Namespace