Click or drag to resize

IMongoCollectionExtensions.ReplaceOneAsync<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
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.Driver.IMongoCollection<TDocument>
The collection.
session
Type: MongoDB.Driver.IClientSessionHandle
The session.
filter
Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
The filter.
replacement
Type: TDocument
The replacement.
options (Optional)
Type: MongoDB.Driver.ReplaceOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: Task<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 IMongoCollection<TDocument>. 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