mongoc_collection_rename_with_opts man page

mongoc_collection_rename_with_opts() — This function is a helper to rename an existing collection on a MongoDB server. The name of the collection will also be updated internally so it is safe to continue using this collection after the rename. Additional operations will occur on renamed collection.

Synopsis

bool
mongoc_collection_rename_with_opts (mongoc_collection_t *collection,
                                    const char          *new_db,
                                    const char          *new_name,
                                    bool                 drop_target_before_rename,
                                    const bson_t        *opts,
                                    bson_error_t        *error);

Parameters

collection
A mongoc_collection_t
new_db
The name of the new database.
new_name
The new name for the collection.
drop_target_before_rename
If an existing collection matches the new name, drop it before the rename.
opts
A bson_t or NULL
error
An optional location for a bson_error_t or NULL

Description

This function is a helper to rename an existing collection on a MongoDB server. The name of the collection will also be updated internally so it is safe to continue using this collection after the rename. Additional operations will occur on renamed collection.

If no write concern is provided in command_opts , the collection's write concern is used.

Errors

Errors are propagated via the error parameter.

Returns

true if the command executed successfully, otherwise false and error is set.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Referenced By

mongoc_collection_rename(3).

2016‐11‐07 MongoDB C Driver