Scroll to navigation

MONGOC_COLLECTION_RENAME_WITH_OPTS(3) libmongoc MONGOC_COLLECTION_RENAME_WITH_OPTS(3)

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.
  • error: An optional location for a bson_error_t or NULL.

opts may be NULL or a BSON document with additional command options:

  • writeConcern: Construct a mongoc_write_concern_t and use mongoc_write_concern_append() to add the write concern to opts. See the example code for mongoc_client_write_command_with_opts().
  • sessionId: First, construct a mongoc_client_session_t with mongoc_client_start_session(). You can begin a transaction with mongoc_client_session_start_transaction(), optionally with a mongoc_transaction_opt_t that overrides the options inherited from collection, and use mongoc_client_session_append() to add the session to opts. See the example code for mongoc_client_session_t.
  • serverId: To target a specific server, include an int32 "serverId" field. Obtain the id by calling mongoc_client_select_server(), then mongoc_server_description_id() on its return value.

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

COPYRIGHT

2017-present, MongoDB, Inc

February 25, 2024 1.26.0