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

  
 
  

home | help
MONGOC_COLLECTION_REMOVE(3)	    libmongoc	     MONGOC_COLLECTION_REMOVE(3)

SYNOPSIS
	bool
	mongoc_collection_remove (mongoc_collection_t *collection,
				  mongoc_remove_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_remove_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
     NOTE:
	To   pass  additional  options,  use  mongoc_collection_delete_one()  or
	mongoc_collection_delete_many().

     This function shall remove documents in the given collection that match se-
     lector. The bson selector is not validated, simply passed along  as  appro-
     priate  to  the  server.  As such, compatibility and errors should be vali-
     dated in the appropriate server documentation.

     If you want to limit deletes  to  a  single  document,  provide  MONGOC_RE-
     MOVE_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 in-
     valid arguments or a server or network error.

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026	     MONGOC_COLLECTION_REMOVE(3)

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

home | help