RenameCollection()

Renames a collection, optionally moving it to another database.

pub async fn rename_collection(&self, request: RenameCollectionRequest) -> Result<()>

Request Syntax

let request = RenameCollectionRequest::builder()
    .collection_name("books")
    .new_collection_name("library")
    .build()?;

REQUEST FIELDS:

• database_name: Option<String>

  Name of the target database; uses the default database when empty.

• collection_name: String

  Current name of the collection. Required.

• new_collection_name: String

  New name of the collection. Required.

• new_database_name: Option<String>

  Database to move the collection to; defaults to the current database.

RETURN TYPE:

Result<()>

RETURNS:

Returns an empty result indicating success. Returns Error on failure.

Example

let request = RenameCollectionRequest::builder()
    .collection_name("books")
    .new_collection_name("library")
    .build()?;
client.rename_collection(request).await?;