The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
mongoc_cursor_error() – This function checks to see if an error has occurred while iterating the cursor. Synopsisbool mongoc_cursor_error (mongoc_cursor_t *cursor, bson_error_t *error);Parameterscursor A mongoc_cursor_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionThis function checks to see if an error has occurred while iterating the cursor. ErrorsErrors are propagated via the error parameter. Returnsfalse…
mongoc_cursor_destroy() – Frees a mongoc_cursor_t and releases all associated resources. If a server-side cursor has been allocated, it will be released as well. Synopsisvoid mongoc_cursor_destroy (mongoc_cursor_t *cursor);Parameterscursor A mongoc_cursor_t \&.DescriptionFrees a mongoc_cursor_t and releases all associated resources. If a server-side cursor has been allocated, it will be released as well. ColophonThis page is part of…
mongoc_cursor_current() – Fetches the cursors current document or NULL if there has been an error. Synopsisconst bson_t * mongoc_cursor_current (const mongoc_cursor_t *cursor);Parameterscursor A mongoc_cursor_t \&.DescriptionFetches the cursors current document or NULL if there has been an error. ReturnsA bson_t that should not be modified or freed or NULL \&. ColophonThis page is part of MongoDB…
mongoc_cursor_clone() – This function shall create a copy of a mongoc_cursor_t. The cloned cursor will be reset to the beginning of the query, and therefore the query will be re-executed on the MongoDB server when mongoc_cursor_next() is called. Synopsismongoc_cursor_t * mongoc_cursor_clone (const mongoc_cursor_t *cursor) BSON_GNUC_WARN_UNUSED_RESULT;Parameterscursor A mongoc_cursor_t \&.DescriptionThis function shall create a copy of a…
mongoc_collection_validate() – This function is a helper function to execute the validate MongoDB command. Synopsisbool mongoc_collection_validate (mongoc_collection_t *collection, const bson_t *options, bson_t *reply, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.options A bson_t \&.reply A bson_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionThis function is a helper function to execute the validate MongoDB command. Currently,…
mongoc_collection_update() – This function shall update documents in collection that match selector. Synopsisbool mongoc_collection_update (mongoc_collection_t *collection, mongoc_update_flags_t flags, const bson_t *selector, const bson_t *update, const mongoc_write_concern_t *write_concern, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.flags A bitwise or of mongoc_update_flags_t \&.selector A bson_t containing the query to match documents for updating.update A bson_t containing the update to perform.write_concern…
mongoc_collection_t – #include <mongoc.h> typedef struct _mongoc_collection_t mongoc_collection_t; Synopsis#include <mongoc.h> typedef struct _mongoc_collection_t mongoc_collection_t;mongoc_collection_t provides access to a MongoDB collection. This handle is useful for actions for most CRUD operations, I.e. insert, update, delete, find, etc. Read Preferences And Write ConcernsRead preferences and write concerns are inherited from the parent client. They can be overridden…
mongoc_collection_stats() – This function is a helper to retrieve statistics about the collection. Synopsisbool mongoc_collection_stats (mongoc_collection_t *collection, const bson_t *options, bson_t *reply, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.options An optional bson_t containing extra options to pass to the collStats command.reply An optional location for a bson_t to store the result.error An optional location for a bson_error_t…
mongoc_collection_set_write_concern() – Sets the write concern to use for operations on collection. Synopsisvoid mongoc_collection_set_write_concern (mongoc_collection_t *collection, const mongoc_write_concern_t *write_concern);Parameterscollection A mongoc_collection_t \&.write_concern A mongoc_write_concern_t \&.DescriptionSets the write concern to use for operations on collection \&. The default write concern is MONGOC_WRITE_CONCERN_W_DEFAULT: the driver blocks awaiting basic acknowledgment of write operations from MongoDB. This is the…
mongoc_collection_set_read_prefs() – Sets the default read preferences to use for operations on collection not specifying a read preference. Synopsisvoid mongoc_collection_set_read_prefs (mongoc_collection_t *collection, const mongoc_read_prefs_t *read_prefs);Parameterscollection A mongoc_collection_t \&.read_prefs A mongoc_read_prefs_t \&.DescriptionSets the default read preferences to use for operations on collection not specifying a read preference. The global default is MONGOC_READ_PRIMARY: if the client is…
mongoc_collection_set_read_concern() – Sets the read concern to use for operations on collection. Synopsisvoid mongoc_collection_set_read_concern (mongoc_collection_t *collection, const mongoc_read_concern_t *read_concern);Parameterscollection A mongoc_collection_t \&.read_concern A mongoc_read_concern_t \&.DescriptionSets the read concern to use for operations on collection \&. The default read concern is empty: No readConcern is sent to the server unless explicitly configured. ColophonThis page is part…
mongoc_collection_save() – This function shall save a document into collection. If the document has an _id field it will be updated. Otherwise it will be inserted. Synopsisbool mongoc_collection_save (mongoc_collection_t *collection, const bson_t *document, const mongoc_write_concern_t *write_concern, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.document A bson_t containing the document.write_concern A mongoc_write_concern_t or NULL for default write concern.error An…
mongoc_collection_rename() – This function is a helper to rename an existing collection on a MongoDB server. The name of the collection will also be updated internally so it is safe to continue using this collection after the rename. Additional operations will occur on renamed collection. Synopsisbool mongoc_collection_rename (mongoc_collection_t *collection, const char *new_db, const char *new_name,…
mongoc_collection_rename() – This function is a helper to rename an existing collection on a MongoDB server. The name of the collection will also be updated internally so it is safe to continue using this collection after the rename. Additional operations will occur on renamed collection. Synopsisbool mongoc_collection_rename (mongoc_collection_t *collection, const char *new_db, const char *new_name,…
mongoc_collection_insert_bulk() – This function performs a bulk insert of all of the documents in documents. This function is deprecated as it cannot accurately return which documents may have failed during the bulk insert. Synopsisbool mongoc_collection_insert_bulk (mongoc_collection_t *collection, mongoc_insert_flags_t flags, const bson_t **documents, uint32_t n_documents, const mongoc_write_concern_t *write_concern, bson_error_t *error) BSON_GNUC_DEPRECATED_FOR (mongoc_collection_create_bulk_operation);DeprecatedThis function is deprecated and…
mongoc_collection_insert() – This function shall insert document into collection. Synopsisbool mongoc_collection_insert (mongoc_collection_t *collection, mongoc_insert_flags_t flags, const bson_t *document, const mongoc_write_concern_t *write_concern, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.flags A mongoc_insert_flags_t \&.document A bson_t \&.write_concern A mongoc_write_concern_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionThis function shall insert document into collection \&. If no _id element…
mongoc_collection_get_write_concern() – Fetches the default write concern to be used on write operations originating from collection and not specifying a write concern. Synopsisconst mongoc_write_concern_t * mongoc_collection_get_write_concern (const mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionFetches the default write concern to be used on write operations originating from collection and not specifying a write concern. ReturnsA mongoc_write_concern_t that should…
mongoc_collection_get_read_prefs() – Fetches the default read preferences to use for collection. Operations without specified read-preferences will default to this. Synopsisconst mongoc_read_prefs_t * mongoc_collection_get_read_prefs (const mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionFetches the default read preferences to use for collection \&. Operations without specified read-preferences will default to this. ReturnsA mongoc_read_prefs_t that should not be modified or freed….
mongoc_collection_get_read_concern() – Fetches the default read concern to be used on read operations originating from collection. Synopsisconst mongoc_read_concern_t * mongoc_collection_get_read_concern (const mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionFetches the default read concern to be used on read operations originating from collection \&. ReturnsA mongoc_read_concern_t that should not be modified or freed. ColophonThis page is part of MongoDB…
mongoc_collection_get_name() – Fetches the name of collection. Synopsisconst char * mongoc_collection_get_name (mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionFetches the name of collection \&. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.