mongoc_bulk_operation_insert_with_opts()¶

Synopsis¶

bool
mongoc_bulk_operation_insert_with_opts (mongoc_bulk_operation_t *bulk,
                                        const bson_t *document,
                                        const bson_t *opts,
                                        bson_error_t *error); /* OUT */

Queue an insert of a single document into a bulk operation. The insert is not performed until mongoc_bulk_operation_execute() is called.

Parameters¶

bulk: A mongoc_bulk_operation_t.
document: A bson_t.
opts: A bson_t containing additional options.
error: An optional location for a bson_error_t or NULL.

Currently the sole option allowed in opts is “legacyInsert”.

In MongoDB 2.4 and older, indexes are created by inserting a document into the “system.indexes” pseudo-collection. That document may have fieldnames containing dots, which are ordinarily prohibited for inserts. If opts contains a boolean field “legacyInsert” with value true, then document is validated as an index specification and dotted fieldnames are allowed.

Errors¶

Operation errors are propagated via mongoc_bulk_operation_execute(), while argument validation errors are reported by the error argument.

Returns¶

Returns true on success, and false if there is a server or network error or if passed invalid arguments.