mongoc_collection_drop() – This function requests that a collection be dropped, including all indexes associated with the collection. Synopsis bool mongoc_collection_drop (mongoc_collection_t *collection, bson_error_t *error); Parameters collection A mongoc_collection_t \&. error An optional location for a bson_error_t or NULL \&. Description This function requests that a collection be dropped, including all indexes associated with the collection…
mongoc_collection_destroy() – This function shall destroy a mongoc_collection_t and its associated resources. Synopsis void mongoc_collection_destroy (mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description This 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. Colophon This page is part of MongoDB C Driver….
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. Synopsis bool 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…
mongoc_collection_create_index() – This function will request the creation of a new index. Synopsis bool mongoc_collection_create_index (mongoc_collection_t *collection, const bson_t *keys, const mongoc_index_opt_t *opt, bson_error_t *error); 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 or NULL \&. Description This function will request the creation of…
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. Synopsis mongoc_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; Parameters collection A mongoc_collection_t \&. ordered If the operations must be performed in order. write_concern An optional mongoc_write_concern_t…
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. Synopsis int64_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…
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. Synopsis int64_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_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. Synopsis mongoc_collection_t * mongoc_collection_copy (mongoc_collection_t *collection); Parameters collection A mongoc_collection_t \&. Description Performs a deep copy of the collection struct and its…
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. Synopsis bool 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); Parameters collection A mongoc_collection_t \&. command A bson_t containing the command…
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. Synopsis mongoc_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…
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. Synopsis mongoc_cursor_t * mongoc_collection_aggregate (mongoc_collection_t *collection, mongoc_query_flags_t flags, const bson_t *pipeline, const bson_t *options, const…
mongoc_client_t – MongoDB Connection Abstraction Synopsis typedef 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…
mongoc_client_set_write_concern() – None Synopsis void 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…
mongoc_client_set_stream_initiator() – None Synopsis void mongoc_client_set_stream_initiator (mongoc_client_t *client, mongoc_stream_initiator_t initiator, void *user_data); The mongoc_client_set_stream_initiator(3) function shall associate a given mongoc_client_t with a new stream initiator. This will completely replace the default transport (buffered TCP, possibly with TLS). The initiator should fulfill the mongoc_stream_t contract. user_data is passed through to the initiator callback and may be…
mongoc_client_set_ssl_opts() – None Synopsis #ifdef MONGOC_ENABLE_SSL mongoc_client_set_ssl_opts (mongoc_client_t *client, const mongoc_ssl_opt_t *opts); #endif Sets the SSL options to use when connecting to SSL enabled MongoDB servers. Beginning in version 1.2.0, once a client has any SSL options set, all connections use SSL, even if "ssl=true" is omitted from the MongoDB URI. Before, SSL options were…
mongoc_client_set_read_prefs() – None Synopsis void mongoc_client_set_read_prefs (mongoc_client_t *client, const mongoc_read_prefs_t *read_prefs); Sets the default read preferences to use with future operations upon client \&. The global default is to read from the replica set primary. It is a programming error to call this function on a client from a mongoc_client_pool_t \&. For pooled clients, set…
mongoc_client_set_read_concern() – None Synopsis void mongoc_client_set_read_concern (mongoc_client_t *client, const mongoc_read_concern_t *read_concern); Sets the read concern for the client. This only affects future operations, collections, and databases inheriting from client \&. The default read concern is MONGOC_READ_CONCERN_LEVEL_LOCAL. This is the correct read concern for the great majority of applications. It is a programming error to call…
mongoc_client_pool_try_pop() – None Synopsis mongoc_client_t * mongoc_client_pool_try_pop (mongoc_client_pool_t *pool); This function is identical to mongoc_client_pool_pop(3) except it will return NULL instead of blocking for a client to become available. Parameters pool A mongoc_client_pool_t \&. Returns A mongoc_client_t if one is immediately available, otherwise NULL \&. Colophon This page is part of MongoDB C Driver. Please…
mongoc_client_pool_t – Connection pooling abstraction Synopsis typedef struct _mongoc_client_pool_t mongoc_client_pool_t mongoc_client_pool_t is the basis for multi-threading in the MongoDB C driver. Since mongoc_client_t structures are not thread-safe, this structure is used to retrieve a new mongoc_client_t for a given thread. This structure is thread-safe \&. Example #include <mongoc.h> static void * worker (void *data) {…
mongoc_client_pool_set_ssl_opts() – None Synopsis #ifdef MONGOC_ENABLE_SSL void mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t *pool, const mongoc_ssl_opt_t *opts); #endif This function is identical to mongoc_client_set_ssl_opts(3) except for client pools. It ensures that all clients retrieved from mongoc_client_pool_pop(3) or mongoc_client_pool_try_pop(3) are configured with the same SSL settings. It is a programming error to call this function after retrieving a client from…