Skip to content

Commit 4cc3d33

Browse files
author
Christian Hergert
committed
docs: more bulk docs.
1 parent 45febe3 commit 4cc3d33

File tree

3 files changed

+102
-0
lines changed

3 files changed

+102
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
mongoc_bulk_operation_replace_one(3)
2+
====================================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_replace_one - Add a replacement operation to a bulk operation
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
void mongoc_bulk_operation_replace_one (mongoc_bulk_operation_t *bulk,
15+
const bson_t *selector,
16+
const bson_t *document,
17+
bool upsert);
18+
-----------------------
19+
20+
21+
DESCRIPTION
22+
-----------
23+
The _mongoc_bulk_operation_replace_one()_ function will request a single
24+
document be replaced as part of a bulk operation.
25+
26+
27+
RETURN VALUE
28+
------------
29+
None.
30+
31+
32+
ERRORS
33+
------
34+
Errors are reported via the result from linkmongoc:mongoc_bulk_operation_execute[3].
35+
36+
37+
SEE ALSO
38+
--------
39+
linkmongoc:mongoc_bulk_operation_execute[3]
40+
linkmongoc:mongoc_bulk_operation_destroy[3]
41+
42+
43+
AUTHORS
44+
-------
45+
46+
This page was written by MongoDB, Inc.

doc/mongoc_bulk_operation_update.txt

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
mongoc_bulk_operation_update(3)
2+
===============================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_update - Add an update operation to a bulk operation
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
void mongoc_bulk_operation_update (mongoc_bulk_operation_t *bulk,
15+
const bson_t *selector,
16+
const bson_t *document,
17+
bool upsert);
18+
void mongoc_bulk_operation_update_one (mongoc_bulk_operation_t *bulk,
19+
const bson_t *selector,
20+
const bson_t *document,
21+
bool upsert);
22+
-----------------------
23+
24+
25+
DESCRIPTION
26+
-----------
27+
The _mongoc_bulk_operation_update()_ function will request all documents
28+
matching _selector_ be updated by applying the update document _document_.
29+
It is invalid to provide a document that does not contain _$_ keys. If you
30+
would like to do so, use _mongoc_bulk_operation_replace_one()_.
31+
32+
_mongoc_bulk_operation_replace_one()_ is functionally similar to
33+
_mongoc_bulk_operation_replace()_ execept only one document will be modified.
34+
35+
36+
RETURN VALUE
37+
------------
38+
None.
39+
40+
41+
ERRORS
42+
------
43+
Errors are reported via the result from linkmongoc:mongoc_bulk_operation_execute[3].
44+
45+
46+
SEE ALSO
47+
--------
48+
linkmongoc:mongoc_bulk_operation_execute[3]
49+
linkmongoc:mongoc_bulk_operation_destroy[3]
50+
51+
52+
AUTHORS
53+
-------
54+
55+
This page was written by MongoDB, Inc.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mongoc_bulk_operation_update.txt

0 commit comments

Comments
 (0)