.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "MONGOC_COLLECTION_CREATE_BULK_OPERATION" "3" "May 07, 2024" "1.27.1" "libmongoc" .sp \fBWARNING:\fP .INDENT 0.0 .INDENT 3.5 Deprecated since version 1.9.0: This function is deprecated and should not be used in new code. .sp Please use \fI\%mongoc_collection_create_bulk_operation_with_opts()\fP in new code. .UNINDENT .UNINDENT .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX mongoc_bulk_operation_t * mongoc_collection_create_bulk_operation ( mongoc_collection_t *collection, bool ordered, const mongoc_write_concern_t *write_concern) BSON_GNUC_WARN_UNUSED_RESULT BSON_GNUC_DEPRECATED_FOR (mongoc_collection_create_bulk_operation_with_opts); .EE .UNINDENT .UNINDENT .SH PARAMETERS .INDENT 0.0 .IP \(bu 2 \fBcollection\fP: A \fI\%mongoc_collection_t\fP\&. .IP \(bu 2 \fBordered\fP: If the operations must be performed in order. .IP \(bu 2 \fBwrite_concern\fP: An optional \fI\%mongoc_write_concern_t\fP or \fBNULL\fP\&. .UNINDENT .SH DESCRIPTION .sp This function shall begin a new bulk operation. After creating this you may call various functions such as \fI\%mongoc_bulk_operation_update()\fP, \fI\%mongoc_bulk_operation_insert()\fP and others. .sp After calling \fI\%mongoc_bulk_operation_execute()\fP the commands will be executed in as large as batches as reasonable by the client. .sp If \fBordered\fP is true, then processing will stop at the first error. .sp If \fBordered\fP is not true, then the bulk operation will attempt to continue processing even after the first failure. .sp \fBwrite_concern\fP contains the write concern for all operations in the bulk operation. If \fBNULL\fP, the collection\(aqs write concern is used. The global default is acknowledged writes: MONGOC_WRITE_CONCERN_W_DEFAULT. .SH ERRORS .sp Errors are propagated when executing the bulk operation. .SH RETURNS .sp A newly allocated \fI\%mongoc_bulk_operation_t\fP that should be freed with \fI\%mongoc_bulk_operation_destroy()\fP when no longer in use. .sp \fBWARNING:\fP .INDENT 0.0 .INDENT 3.5 Failure to handle the result of this function is a programming error. .UNINDENT .UNINDENT .sp \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 .nf \fI\%Bulk Write Operations\fP .fi .sp .sp \fI\%mongoc_bulk_operation_t\fP .UNINDENT .UNINDENT .SH AUTHOR MongoDB, Inc .SH COPYRIGHT 2017-present, MongoDB, Inc .\" Generated by docutils manpage writer. .