IMongoCollectionExtensionsReplaceOneTDocument Method (IMongoCollectionTDocument, ExpressionFuncTDocument, Boolean, TDocument, UpdateOptions, CancellationToken) (original) (raw)

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 static ReplaceOneResult ReplaceOne( this IMongoCollection collection, Expression<Func<TDocument, bool>> filter, TDocument replacement, UpdateOptions options, CancellationToken cancellationToken = null )

Public Shared Function ReplaceOne(Of TDocument) ( collection As IMongoCollection(Of TDocument), filter As Expression(Of Func(Of TDocument, Boolean)), replacement As TDocument, options As UpdateOptions, Optional cancellationToken As CancellationToken = Nothing ) As ReplaceOneResult

[] [<ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")>] static member ReplaceOne : collection : IMongoCollection<'TDocument> * filter : Expression<Func<'TDocument, bool>> * replacement : 'TDocument * options : UpdateOptions * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken null *) -> ReplaceOneResult

Parameters

collection

Type: MongoDB.DriverIMongoCollectionTDocument
The collection.

filter

Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter.

replacement

Type: TDocument
The replacement.

options

Type: MongoDB.DriverUpdateOptions
The options.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument

The type of the document.

Return Value

Type: ReplaceOneResult
The result of the replacement.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoCollectionTDocument. 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

Reference