1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
:man_page: mongoc_collection_create_bulk_operation
mongoc_collection_create_bulk_operation()
=========================================
Synopsis
--------
.. code-block:: c
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 :symbol:`mongoc_collection_create_bulk_operation_with_opts()` instead.
Parameters
----------
* ``collection``: A :symbol:`mongoc_collection_t`.
* ``ordered``: If the operations must be performed in order.
* ``write_concern``: An optional :symbol:`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 :symbol:`mongoc_bulk_operation_update()`, :symbol:`mongoc_bulk_operation_insert()` and others.
After calling :symbol:`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
--------
:symbol:`Bulk Write Operations <bulk>`
:symbol:`mongoc_bulk_operation_t`
Errors
------
Errors are propagated when executing the bulk operation.
Returns
-------
A newly allocated :symbol:`mongoc_bulk_operation_t` that should be freed with :symbol:`mongoc_bulk_operation_destroy()` when no longer in use.
.. warning::
Failure to handle the result of this function is a programming error.
|
