Skip to content

Commit 80d32f7

Browse files
author
Christian Hergert
committed
doc: add docs for bulk_operation and mongoc_bulk_operation_delete*
1 parent 0b30bfb commit 80d32f7

File tree

4 files changed

+152
-3
lines changed

4 files changed

+152
-3
lines changed

doc/mongoc_bulk_operation.txt

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
mongoc_bulk_operation(7)
2+
========================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation - MongoDB bulk operation abstraction
8+
9+
10+
SYNOPSIS
11+
--------
12+
13+
[source, c]
14+
---------------
15+
#include <mongoc.h>
16+
17+
{
18+
mongoc_bulk_operation_t *bulk;
19+
20+
bulk = mongoc_collection_create_bulk_operation (collection, true, write_concern);
21+
/* ... */
22+
mongoc_bulk_operation_destroy (bulk);
23+
}
24+
---------------
25+
26+
27+
DESCRIPTION
28+
-----------
29+
_mongoc_bulk_operation_ provides a convenient API to submit a series of write
30+
operations to MongoDB and look at the result as a cohesive set. If the bulk
31+
operations are performed in _ordered_ mode, then any failure will prevent
32+
future operations from executing. If unordered, they may be performed in
33+
parallel.
34+
35+
36+
LIFECYCLE
37+
---------
38+
39+
It is an error to call linkmongoc:mongoc_bulk_operation_destroy[3] while it has
40+
operations pending.
41+
42+
43+
SEE ALSO
44+
--------
45+
46+
FUNCTIONS
47+
~~~~~~~~~
48+
49+
linkmongoc:mongoc_bulk_operation_destroy[3]
50+
linkmongoc:mongoc_bulk_operation_execute[3]
51+
linkmongoc:mongoc_bulk_operation_delete[3]
52+
linkmongoc:mongoc_bulk_operation_delete_one[3]
53+
linkmongoc:mongoc_bulk_operation_insert[3]
54+
linkmongoc:mongoc_bulk_operation_replace_one[3]
55+
linkmongoc:mongoc_bulk_operation_update[3]
56+
linkmongoc:mongoc_bulk_operation_update_one[3]
57+
58+
RELATED
59+
~~~~~~~
60+
61+
linkmongoc:mongoc_collection_create_bulk_operation[3]
62+
63+
64+
AUTHORS
65+
-------
66+
67+
This page was written by MongoDB, Inc.

doc/mongoc_bulk_operation_delete.txt

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
mongoc_bulk_operation_delete(3)
2+
===============================
3+
4+
5+
NAME
6+
----
7+
mongoc_bulk_operation_delete - Append a delete to a bulk operation
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
void mongoc_bulk_operation_delete (mongoc_bulk_operation_t *bulk,
15+
const bson_t *selector);
16+
void mongoc_bulk_operation_delete_one (mongoc_bulk_operation_t *bulk,
17+
const bson_t *selector);
18+
-----------------------
19+
20+
21+
DESCRIPTION
22+
-----------
23+
The _mongoc_bulk_operation_delete()_ function shall append a delete command
24+
to a bulk operation. The command will be executed upon the call to
25+
_mongoc_bulk_operation_execute()_.
26+
27+
_selector_ should be a query selector to match the document.
28+
29+
All matching documents will be removed.
30+
31+
32+
The _mongoc_bulk_operation_delete_one()_ function shall be functionally
33+
equivalent to _mongoc_bulk_operation_delete()_ execut that it will only
34+
delete the first matching document.
35+
36+
RETURN VALUE
37+
------------
38+
None.
39+
40+
41+
ERRORS
42+
------
43+
Errors are reported via the result from _mongoc_bulk_operation_execute()_.
44+
45+
46+
SEE ALSO
47+
--------
48+
linkmongoc:mongoc_bulk_operation_execute[3]
49+
50+
51+
AUTHORS
52+
-------
53+
54+
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_delete.txt

