bionic (3) mongoc_collection_delete.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME
       mongoc_collection_delete - mongoc_collection_delete()


SYNOPSIS
          bool
          mongoc_collection_delete (mongoc_collection_t *collection,
                                    mongoc_delete_flags_t flags,
                                    const bson_t *selector,
                                    const mongoc_write_concern_t *write_concern,
                                    bson_error_t *error)
             BSON_GNUC_DEPRECATED_FOR (mongoc_collection_delete_one or
                                       mongoc_collection_delete_many);


DEPRECATED
       Please use mongoc_collection_delete_one() or mongoc_collection_delete_many() instead.


PARAMETERS
       • collection: A mongoc_collection_t.

       • flags: A mongoc_delete_flags_t.

       • selector: A bson_t containing the query to match documents.

       • write_concern: A mongoc_write_concern_t or NULL.

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


DESCRIPTION
       This  function  shall  delete documents in the given collection that match selector. The bson selector is
       not validated, simply passed along as appropriate to the  server.   As  such,  compatibility  and  errors
       should be validated in the appropriate server documentation.

       If you want to limit deletes to a single document, provide MONGOC_DELETE_SINGLE_REMOVE in flags.


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


       2018, MongoDB, Inc