Click or drag to resize

MongoCollectionBase<TDocument>.ReplaceOne Method (IClientSessionHandle, FilterDefinition<TDocument>, 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.12.2+a4a3888f4fb51bb518b1eb5002effc2d47f2ea6a
Syntax
[ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual ReplaceOneResult ReplaceOne(
	IClientSessionHandle session,
	FilterDefinition<TDocument> filter,
	TDocument replacement,
	UpdateOptions options,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.Driver.IClientSessionHandle
The session.
filter
Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter.
replacement
Type: TDocument
The replacement.
options
Type: MongoDB.Driver.UpdateOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: ReplaceOneResult
The result of the replacement.

Implements

IMongoCollection<TDocument>.ReplaceOne(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, UpdateOptions, CancellationToken)
See Also