Scroll to navigation

MONGOC_COLLECTION_CREATE_BULK_OPERATION(3) MongoDB C Driver MONGOC_COLLECTION_CREATE_BULK_OPERATION(3)

NAME

mongoc_collection_create_bulk_operation - mongoc_collection_create_bulk_operation()

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
   BSON_GNUC_DEPRECATED_FOR (mongoc_collection_create_bulk_operation_with_opts);


DEPRECATED

This function is deprecated and should not be used in new code.

Please use mongoc_collection_create_bulk_operation_with_opts() instead.

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(), mongoc_bulk_operation_insert() and others.

After calling mongoc_bulk_operation_execute() 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() when no longer in use.

WARNING:

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


AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc
February 23, 2019 1.14.0