Scroll to navigation

MONGOC_COLLECTION_SAVE(3) libmongoc MONGOC_COLLECTION_SAVE(3)

NAME

mongoc_collection_save - mongoc_collection_save()

DEPRECATED

This function is deprecated and should not be used in new code.

Please use mongoc_collection_insert_one() or mongoc_collection_replace_one() with "upsert" instead.

SYNOPSIS

bool
mongoc_collection_save (mongoc_collection_t *collection,


                        const bson_t *document,


                        const mongoc_write_concern_t *write_concern,


                        bson_error_t *error)


   BSON_GNUC_DEPRECATED_FOR (mongoc_collection_insert_one or


                             mongoc_collection_replace_one);


PARAMETERS

  • collection: A mongoc_collection_t.
  • document: A bson_t containing the document.
  • write_concern: A mongoc_write_concern_t or NULL for default write concern.
  • error: An optional location for a bson_error_t or NULL.

DESCRIPTION

This function shall save a document into collection. If the document has an _id field it will be updated. Otherwise it will be inserted.

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.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

October 20, 2022 1.23.1