MongoIndexManagerBase<TDocument>.CreateOneAsync Method (IClientSessionHandle, CreateIndexModel<TDocument>, CreateOneIndexOptions, CancellationToken) |
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic virtual Task<string> CreateOneAsync(
IClientSessionHandle session,
CreateIndexModel<TDocument> model,
CreateOneIndexOptions options = null,
CancellationToken cancellationToken = null
)
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 null
*)
-> Task<string>
override CreateOneAsync :
session : IClientSessionHandle *
model : CreateIndexModel<'TDocument> *
?options : CreateOneIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<string>
Parameters
- session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - model
- Type: MongoDB.Driver.CreateIndexModel<TDocument>
The model defining the index. - options (Optional)
- Type: MongoDB.Driver.CreateOneIndexOptions
The create index operation options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
Task<String>
A task whose result is the name of the index that was created.
Implements
IMongoIndexManager<TDocument>.CreateOneAsync(IClientSessionHandle, CreateIndexModel<TDocument>, CreateOneIndexOptions, CancellationToken)
See Also