IMongoCollectionExtensionsReplaceOneTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, TDocument, ReplaceOptions, CancellationToken) |
Replaces a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public static ReplaceOneResult ReplaceOne<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
TDocument replacement,
ReplaceOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function ReplaceOne(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
replacement As TDocument,
Optional options As ReplaceOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As ReplaceOneResult
[<ExtensionAttribute>]
static member ReplaceOne :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
replacement : 'TDocument *
?options : ReplaceOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> ReplaceOneResult
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter. - replacement
- Type: TDocument
The replacement. - options (Optional)
- Type: MongoDB.DriverReplaceOptions
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