Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_COLLECTION_INSERT_MANY(3)   libmongoc  MONGOC_COLLECTION_INSERT_MANY(3)

SYNOPSIS
	  bool
	  mongoc_collection_insert_many	(mongoc_collection_t *collection,
					 const bson_t **documents,
					 size_t	n_documents,
					 const bson_t *opts,
					 bson_t	*reply,
					 bson_error_t *error);

PARAMETERS
        collection: A mongoc_collection_t.

        documents: An array of	pointers to bson_t.

        n_documents: The length of documents.

        reply:	 A  maybe-NULL pointer to overwritable storage for a bson_t to
	 contain the results.

        error:	An optional location for a bson_error_t	or NULL.

       opts may	be NULL	or a BSON document with	additional command options:

        writeConcern:	 Construct   a	  mongoc_write_concern_t    and	   use
	 mongoc_write_concern_append()	to  add	the write concern to opts. See
	 the example code for mongoc_client_write_command_with_opts().

        sessionId:   First,   construct   a   mongoc_client_session_t	  with
	 mongoc_client_start_session().	 You  can  begin  a  transaction  with
	 mongoc_client_session_start_transaction(),    optionally    with    a
	 mongoc_transaction_opt_t  that	 overrides  the	options	inherited from
	 collection, and use mongoc_client_session_append() to add the session
	 to opts. See the example code for mongoc_client_session_t.

        validate:    Construct	   a	 bitwise-or	of     all     desired
	 bson_validate_flags_t.	Set to false to	skip client-side validation of
	 the provided BSON documents.

        comment: A bson_value_t specifying the	comment	to attach to this com-
	 mand.	The  comment will appear in log	messages, profiler output, and
	 currentOp output. Requires MongoDB 4.4	or later.

        ordered: set to false to attempt to insert all	documents,  continuing
	 after errors.

        bypassDocumentValidation: Set to true to skip server-side schema val-
	 idation of the	provided BSON documents.

DESCRIPTION
       Insert documents	into collection.

       To insert a single document, see	mongoc_collection_insert_one().

       For  any	 document that does not	have an	"_id" field, a bson_oid_t will
       be generated locally and	added to the document. If you  must  know  the
       inserted	document's _id,	generate it in your code and include it	in the
       document. The _id you generate can be a bson_oid_t or any other non-ar-
       ray BSON	type.

       If  you pass a non-NULL reply, it is filled out with an "insertedCount"
       field. If there is a server error then reply may	 contain  a  "writeEr-
       rors"  array and/or a "writeConcernErrors" array	(see Bulk Write	Opera-
       tions for examples). The	reply must be freed with bson_destroy().

ERRORS
       Errors are propagated via the error parameter.

RETURNS
       Returns true if successful. Returns false and sets error	if  there  are
       invalid arguments or a server or	network	error.

       A write concern timeout or write	concern	error is considered a failure.

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025 MONGOC_COLLECTION_INSERT_MANY(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_collection_insert_many&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help