Man page - mongoc_collection_insert_one(3)

Packages contains this manual

Package: libmongoc-doc
apt-get install libmongoc-doc

Manuals in package:

Documentations in package:

Manual

MONGOC_COLLECTION_INSERT_ONE

SYNOPSIS
PARAMETERS
DESCRIPTION
ERRORS
RETURNS
AUTHOR
COPYRIGHT

SYNOPSIS

bool
mongoc_collection_insert_one (mongoc_collection_t *collection,
const bson_t *document,
const bson_t *opts,
bson_t *reply,
bson_error_t *error);

PARAMETERS

	•		collection : A mongoc_collection_t .
	•		document : A bson_t .
	•		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 command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
	•		bypassDocumentValidation : Set to true to skip server-side schema validation of the provided BSON documents.

DESCRIPTION

This function shall insert document into collection .

To insert an array of documents, see mongoc_collection_insert_many() .

If no _id element is found in document , then a bson_oid_t will be generated locally and added to the document.

If you pass a non-NULL reply , it is filled out with an "insertedCount" field. If the document was successfully inserted, reply will also contain an "insertedId" field containing the inserted document's _id . If there is a server error then reply contains either a "writeErrors" array with one subdocument or a "writeConcernErrors" array. 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.