MONGOC_COLLECTION_RENAME_WITH_OPTS(3)

NAME
mongoc_collection_rename_with_opts - mongoc_collection_rename_with_opts()

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.

AUTHOR
MongoDB, Inc

COPYRIGHT
2017, MongoDB, Inc