Click or drag to resize

IMongoCollectionExtensionsFindOneAndReplaceTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, FilterDefinitionTDocument, TDocument, FindOneAndReplaceOptionsTDocument, TDocument, CancellationToken)

Finds a single document and replaces it atomically.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax
public static TDocument FindOneAndReplace<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	FilterDefinition<TDocument> filter,
	TDocument replacement,
	FindOneAndReplaceOptions<TDocument, TDocument> options = null,
	CancellationToken cancellationToken = default
)

Parameters

collection
Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
session
Type: MongoDB.DriverIClientSessionHandle
The session.
filter
Type: MongoDB.DriverFilterDefinitionTDocument
The filter.
replacement
Type: TDocument
The replacement.
options (Optional)
Type: MongoDB.DriverFindOneAndReplaceOptionsTDocument, TDocument
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TDocument
The returned document.

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