Click or drag to resize

IMongoCollection<TDocument>.ReplaceOneAsync Method (IClientSessionHandle, FilterDefinition<TDocument>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
Task<ReplaceOneResult> ReplaceOneAsync(
	IClientSessionHandle session,
	FilterDefinition<TDocument> filter,
	TDocument replacement,
	ReplaceOptions options = null,
	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 (Optional)
Type: MongoDB.Driver.ReplaceOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task<ReplaceOneResult>
The result of the replacement.
See Also