Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_COLLECTION_DELETE(3)	   libmongoc	   MONGOC_COLLECTION_DELETE(3)

WARNING:
	  Deprecated  since  version  1.9.0:  Use  mongoc_collection_remove(),
	  mongoc_collection_delete_one()  or   mongoc_collection_delete_many()
	  instead.

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);

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  MON-
       GOC_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

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025	   MONGOC_COLLECTION_DELETE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_collection_delete&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help