Click or drag to resize

MongoCollectionBase<TDocument>.ReplaceOneAsync 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.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
[ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual Task<ReplaceOneResult> ReplaceOneAsync(
	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: Task<ReplaceOneResult>
The result of the replacement.

Implements

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