mongoc_collection_rename_with_opts man page

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

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 opts, the collection’s write concern is used.

Errors

Errors are propagated via the error parameter.

Returns

Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.

Author

MongoDB, Inc

Info

Aug 10, 2017 1.7.0 MongoDB C Driver