Click or drag to resize

IMongoCollectionExtensionsReplaceOneTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, TDocument, UpdateOptions, CancellationToken)

Note: This API is now obsolete.

Replaces a single document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
[ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public static ReplaceOneResult ReplaceOne<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	Expression<Func<TDocument, bool>> filter,
	TDocument replacement,
	UpdateOptions options,
	CancellationToken cancellationToken = default
)

Parameters

collection
Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
session
Type: MongoDB.DriverIClientSessionHandle
The session.
filter
Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter.
replacement
Type: TDocument
The replacement.
options
Type: MongoDB.DriverUpdateOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: ReplaceOneResult
The result of the replacement.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoCollectionTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also