doc/mongoc_symbols.txt

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
linkmongoc:mongoc_bulk_operation_delete[3] +
2+
linkmongoc:mongoc_bulk_operation_delete_one[3] +
3+
linkmongoc:mongoc_bulk_operation_destroy[3] +
4+
linkmongoc:mongoc_bulk_operation_execute[3] +
5+
linkmongoc:mongoc_bulk_operation_insert[3] +
6+
linkmongoc:mongoc_bulk_operation_replace_one[3] +
7+
linkmongoc:mongoc_bulk_operation_update[3] +
8+
linkmongoc:mongoc_bulk_operation_update_one[3] +
19
linkmongoc:mongoc_cleanup[3] +
210
linkmongoc:mongoc_client_command[3] +
311
linkmongoc:mongoc_client_command_simple[3] +
@@ -6,7 +14,10 @@ linkmongoc:mongoc_client_get_collection[3] +
614
linkmongoc:mongoc_client_get_database[3] +
715
linkmongoc:mongoc_client_get_database_names[3] +
816
linkmongoc:mongoc_client_get_gridfs[3] +
17+
linkmongoc:mongoc_client_get_max_bson_size[3] +
18+
linkmongoc:mongoc_client_get_max_message_size[3] +
919
linkmongoc:mongoc_client_get_read_prefs[3] +
20+
linkmongoc:mongoc_client_get_server_status[3] +
1021
linkmongoc:mongoc_client_get_uri[3] +
1122
linkmongoc:mongoc_client_get_write_concern[3] +
1223
linkmongoc:mongoc_client_new[3] +
@@ -23,27 +34,35 @@ linkmongoc:mongoc_collection_aggregate[3] +
2334
linkmongoc:mongoc_collection_command[3] +
2435
linkmongoc:mongoc_collection_command_simple[3] +
2536
linkmongoc:mongoc_collection_count[3] +
37+
linkmongoc:mongoc_collection_create_bulk_operation[3] +
38+
linkmongoc:mongoc_collection_create_index[3] +
2639
linkmongoc:mongoc_collection_delete[3] +
2740
linkmongoc:mongoc_collection_destroy[3] +
2841
linkmongoc:mongoc_collection_drop[3] +
2942
linkmongoc:mongoc_collection_drop_index[3] +
3043
linkmongoc:mongoc_collection_ensure_index[3] +
3144
linkmongoc:mongoc_collection_find[3] +
45+
linkmongoc:mongoc_collection_find_and_modify[3] +
3246
linkmongoc:mongoc_collection_get_last_error[3] +
3347
linkmongoc:mongoc_collection_get_name[3] +
3448
linkmongoc:mongoc_collection_get_read_prefs[3] +
3549
linkmongoc:mongoc_collection_get_write_concern[3] +
3650
linkmongoc:mongoc_collection_insert[3] +
3751
linkmongoc:mongoc_collection_insert_bulk[3] +
3852
linkmongoc:mongoc_collection_keys_to_index_string[3] +
53+
linkmongoc:mongoc_collection_rename[3] +
3954
linkmongoc:mongoc_collection_save[3] +
4055
linkmongoc:mongoc_collection_set_read_prefs[3] +
4156
linkmongoc:mongoc_collection_set_write_concern[3] +
57+
linkmongoc:mongoc_collection_stats[3] +
4258
linkmongoc:mongoc_collection_update[3] +
59+
linkmongoc:mongoc_collection_validate[3] +
4360
linkmongoc:mongoc_cursor_clone[3] +
61+
linkmongoc:mongoc_cursor_current[3] +
4462
linkmongoc:mongoc_cursor_destroy[3] +
4563
linkmongoc:mongoc_cursor_error[3] +
4664
linkmongoc:mongoc_cursor_get_host[3] +
65+
linkmongoc:mongoc_cursor_is_alive[3] +
4766
linkmongoc:mongoc_cursor_more[3] +
4867
linkmongoc:mongoc_cursor_next[3] +
4968
linkmongoc:mongoc_database_add_user[3] +
@@ -69,12 +88,12 @@ linkmongoc:mongoc_gridfs_drop[3] +
6988
linkmongoc:mongoc_gridfs_file_destroy[3] +
7089
linkmongoc:mongoc_gridfs_file_error[3] +
7190
linkmongoc:mongoc_gridfs_file_get_aliases[3] +
91+
linkmongoc:mongoc_gridfs_file_get_chunk_size[3] +
7292
linkmongoc:mongoc_gridfs_file_get_content_type[3] +
7393
linkmongoc:mongoc_gridfs_file_get_filename[3] +
94+
linkmongoc:mongoc_gridfs_file_get_length[3] +
7495
linkmongoc:mongoc_gridfs_file_get_md5[3] +
7596
linkmongoc:mongoc_gridfs_file_get_metadata[3] +
76-
linkmongoc:mongoc_gridfs_file_get_length[3] +
77-
linkmongoc:mongoc_gridfs_file_get_chunk_size[3] +
7897
linkmongoc:mongoc_gridfs_file_get_upload_date[3] +
7998
linkmongoc:mongoc_gridfs_file_list_destroy[3] +
8099
linkmongoc:mongoc_gridfs_file_list_error[3] +
@@ -99,6 +118,7 @@ linkmongoc:mongoc_index_opt_init[3] +
99118
linkmongoc:mongoc_init[3] +
100119
linkmongoc:mongoc_log[3] +
101120
linkmongoc:mongoc_log_default_handler[3] +
121+
linkmongoc:mongoc_log_level_str[3] +
102122
linkmongoc:mongoc_log_set_handler[3] +
103123
linkmongoc:mongoc_matcher_destroy[3] +
104124
linkmongoc:mongoc_matcher_match[3] +
@@ -118,6 +138,7 @@ linkmongoc:mongoc_socket_close[3] +
118138
linkmongoc:mongoc_socket_connect[3] +
119139
linkmongoc:mongoc_socket_destroy[3] +
120140
linkmongoc:mongoc_socket_errno[3] +
141+
linkmongoc:mongoc_socket_getnameinfo[3] +
121142
linkmongoc:mongoc_socket_getsockname[3] +
122143
linkmongoc:mongoc_socket_listen[3] +
123144
linkmongoc:mongoc_socket_new[3] +
@@ -134,10 +155,12 @@ linkmongoc:mongoc_stream_file_get_fd[3] +
134155
linkmongoc:mongoc_stream_file_new[3] +
135156
linkmongoc:mongoc_stream_file_new_for_path[3] +
136157
linkmongoc:mongoc_stream_flush[3] +
158+
linkmongoc:mongoc_stream_get_base_stream[3] +
137159
linkmongoc:mongoc_stream_gridfs_new[3] +
138160
linkmongoc:mongoc_stream_read[3] +
139161
linkmongoc:mongoc_stream_readv[3] +
140162
linkmongoc:mongoc_stream_setsockopt[3] +
163+
linkmongoc:mongoc_stream_socket_get_socket[3] +
141164
linkmongoc:mongoc_stream_socket_new[3] +
142165
linkmongoc:mongoc_stream_tls_check_cert[3] +
143166
linkmongoc:mongoc_stream_tls_do_handshake[3] +
@@ -146,16 +169,18 @@ linkmongoc:mongoc_stream_uncork[3] +
146169
linkmongoc:mongoc_stream_writev[3] +
147170
linkmongoc:mongoc_uri_copy[3] +
148171
linkmongoc:mongoc_uri_destroy[3] +
149-
linkmongoc:mongoc_uri_get_auth_source[3] +
150172
linkmongoc:mongoc_uri_get_auth_mechanism[3] +
173+
linkmongoc:mongoc_uri_get_auth_source[3] +
151174
linkmongoc:mongoc_uri_get_database[3] +
152175
linkmongoc:mongoc_uri_get_hosts[3] +
153176
linkmongoc:mongoc_uri_get_options[3] +
154177
linkmongoc:mongoc_uri_get_password[3] +
155178
linkmongoc:mongoc_uri_get_read_prefs[3] +
156179
linkmongoc:mongoc_uri_get_replica_set[3] +
180+
linkmongoc:mongoc_uri_get_ssl[3] +
157181
linkmongoc:mongoc_uri_get_string[3] +
158182
linkmongoc:mongoc_uri_get_username[3] +
183+
linkmongoc:mongoc_uri_get_write_concern[3] +
159184
linkmongoc:mongoc_uri_new[3] +
160185
linkmongoc:mongoc_uri_new_for_host_port[3] +
161186
linkmongoc:mongoc_uri_unescape[3] +
@@ -165,10 +190,12 @@ linkmongoc:mongoc_write_concern_get_fsync[3] +
165190
linkmongoc:mongoc_write_concern_get_journal[3] +
166191
linkmongoc:mongoc_write_concern_get_w[3] +
167192
linkmongoc:mongoc_write_concern_get_wmajority[3] +
193+
linkmongoc:mongoc_write_concern_get_wtag[3] +
168194
linkmongoc:mongoc_write_concern_get_wtimeout[3] +
169195
linkmongoc:mongoc_write_concern_new[3] +
170196
linkmongoc:mongoc_write_concern_set_fsync[3] +
171197
linkmongoc:mongoc_write_concern_set_journal[3] +
172198
linkmongoc:mongoc_write_concern_set_w[3] +
173199
linkmongoc:mongoc_write_concern_set_wmajority[3] +
200+
linkmongoc:mongoc_write_concern_set_wtag[3] +
174201
linkmongoc:mongoc_write_concern_set_wtimeout[3] +

0 commit comments

Comments
 (0)