MongoIndexManagerBaseTDocumentCreateOneAsync Method (IClientSessionHandle, CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken) |
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax public virtual Task<string> CreateOneAsync(
IClientSessionHandle session,
CreateIndexModel<TDocument> model,
CreateOneIndexOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function CreateOneAsync (
session As IClientSessionHandle,
model As CreateIndexModel(Of TDocument),
Optional options As CreateOneIndexOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)
abstract CreateOneAsync :
session : IClientSessionHandle *
model : CreateIndexModel<'TDocument> *
?options : CreateOneIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<string>
override CreateOneAsync :
session : IClientSessionHandle *
model : CreateIndexModel<'TDocument> *
?options : CreateOneIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<string>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - model
- Type: MongoDB.DriverCreateIndexModelTDocument
The model defining the index. - options (Optional)
- Type: MongoDB.DriverCreateOneIndexOptions
The create index operation options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskString
A task whose result is the name of the index that was created.
Implements
IMongoIndexManagerTDocumentCreateOneAsync(IClientSessionHandle, CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken)See Also