.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "MONGOC_COLLECTION_DELETE" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_collection_delete() \- 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.
.SH "SYNOPSIS"

.nf
.nf
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);
.fi
.fi

.SH "DEPRECATED"

.B NOTE
.RS
This function is deprecated and should not be used in new code.
.RE

Please use
.B mongoc_collection_remove(3)
instead.

.SH "PARAMETERS"

.TP
.B
collection
A
.B mongoc_collection_t
.
.LP
.TP
.B
flags
A
.B mongoc_delete_flags_t
.
.LP
.TP
.B
selector
A
.B bson_t
containing the query to match documents.
.LP
.TP
.B
write_concern
A
.B mongoc_write_concern_t
or
.B NULL
.
.LP
.TP
.B
error
An optional location for a
.B bson_error_t
or
.B NULL
.
.LP

.SH "DESCRIPTION"

This function shall delete documents in the given
.B collection
that match
.B selector
. The bson
.B 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
.B MONGOC_DELETE_SINGLE_REMOVE
in
.B flags
.

.SH "ERRORS"

Errors are propagated via the
.B error
parameter.

.SH "RETURNS"

true if successful, otherwise false and error is set.


.B
.SH COLOPHON
This page is part of MongoDB C Driver.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.