Click or drag to resize

IMongoCollectionExtensionsReplaceOneAsyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
public static Task<ReplaceOneResult> ReplaceOneAsync<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	Expression<Func<TDocument, bool>> filter,
	TDocument replacement,
	ReplaceOptions options = null,
	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 (Optional)
Type: MongoDB.DriverReplaceOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TaskReplaceOneResult
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