Linux Manuals

mongoc_find_and_modify_opts_new() – None Synopsismongoc_find_and_modify_opts_t * mongoc_find_and_modify_opts_new (void);NOTE New in mongoc 1.3.0ReturnsCreates a newly allocated find and modify builder structure that is used to create a findAndModify command. This should be freed with mongoc_find_and_modify_opts_destroy(3) when no longer in use. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_find_and_modify_opts_destroy() – Frees all resources associated with the find and modify builder structure. Synopsisvoid mongoc_find_and_modify_opts_destroy (mongoc_find_and_modify_opts_t *find_and_modify_opts);NOTE New in mongoc 1.3.0Parametersfind_and_modify_opts A mongoc_find_and_modify_opts_t \&.DescriptionFrees all resources associated with the find and modify builder structure. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_delete_flags_t – Flags for deletion operations Synopsistypedef enum { MONGOC_DELETE_NONE = 0, MONGOC_DELETE_SINGLE_REMOVE = 1 << 0, } mongoc_delete_flags_t;DeprecatedNOTE These flags are deprecated and should not be used in new code. Please use mongoc_remove_flags_t with mongoc_collection_remove(3) instead. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_database_t – MongoDB Database Abstraction Synopsistypedef struct _mongoc_database_t mongoc_database_t; mongoc_database_t provides access to a MongoDB database. This handle is useful for actions a particular database object. It is not a container for mongoc_collection_t structures. Read preferences and write concerns are inherited from the parent client. They can be overridden with mongoc_database_set_read_prefs(3) and mongoc_database_set_write_concern(3) \&. NOTE…

mongoc_database_set_write_concern() – None Synopsisvoid mongoc_database_set_write_concern (mongoc_database_t *database, const mongoc_write_concern_t *write_concern);This function sets the write concern to use on operations performed with database \&. Collections created with mongoc_database_get_collection(3) after this call will inherit this write concern. 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_database_set_read_prefs() – None Synopsisvoid mongoc_database_set_read_prefs (mongoc_database_t *database, const mongoc_read_prefs_t *read_prefs);This function sets the default read preferences to use on operations performed with database \&. Collections created with mongoc_database_get_collection(3) after this call will inherit these read preferences. The global default is MONGOC_READ_PRIMARY: if the client is connected to a replica set it reads from the primary,…

mongoc_database_set_read_concern() – None Synopsisvoid mongoc_database_set_read_concern (mongoc_database_t *database, const mongoc_read_concern_t *read_concern);This function sets the read concern to use on operations performed with database \&. Collections created with mongoc_database_get_collection(3) after this call will inherit this read concern. The default read concern is empty: No readConcern is sent to the server unless explicitly configured. Parametersdatabase A mongoc_database_t \&.read_concern…

mongoc_database_remove_user() – None Synopsisbool mongoc_database_remove_user (mongoc_database_t *database, const char *username, bson_error_t *error);This function removes the user named username from database \&. Parametersdatabase A mongoc_database_t \&.username A string containing the username of the user to remove.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. This could include socket errors…

mongoc_database_remove_all_users() – None Synopsisbool mongoc_database_remove_all_users (mongoc_database_t *database, bson_error_t *error);This function will remove all users configured to access database \&. Parametersdatabase A mongoc_database_t \&.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. This may fail if there are socket errors or the current user is not authorized to perform…

mongoc_database_has_collection() – None Synopsisbool mongoc_database_has_collection (mongoc_database_t *database, const char *name, bson_error_t *error);This function checks to see if a collection exists on the MongoDB server within database \&. Parametersdatabase A mongoc_database_t \&.name A string containing the name of the collection.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. Returnstrue…

mongoc_database_get_write_concern() – None Synopsisconst mongoc_write_concern_t * mongoc_database_get_write_concern (const mongoc_database_t *database);This function retrieves the default mongoc_write_concern_t to use with database as configured by the client. Parametersdatabase A mongoc_database_t \&.ReturnsA mongoc_write_concern_t that 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.

mongoc_database_get_read_prefs() – None Synopsisconst mongoc_read_prefs_t * mongoc_database_get_read_prefs (const mongoc_database_t *database);Fetches the default read preferences to use with database \&. Parametersdatabase A mongoc_database_t \&.ReturnsA mongoc_write_concern_t that 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.

mongoc_database_get_read_concern() – None Synopsisconst mongoc_read_concern_t * mongoc_database_get_read_concern (const mongoc_database_t *database);This function retrieves the default mongoc_read_concern_t to use with database as configured by the client. Parametersdatabase A mongoc_database_t \&.ReturnsA mongoc_read_concern_t that 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.

mongoc_database_get_name() – None Synopsisconst char * mongoc_database_get_name (mongoc_database_t *database);Fetches the name of the database. Parametersdatabase A mongoc_database_t \&.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.

mongoc_database_get_collection_names() – None Synopsischar ** mongoc_database_get_collection_names (mongoc_database_t *database, bson_error_t *error);Fetches a NULL terminated array of NULL-byte terminated char* strings containing the names of all of the collections in database \&. Parametersdatabase A mongoc_database_t \&.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. ReturnsA NULL terminated array of NULL…

mongoc_database_get_collection() – None Synopsismongoc_collection_t * mongoc_database_get_collection (mongoc_database_t *database, const char *name);Allocates a new mongoc_collection_t structure for the collection named name in database \&. ReturnsA newly allocated mongoc_collection_t that should be freed with mongoc_collection_destroy(3) \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_database_find_collections() – None Synopsismongoc_cursor_t * mongoc_database_find_collections (mongoc_database_t * database, const bson_t * filter, bson_error_t * error);Fetches a cursor containing documents, each corresponding to a collection on this database. Parametersdatabase A mongoc_database_t \&.filter A matcher used by the server to filter the returned collections. May be NULL \&.error An optional location for a bson_error_t or NULL…

mongoc_database_drop() – bool mongoc_database_drop (mongoc_database_t *database,                 bson_error_t      *error); Synopsisbool mongoc_database_drop (mongoc_database_t *database, bson_error_t *error);This function attempts to drop a database on the MongoDB server. Parametersdatabase A mongoc_database_t \&.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. Returnstrue if successful, otherwise false and error is set. ColophonThis page is part…

mongoc_database_destroy() – void mongoc_database_destroy (mongoc_database_t *database); Synopsisvoid mongoc_database_destroy (mongoc_database_t *database);Releases all resources associated with database , including freeing the structure. Parametersdatabase A mongoc_database_t \&.ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_database_create_collection() – None Synopsismongoc_collection_t * mongoc_database_create_collection (mongoc_database_t *database, const char *name, const bson_t *options, bson_error_t *error);Parametersdatabase 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 \&.ErrorsErrors are propagated via the error parameter. ReturnsThis function returns a newly allocated mongoc_collection_t…