mongoc_collection_create_bulk_operation man page

mongoc_collection_create_bulk_operation() — This function shall begin a new bulk operation. After creating this you may call various functions such as mongoc_bulk_operation_update(), mongoc_bulk_operation_insert() and others.

Synopsis

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;

Parameters

collection
A mongoc_collection_t
ordered
If the operations must be performed in order.
write_concern
An optional mongoc_write_concern_t or NULL

Description

This function shall begin a new bulk operation. After creating this you may call various functions such as mongoc_bulk_operation_update(3) , mongoc_bulk_operation_insert(3) and others.

After calling mongoc_bulk_operation_execute(3) the commands will be executed in as large as batches as reasonable by the client.

If ordered is true, then processing will stop at the first error.

If ordered is not true, then the bulk operation will attempt to continue processing even after the first failure.

write_concern contains the write concern for all operations in the bulk operation. If NULL , the collection's write concern is used. The global default is acknowledged writes: MONGOC_WRITE_CONCERN_W_DEFAULT.

See Also

Bulk Write Operations

mongoc_bulk_operation_t

Errors

Errors are propagated when executing the bulk operation.

Returns

A newly allocated mongoc_bulk_operation_t that should be freed with mongoc_bulk_operation_destroy(3) when no longer in use.

NOTE

Failure to handle the result of this function is a programming error.

Colophon

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

Referenced By

mongoc_bulk(3), mongoc_bulk_operation_execute(3), mongoc_collection_insert_bulk(3).

2016‐11‐07 MongoDB C Driver