mongoc_collection_stats() – This function is a helper to retrieve statistics about the collection. Synopsis bool mongoc_collection_stats (mongoc_collection_t *collection, const bson_t *options, bson_t *reply, bson_error_t *error); Parameters collection 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…
mongoc_collection_set_write_concern() – Sets the write concern to use for operations on collection. Synopsis void mongoc_collection_set_write_concern (mongoc_collection_t *collection, const mongoc_write_concern_t *write_concern); Parameters collection A mongoc_collection_t \&. write_concern A mongoc_write_concern_t \&. Description Sets 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…
mongoc_collection_set_read_prefs() – Sets the default read preferences to use for operations on collection not specifying a read preference. Synopsis void mongoc_collection_set_read_prefs (mongoc_collection_t *collection, const mongoc_read_prefs_t *read_prefs); Parameters collection A mongoc_collection_t \&. read_prefs A mongoc_read_prefs_t \&. Description Sets the default read preferences to use for operations on collection not specifying a read preference. The global default…
mongoc_collection_set_read_concern() – Sets the read concern to use for operations on collection. Synopsis void mongoc_collection_set_read_concern (mongoc_collection_t *collection, const mongoc_read_concern_t *read_concern); Parameters collection A mongoc_collection_t \&. read_concern A mongoc_read_concern_t \&. Description Sets the read concern to use for operations on collection \&. The default read concern is empty: No readConcern is sent to the server unless…
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. Synopsis bool mongoc_collection_save (mongoc_collection_t *collection, const bson_t *document, const mongoc_write_concern_t *write_concern, bson_error_t *error); Parameters collection A mongoc_collection_t \&. document A bson_t containing the document. write_concern A mongoc_write_concern_t or NULL…
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. Synopsis bool mongoc_collection_rename (mongoc_collection_t *collection, const char *new_db, const char…
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. Synopsis bool mongoc_collection_rename (mongoc_collection_t *collection, const char *new_db, const char…
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. Synopsis bool 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); Deprecated This function…
mongoc_collection_insert() – This function shall insert document into collection. Synopsis bool 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); Parameters collection 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 \&. Description This function shall…
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. Synopsis const mongoc_write_concern_t * mongoc_collection_get_write_concern (const mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description Fetches the default write concern to be used on write operations originating from collection and not specifying a write…
mongoc_collection_get_read_prefs() – Fetches the default read preferences to use for collection. Operations without specified read-preferences will default to this. Synopsis const mongoc_read_prefs_t * mongoc_collection_get_read_prefs (const mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description Fetches the default read preferences to use for collection \&. Operations without specified read-preferences will default to this. Returns A mongoc_read_prefs_t that…
mongoc_collection_get_read_concern() – Fetches the default read concern to be used on read operations originating from collection. Synopsis const mongoc_read_concern_t * mongoc_collection_get_read_concern (const mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description Fetches the default read concern to be used on read operations originating from collection \&. Returns A mongoc_read_concern_t that should not be modified or freed….
mongoc_collection_get_name() – Fetches the name of collection. Synopsis const char * mongoc_collection_get_name (mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description Fetches the name of collection \&. Returns A string which should not be modified or freed. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_collection_get_last_error() – The mongoc_collection_get_last_error() function shall return getLastError document, according to write_concern on last executed command for current collection instance. Synopsis const bson_t * mongoc_collection_get_last_error (const mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description The mongoc_collection_get_last_error() function shall return getLastError document, according to write_concern on last executed command for current collection instance. A write_concern must…
mongoc_collection_find_indexes() – None Synopsis mongoc_cursor_t * mongoc_collection_find_indexes (mongoc_collection_t *collection, bson_error_t *error); Fetches a cursor containing documents, each corresponding to an index on this collection. Parameters collection A mongoc_collection_t \&. error An optional location for a bson_error_t or NULL \&. Errors Errors are propagated via the error parameter. Returns A cursor where each result corresponds to…
mongoc_collection_find_and_modify_with_opts() – Update and return an object. Synopsis bool mongoc_collection_find_and_modify_with_opts (mongoc_collection_t *collection, const bson_t *query, const mongoc_find_and_modify_opts_t *opts, bson_t *reply, bson_error_t *error); NOTE New in mongoc 1.3.0 Parameters collection A mongoc_collection_t \&. query A bson_t containing the query to locate target document(s). opts find and modify options reply An optional location for a bson_t that…
mongoc_collection_find_and_modify() – Update and return an object. Synopsis bool mongoc_collection_find_and_modify (mongoc_collection_t *collection, const bson_t *query, const bson_t *sort, const bson_t *update, const bson_t *fields, bool _remove, bool upsert, bool _new, bson_t *reply, bson_error_t *error); Parameters collection A mongoc_collection_t \&. query A bson_t containing the query to locate target document(s). sort A bson_t containing the sort…
mongoc_collection_find() – This function shall execute a query on the underlying collection. Synopsis mongoc_cursor_t * mongoc_collection_find (mongoc_collection_t *collection, mongoc_query_flags_t flags, uint32_t skip, uint32_t limit, uint32_t batch_size, const bson_t *query, const bson_t *fields, const mongoc_read_prefs_t *read_prefs) BSON_GNUC_WARN_UNUSED_RESULT; Parameters collection A mongoc_collection_t \&. flags A mongoc_query_flags_t \&. skip A uint32_t of number of documents to skip or…
mongoc_collection_ensure_index() – None Synopsis bool mongoc_collection_ensure_index (mongoc_collection_t *collection, const bson_t *keys, const mongoc_index_opt_t *opt, bson_error_t *error) BSON_GNUC_DEPRECATED_FOR (mongoc_collection_create_index); Deprecated NOTE This function is deprecated and should not be used in new code. Please use mongoc_collection_create_index(3) instead. Parameters collection A mongoc_collection_t \&. keys A bson_t \&. opt A mongoc_index_opt_t. error An optional location for a bson_error_t…
mongoc_collection_drop_index() – This function requests than an index on collection be dropped. In the event of an error it returns false and error is set. Synopsis bool mongoc_collection_drop_index (mongoc_collection_t *collection, const char *index_name, bson_error_t *error); Parameters collection A mongoc_collection_t \&. index_name A string containing the name of the index. error An optional location for a…