mongoc_database_create_collection() – None Synopsis mongoc_collection_t * mongoc_database_create_collection (mongoc_database_t *database, const char *name, const bson_t *options, bson_error_t *error); Parameters database A mongoc_database_t \&. name The name of the new collection. options An optional bson_t for options to the createDatabase command. error A location for a bson_error_t or NULL \&. Errors Errors are propagated via the error…
mongoc_database_copy() – Performs a deep copy of the database struct and its configuration. Useful if you intend to call mongoc_database_set_write_concern, mongoc_database_set_read_prefs, or mongoc_database_set_read_concern, and want to preserve an unaltered copy of the struct. Synopsis mongoc_database_t * mongoc_database_copy (mongoc_database_t *database); Parameters database A mongoc_database_t \&. Description Performs a deep copy of the database struct and its…
mongoc_database_command_simple() – This is a simplified interface to mongoc_database_command() that returns the first result document. Synopsis bool mongoc_database_command_simple (mongoc_database_t *database, const bson_t *command, const mongoc_read_prefs_t *read_prefs, bson_t *reply, bson_error_t *error); Parameters database A mongoc_database_t \&. command A bson_t containing the command. read_prefs An optional mongoc_read_prefs_t \&. reply A location to store the commands first result…
mongoc_database_command() – The mongoc_database_command() function shall execute a command on a database. This is performed lazily after calling mongoc_cursor_next() on the resulting cursor structure. Synopsis mongoc_cursor_t * mongoc_database_command (mongoc_database_t *database, mongoc_query_flags_t flags, uint32_t skip, uint32_t limit, uint32_t batch_size, const bson_t *command, const bson_t *fields, const mongoc_read_prefs_t *read_prefs); Parameters database A mongoc_database_t \&. flags A mongoc_query_flags_t…
mongoc_database_add_user() – This function shall create a new user with access to database. Synopsis bool mongoc_database_add_user (mongoc_database_t *database, const char *username, const char *password, const bson_t *roles, const bson_t *custom_data, bson_error_t *error); Parameters database A mongoc_database_t \&. username The name of the user. password The cleartext password for the user. roles An optional bson_t for…
mongoc_cursor_t – Client-side cursor abtraction Synopsis typedef struct _mongoc_cursor_t mongoc_cursor_t; mongoc_cursor_t provides access to a MongoDB query cursor. It wraps up the wire protocol negotiation required to initiate a query and retrieve an unknown number of documents. Cursors are lazy, meaning that no network traffic occurs until the first call to mongoc_cursor_next(3) \&. At that…
mongoc_cursor_set_max_await_time_ms() – The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Only applies if the cursor is created from mongoc_collection_find with the query flags MONGOC_QUERY_TAILABLE_CURSOR and MONGOC_QUERY_AWAIT_DATA, and the server is MongoDB 3.2 or later. See the documentation for maxTimeMS and the "getMore" command. Synopsis…
mongoc_cursor_next() – This function shall iterate the underlying cursor, setting bson to the next document. Synopsis bool mongoc_cursor_next (mongoc_cursor_t *cursor, const bson_t **bson); Parameters cursor A mongoc_cursor_t \&. bson A location for a const bson_t * \&. Description This function shall iterate the underlying cursor, setting bson to the next document. This function is a…
mongoc_cursor_more() – This function shall indicate if there is more data to be read from the cursor. Synopsis bool mongoc_cursor_more (mongoc_cursor_t *cursor); Parameters cursor A mongoc_cursor_t \&. Description This function shall indicate if there is more data to be read from the cursor. Returns true if there is more data to be read from the…
mongoc_cursor_is_alive() – Checks to see if a cursor is in a state that allows for more documents to be queried. Synopsis bool mongoc_cursor_is_alive (const mongoc_cursor_t *cursor); Parameters cursor A mongoc_cursor_t \&. Description Checks to see if a cursor is in a state that allows for more documents to be queried. This is primarily useful with…
mongoc_cursor_get_max_await_time_ms() – Retrieve the value set with mongoc_cursor_set_max_await_time_ms. Synopsis uint32_t mongoc_cursor_get_max_await_time_ms (mongoc_cursor_t *cursor); Parameters cursor A mongoc_cursor_t \&. Description Retrieve the value set with mongoc_cursor_set_max_await_time_ms \&. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_cursor_get_host() – Fetches the MongoDB host that the cursor is communicating with in the host out parameter. Synopsis void mongoc_cursor_get_host (mongoc_cursor_t *cursor, mongoc_host_list_t *host); Parameters cursor A mongoc_cursor_t \&. host A mongoc_host_list_t \&. Description Fetches the MongoDB host that the cursor is communicating with in the host out parameter. Colophon This page is part of…
mongoc_cursor_error() – This function checks to see if an error has occurred while iterating the cursor. Synopsis bool mongoc_cursor_error (mongoc_cursor_t *cursor, bson_error_t *error); Parameters cursor A mongoc_cursor_t \&. error An optional location for a bson_error_t or NULL \&. Description This function checks to see if an error has occurred while iterating the cursor. Errors Errors…
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. Synopsis void mongoc_cursor_destroy (mongoc_cursor_t *cursor); Parameters cursor A mongoc_cursor_t \&. Description Frees a mongoc_cursor_t and releases all associated resources. If a server-side cursor has been allocated, it will be released as well….
mongoc_cursor_current() – Fetches the cursors current document or NULL if there has been an error. Synopsis const bson_t * mongoc_cursor_current (const mongoc_cursor_t *cursor); Parameters cursor A mongoc_cursor_t \&. Description Fetches the cursors current document or NULL if there has been an error. Returns A bson_t that should not be modified or freed or NULL \&….
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. Synopsis mongoc_cursor_t * mongoc_cursor_clone (const mongoc_cursor_t *cursor) BSON_GNUC_WARN_UNUSED_RESULT; Parameters cursor A mongoc_cursor_t \&. Description This function shall…
mongoc_collection_validate() – This function is a helper function to execute the validate MongoDB command. Synopsis bool mongoc_collection_validate (mongoc_collection_t *collection, const bson_t *options, bson_t *reply, bson_error_t *error); Parameters collection A mongoc_collection_t \&. options A bson_t \&. reply A bson_t \&. error An optional location for a bson_error_t or NULL \&. Description This function is a helper…
mongoc_collection_update() – This function shall update documents in collection that match selector. Synopsis bool 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); Parameters collection 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…
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 Concerns Read preferences and write concerns are inherited from the parent client. They…
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…