NAME

       mongoc_collection_replace_one - mongoc_collection_replace_one()

SYNOPSIS

          bool
          mongoc_collection_replace_one (mongoc_collection_t *collection,
                                         const bson_t *selector,
                                         const bson_t *replacement,
                                         const bson_t *opts,
                                         bson_t *reply,
                                         bson_error_t *error);

       WARNING:
          If  not  NULL,  reply  is  always  initialized,  even  upon  failure. Callers must call
          bson_destroy() to release this potential allocation.

PARAMETERS

       • collection: A mongoc_collection_t.

       • selector: A bson_t containing the query to match the document for updating.

       • replacement: A bson_t containing the replacement document.

       • opts: A bson_t containing additional options or NULL.

       • reply: Optional. An uninitialized bson_t populated with the update result, or NULL.

       • error: An optional location for a bson_error_t or NULL.

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

       • readConcern: Construct a mongoc_read_concern_t and use mongoc_read_concern_append to add
         the read concern to opts. See the example code for mongoc_client_read_command_with_opts.

       • 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:  Construct a mongoc_client_session_t with mongoc_client_start_session and use
         mongoc_client_session_append to add the session  to  opts.  See  the  example  code  for
         mongoc_client_session_t.

       • validate: Set to false to skip client-side validation of the provided BSON documents.

       • bypassDocumentValidation:  Set  to  true  to  skip  server-side schema validation of the
         provided BSON documents.

       • collation: Configure textual comparisons. See Setting Collation Order, and  the  MongoDB
         Manual entry on Collation.

       • 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.

       • upsert A boolean, when true, creates a new document if no document matches the query.

DESCRIPTION

       This function shall replace documents in collection that match selector with replacement.

       If  you  pass  a  non-NULL  reply,  it  is  filled  out  with  fields  "modifiedCount" and
       "matchedCount". If there is a server error then  reply  contains  either  a  "writeErrors"
       array  with  one subdocument or a "writeConcernErrors" array. The reply must be freed with
       bson_destroy().

SEE ALSO

       MongoDB update command documentation for more information on the update options.

       mongoc_collection_update_one mongoc_collection_update_many

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.

       A write concern timeout or write concern error is considered a failure.

       If  provided,  reply  will  be  initialized  and  populated  with the fields matchedCount,
       modifiedCount, and optionally upsertedId if applicable.

AUTHOR

       MongoDB, Inc

COPYRIGHT

       2018, MongoDB, Inc