kmongo / org.litote.kmongo.coroutine / CoroutineCollection / dropIndex

dropIndex

suspend fun dropIndex(indexName: String, dropIndexOptions: DropIndexOptions = DropIndexOptions()): <ERROR CLASS> (source)

Drops the given index.

Parameters

indexName - the name of the index to remove

dropIndexOptions - options to use when dropping indexes

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/command/dropIndexes/ Drop Indexes

Since
1.7

suspend fun dropIndex(keys: Bson, dropIndexOptions: DropIndexOptions = DropIndexOptions()): <ERROR CLASS> (source)

Drops the index given the keys used to create it.

Parameters

keys - the keys of the index to remove

dropIndexOptions - options to use when dropping indexes

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/command/dropIndexes/ Drop indexes

Since
1.7

suspend fun dropIndex(clientSession: ClientSession, indexName: String, dropIndexOptions: DropIndexOptions = DropIndexOptions()): <ERROR CLASS> (source)

Drops the given index.

Parameters

clientSession - the client session with which to associate this operation

indexName - the name of the index to remove

dropIndexOptions - options to use when dropping indexes

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/command/dropIndexes/ Drop Indexes

Mongodb
.server.release 3.6

Since
1.7

suspend fun dropIndex(clientSession: ClientSession, keys: Bson, dropIndexOptions: DropIndexOptions = DropIndexOptions()): <ERROR CLASS> (source)

Drops the index given the keys used to create it.

Parameters

clientSession - the client session with which to associate this operation

keys - the keys of the index to remove

dropIndexOptions - options to use when dropping indexes

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/command/dropIndexes/ Drop indexes

Mongodb
.server.release 3.6

Since
1.7