Click or drag to resize

IMongoCollectionExtensions.FindOneAndReplace<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

Finds a single document and replaces it atomically.

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

Parameters

collection
Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection.
session
Type: MongoDB.Driver.IClientSessionHandle
The session.
filter
Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter.
replacement
Type: TDocument
The replacement.
options (Optional)
Type: MongoDB.Driver.FindOneAndReplaceOptions<TDocument, TDocument>
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
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 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