Skip to content

Commit 45febe3

Browse files
author
Christian Hergert
committed
doc: more bulk operation docs.
1 parent 80d32f7 commit 45febe3

File tree

3 files changed

+146
-0
lines changed

3 files changed

+146
-0
lines changed

doc/mongoc_bulk_operation_destroy.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
mongoc_bulk_operation_destroy(3)
2+
================================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_destroy - destroy a mongoc_bulk_operation_t
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
void mongoc_bulk_operation_destroy (mongoc_bulk_operation_t *bulk);
15+
-----------------------
16+
17+
18+
DESCRIPTION
19+
-----------
20+
The _mongoc_bulk_operation_destroy()_ function shall destroy a linkmongoc:mongoc_bulk_operation[7].
21+
22+
23+
RETURN VALUE
24+
------------
25+
The _mongoc_bulk_operation_destroy()_ function has no return value.
26+
27+
28+
ERRORS
29+
------
30+
No errors are defined.
31+
32+
33+
SEE ALSO
34+
--------
35+
linkmongoc:mongoc_bulk_operation[7]
36+
37+
38+
AUTHORS
39+
-------
40+
41+
This page was written by MongoDB, Inc.

doc/mongoc_bulk_operation_execute.txt

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
mongoc_bulk_operation_execute(3)
2+
================================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_execute - Execute a bulk operation
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
bool mongoc_bulk_operation_execute (mongoc_bulk_operation_t *bulk,
15+
bson_t *reply,
16+
bson_error_t *error);
17+
-----------------------
18+
19+
20+
DESCRIPTION
21+
-----------
22+
The _mongoc_bulk_operation_execute()_ function will execute all of the
23+
operations appended to the linkmongoc:mongoc_bulk_operation[7].
24+
25+
true is returned only if the bulk operation was completely successful.
26+
Otherwise false is returned and _error_ is set with a descriptive error.
27+
28+
Detailed error information is provided via _reply_ and is always initialized
29+
even if the bulk operation was successful.
30+
31+
32+
PARAMTERS
33+
---------
34+
35+
_reply_ is a location of a _bson_t_ that will be initialized by
36+
_mongoc_bulk_operation_execute()_. It will always be initialized by this
37+
function and should be released using bson_destroy() by the caller.
38+
39+
40+
RETURN VALUE
41+
------------
42+
true is returned if the command was completely successful.
43+
false is returned if there was an error of any sort.
44+
detailed errors are provided in @reply if non-NULL.
45+
46+
47+
ERRORS
48+
------
49+
Errors are reported via _error_ and _reply_.
50+
51+
52+
SEE ALSO
53+
--------
54+
linkmongoc:mongoc_bulk_operation_execute[3]
55+
56+
57+
AUTHORS
58+
-------
59+
60+
This page was written by MongoDB, Inc.

doc/mongoc_bulk_operation_insert.txt

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
mongoc_bulk_operation_insert(3)
2+
==============================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_insert - Append an insert to a bulk operation
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
void mongoc_bulk_operation_insert (mongoc_bulk_operation_t *bulk,
15+
const bson_t *document);
16+
-----------------------
17+
18+
19+
DESCRIPTION
20+
-----------
21+
The _mongoc_bulk_operation_insert()_ function will append a document to be
22+
inserted into the bulk operation _bulk_. This will be delayed until
23+
linkmongoc:mongoc_bulk_operation_execute[3] has been called.
24+
25+
26+
RETURN VALUE
27+
------------
28+
None.
29+
30+
31+
ERRORS
32+
------
33+
Errors are reported via the result from linkmongoc:mongoc_bulk_operation_execute[3].
34+
35+
36+
SEE ALSO
37+
--------
38+
linkmongoc:mongoc_bulk_operation_execute[3]
39+
linkmongoc:mongoc_bulk_operation_destroy[3]
40+
41+
42+
AUTHORS
43+
-------
44+
45+
This page was written by MongoDB, Inc.

0 commit comments

Comments
 (0)