Man page - mongoc_bulk_operation_execute(3)

Packages contains this manual

Manual

MONGOC_BULK_OPERATION_EXECUTE

SYNOPSIS
PARAMETERS
ERRORS
RETURNS
AUTHOR
COPYRIGHT

SYNOPSIS

uint32_t
mongoc_bulk_operation_execute (mongoc_bulk_operation_t *bulk,
bson_t *reply,
bson_error_t *error);

This function executes all operations queued into the bulk operation. Unless ordered: false was specified in the opts passed to mongoc_collection_create_bulk_operation_with_opts() , then forward progress will be stopped upon the first error.

It is only valid to call mongoc_bulk_operation_execute() once. The mongoc_bulk_operation_t must be destroyed afterwards.

WARNING:

reply is always initialized, even upon failure. Callers must call - bson_destroy() to release this potential allocation.

PARAMETERS

bulk : A mongoc_bulk_operation_t .

reply : A maybe- NULL pointer to overwritable storage for a bson_t to contain the results.

error : An optional location for a bson_error_t or NULL .

ERRORS

Errors are propagated via the error parameter.

RETURNS

On success, returns the server id used. On failure, returns 0 and sets error .

A write concern timeout or write concern error is considered a failure.

The reply document counts operations and collects error information. See Bulk Write Operations for examples.

SEE ALSO:

Bulk Write Operations

mongoc_bulk_operation_get_server_id() , which gets the id of the server used even if the operation failed.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.