MongoClientBaseStartSessionAsync Method |
Starts a client session.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax public virtual Task<IClientSessionHandle> StartSessionAsync(
ClientSessionOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function StartSessionAsync (
Optional options As ClientSessionOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IClientSessionHandle)
abstract StartSessionAsync :
?options : ClientSessionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IClientSessionHandle>
override StartSessionAsync :
?options : ClientSessionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IClientSessionHandle>
Parameters
- options (Optional)
- Type: MongoDB.DriverClientSessionOptions
The session options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIClientSessionHandle
A Task whose result is a client session.
Implements
IMongoClientStartSessionAsync(ClientSessionOptions, CancellationToken)See Also