Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MONGOC_BULK_OPERATION_EXECUTE(3)    libmongoc	MONGOC_BULK_OPERATION_EXECUTE(3)

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. Un-
     less   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  mon-
     goc_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  con-
       tain 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 er-
     ror.

     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.

1.30.8				  Aug 27, 2026	MONGOC_BULK_OPERATION_EXECUTE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_bulk_operation_execute&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help