mongoc_collection_save man page

mongoc_collection_save — mongoc_collection_save()

Deprecated

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

Please use mongoc_collection_insert() or mongoc_collection_update() 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 or mongoc_collection_update);

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

true if successful, otherwise false and error is set.

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

Author

MongoDB, Inc

Info

Mar 28, 2017 1.6.2 MongoDB C Driver