kmongo / org.litote.kmongo.coroutine / CoroutineCollection / renameCollection

renameCollection

suspend fun renameCollection(newCollectionNamespace: MongoNamespace, options: RenameCollectionOptions = RenameCollectionOptions()): <ERROR CLASS> (source)

Rename the collection with oldCollectionName to the newCollectionName.

Parameters

newCollectionNamespace - the name the collection will be renamed to

options - the options for renaming a collection

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/commands/renameCollection Rename collection

suspend fun renameCollection(clientSession: ClientSession, newCollectionNamespace: MongoNamespace, options: RenameCollectionOptions = RenameCollectionOptions()): <ERROR CLASS> (source)

Rename the collection with oldCollectionName to the newCollectionName.

Parameters

clientSession - the client session with which to associate this operation

newCollectionNamespace - the name the collection will be renamed to

options - the options for renaming a collection

Return
a single element indicating when the operation has completed

Mongodb
.driver.manual reference/commands/renameCollection Rename collection

Mongodb
.server.release 3.6

Since
1.7