Linux Manuals

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. Synopsisconst bson_t * mongoc_collection_get_last_error (const mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionThe 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 be at least MONGOC_WRITE_CONCERN_W_DEFAULT in…

mongoc_collection_find_indexes() – None Synopsismongoc_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. Parameterscollection A mongoc_collection_t \&.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the error parameter. ReturnsA cursor where each result corresponds to the server’s representation of  an index on…

mongoc_collection_find_and_modify_with_opts() – Update and return an object. Synopsisbool 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.0Parameterscollection A mongoc_collection_t \&.query A bson_t containing the query to locate target document(s).opts find and modify optionsreply An optional location for a bson_t that will be initialized with the result or…

mongoc_collection_find_and_modify() – Update and return an object. Synopsisbool 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);Parameterscollection A mongoc_collection_t \&.query A bson_t containing the query to locate target document(s).sort A bson_t containing the sort order for query \&.update A…

mongoc_collection_find() – This function shall execute a query on the underlying collection. Synopsismongoc_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;Parameterscollection A mongoc_collection_t \&.flags A mongoc_query_flags_t \&.skip A uint32_t of number of documents to skip or 0.limit A uint32_t of max…

mongoc_collection_ensure_index() – None Synopsisbool 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);DeprecatedNOTE This function is deprecated and should not be used in new code. Please use mongoc_collection_create_index(3) instead. Parameterscollection A mongoc_collection_t \&.keys A bson_t \&.opt A mongoc_index_opt_t.error An optional location for a bson_error_t or NULL \&.ErrorsErrors are propagated via the…

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. Synopsisbool mongoc_collection_drop_index (mongoc_collection_t *collection, const char *index_name, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.index_name A string containing the name of the index.error An optional location for a bson_error_t or NULL \&.DescriptionThis function…

mongoc_collection_drop() – This function requests that a collection be dropped, including all indexes associated with the collection. Synopsisbool mongoc_collection_drop (mongoc_collection_t *collection, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionThis function requests that a collection be dropped, including all indexes associated with the collection \&. ErrorsErrors are propagated via the…

mongoc_collection_destroy() – This function shall destroy a mongoc_collection_t and its associated resources. Synopsisvoid mongoc_collection_destroy (mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionThis function shall destroy a mongoc_collection_t and its associated resources. NOTE Always destroy a mongoc_cursor_t created from a collection before destroying the collection.ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_collection_delete() – This function shall delete documents in the given collection that match selector. The bson selector is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation. Synopsisbool mongoc_collection_delete (mongoc_collection_t *collection, mongoc_delete_flags_t flags, const bson_t *selector, const mongoc_write_concern_t *write_concern, bson_error_t *error);DeprecatedNOTE…

mongoc_collection_create_index() – This function will request the creation of a new index. Synopsisbool mongoc_collection_create_index (mongoc_collection_t *collection, const bson_t *keys, const mongoc_index_opt_t *opt, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.keys A bson_t \&.opt A mongoc_index_opt_t.error An optional location for a bson_error_t or NULL \&.DescriptionThis function will request the creation of a new index. This function will use the…

mongoc_collection_create_bulk_operation() – This function shall begin a new bulk operation. After creating this you may call various functions such as mongoc_bulk_operation_update(), mongoc_bulk_operation_insert() and others. Synopsismongoc_bulk_operation_t * mongoc_collection_create_bulk_operation ( mongoc_collection_t *collection, bool ordered, const mongoc_write_concern_t *write_concern) BSON_GNUC_WARN_UNUSED_RESULT;Parameterscollection A mongoc_collection_t \&.ordered If the operations must be performed in order.write_concern An optional mongoc_write_concern_t or NULL \&.DescriptionThis function shall…

mongoc_collection_count_with_opts() – This function shall execute a count query on the underlying ‘collection’. The bson ‘query’ is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation. Synopsisint64_t mongoc_collection_count_with_opts (mongoc_collection_t *collection, mongoc_query_flags_t flags, const bson_t *query, int64_t skip, int64_t limit, const bson_t…

mongoc_collection_count() – This function shall execute a count query on the underlying ‘collection’. The bson ‘query’ is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation. Synopsisint64_t mongoc_collection_count (mongoc_collection_t *collection, mongoc_query_flags_t flags, const bson_t *query, int64_t skip, int64_t limit, const mongoc_read_prefs_t…

mongoc_collection_copy() – Performs a deep copy of the collection struct and its configuration. Useful if you intend to call mongoc_collection_set_write_concern, mongoc_collection_set_read_prefs, or mongoc_collection_set_read_concern, and want to preserve an unaltered copy of the struct. Synopsismongoc_collection_t * mongoc_collection_copy (mongoc_collection_t *collection);Parameterscollection A mongoc_collection_t \&.DescriptionPerforms a deep copy of the collection struct and its configuration. Useful if you intend…

mongoc_collection_command_simple() – This is a simplified version of mongoc_collection_command() that returns the first result document in reply. The parameter reply is initialized even upon failure to simplify memory management. Synopsisbool mongoc_collection_command_simple (mongoc_collection_t *collection, const bson_t *command, const mongoc_read_prefs_t *read_prefs, bson_t *reply, bson_error_t *error);Parameterscollection A mongoc_collection_t \&.command A bson_t containing the command to execute.read_prefs A mongoc_read_prefs_t…

mongoc_collection_command() – This function shall execute a command on a collection. This is performed lazily and therefore requires calling mongoc_cursor_next() on the resulting cursor structure. The cursor should be freed with mongoc_cursor_destroy() when no longer in use. Synopsismongoc_cursor_t * mongoc_collection_command (mongoc_collection_t *collection, mongoc_query_flags_t flags, uint32_t skip, uint32_t limit, uint32_t batch_size, const bson_t *command, const bson_t…

mongoc_collection_aggregate() – This function shall execute an aggregation query on the underlying ‘collection’. The bson ‘pipeline’ is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation. Synopsismongoc_cursor_t * mongoc_collection_aggregate (mongoc_collection_t *collection, mongoc_query_flags_t flags, const bson_t *pipeline, const bson_t *options, const mongoc_read_prefs_t…

mongoc_client_t – MongoDB Connection Abstraction Synopsistypedef struct _mongoc_client_t mongoc_client_t; typedef mongoc_stream_t * (*mongoc_stream_initiator_t) (const mongoc_uri_t *uri, const mongoc_host_list_t *host, void *user_data, bson_error_t *error);mongoc_client_t is an opaque type that provides access to a MongoDB node, replica-set, or sharded-cluster. It maintains management of underlying sockets and routing to individual nodes based on mongoc_read_prefs_t or mongoc_write_concern_t \&. StreamsThe…

mongoc_client_set_write_concern() – None Synopsisvoid mongoc_client_set_write_concern (mongoc_client_t *client, const mongoc_write_concern_t *write_concern);Sets the write concern for the client. This only affects future operations, collections, and databases inheriting from client \&. The default write concern is MONGOC_WRITE_CONCERN_W_DEFAULT: the driver blocks awaiting basic acknowledgment of write operations from MongoDB. This is the correct write concern for the great majority…