Click or drag to resize

MongoCollectionBaseTDocumentReplaceOneAsync Method (IClientSessionHandle, FilterDefinitionTDocument, 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.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
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.DriverIClientSessionHandle
The session.
filter
Type: MongoDB.DriverFilterDefinitionTDocument
The filter.
replacement
Type: TDocument
The replacement.
options
Type: MongoDB.DriverUpdateOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskReplaceOneResult
The result of the replacement.

Implements

IMongoCollectionTDocumentReplaceOneAsync(IClientSessionHandle, FilterDefinitionTDocument, TDocument, UpdateOptions, CancellationToken)
See Also