mongoc_read_prefs_destroy() – Frees a read preference and all associated resources. Synopsis void mongoc_read_prefs_destroy (mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description Frees a read preference and all associated resources. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_prefs_copy() – This function shall deep copy a read preference. Synopsis mongoc_read_prefs_t * mongoc_read_prefs_copy (const mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description This function shall deep copy a read preference. Returns Returns a newly allocated read preference that should be freed with mongoc_read_prefs_destroy(3) \&. Colophon This page is part of MongoDB C Driver. Please…
mongoc_read_prefs_add_tag() – This function shall add a tag to a read preference. Synopsis void mongoc_read_prefs_add_tag (mongoc_read_prefs_t *read_prefs, const bson_t *tag); Parameters read_prefs A mongoc_read_prefs_t \&. tag A bson_t \&. Description This function shall add a tag to a read preference. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_mode_t – Read Preference Modes Synopsis typedef enum { MONGOC_READ_PRIMARY = (1 << 0), MONGOC_READ_SECONDARY = (1 << 1), MONGOC_READ_PRIMARY_PREFERRED = (1 << 2) | MONGOC_READ_PRIMARY, MONGOC_READ_SECONDARY_PREFERRED = (1 << 2) | MONGOC_READ_SECONDARY, MONGOC_READ_NEAREST = (1 << 3) | MONGOC_READ_SECONDARY, } mongoc_read_mode_t; Description This enum describes how reads should be dispatched. The default is MONGOC_READ_PRIMARY….
mongoc_read_concern_t – Read Concern abstraction Synopsis NOTE New in MongoDB 3.2 and mongoc 1.3.0 The mongoc_read_concern_t allows clients to choose a level of isolation for their reads. The default, MONGOC_READ_CONCERN_LEVEL_LOCAL, is right for the great majority of applications. You can specify a read concern on connection objects, database objects, or collection objects. See readConcern on…
mongoc_read_concern_set_level() – The readConcern option allows clients to choose a level of isolation for their reads. Synopsis void mongoc_read_concern_set_level (mongoc_read_concern_t *read_concern, const char *level); Parameters read_concern A mongoc_read_concern_t \&. level The readConcern level to use. Should be either MONGOC_READ_CONCERN_LEVEL_LOCAL or MONGOC_READ_CONCERN_LEVEL_MAJORITY. Description The readConcern option allows clients to choose a level of isolation for their…
mongoc_read_concern_new() – None Synopsis mongoc_read_concern_t * mongoc_read_concern_new (void); Returns Creates a newly allocated read concern that can be configured based on user preference. This should be freed with mongoc_read_concern_destroy(3) when no longer in use. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_concern_get_level() – Returns the currently set read concern. Synopsis const char* mongoc_read_concern_get_level (const mongoc_read_concern_t *read_concern); Parameters read_concern A mongoc_read_concern_t \&. Description Returns the currently set read concern. Returns Returns the current readConcern. If none is set, returns empty string. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_concern_destroy() – Frees all resources associated with the read concern structure. Synopsis void mongoc_read_concern_destroy (mongoc_read_concern_t *read_concern); Parameters read_concern A mongoc_read_concern_t \&. Description Frees all resources associated with the read concern structure. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_concern_copy() – Performs a deep copy of read_concern. Synopsis mongoc_read_concern_t * mongoc_read_concern_copy (const mongoc_read_concern_t *read_concern); Parameters read_concern A mongoc_read_concern_t \&. Description Performs a deep copy of read_concern \&. Returns Returns a newly allocated copy of read_concern that should be freed with mongoc_read_concern_destroy(3) when no longer in use. Colophon This page is part of MongoDB C…
mongoc_rand_status() – The status of the mongoc random number generator. Synopsis int mongoc_rand_status(void); Description The status of the mongoc random number generator. Returns Returns 1 if the PRNG has been seeded with enough data, 0 otherwise. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_rand_seed() – Seeds the mongoc random number generator with num bytes of entropy. Synopsis void mongoc_rand_seed(const void *buf, int num); Description Seeds the mongoc random number generator with num bytes of entropy. Parameters buf A buffer. num An int of number of bytes in buf. Colophon This page is part of MongoDB C Driver. Please…
mongoc_rand_add() – Mixes num bytes of data into the mongoc random number generator. Entropy specifies a lower bound estimate of the randomness contained in buf. Synopsis void mongoc_rand_add(const void *buf, int num, double entropy); Description Mixes num bytes of data into the mongoc random number generator. Entropy specifies a lower bound estimate of the randomness…
mongoc_rand – MongoDB Random Number Generator Synopsis void mongoc_rand_add (const void *buf, int num, doubel entropy); void mongoc_rand_seed (const void *buf, int num); int mongoc_rand_status (void); Description The mongoc_rand family of functions provide access to the low level randomness primitives used by the MongoDB C Driver. In particular, they control the creation of cryptographically strong…
mongoc_query_flags_t – Flags for deletion operations Synopsis typedef enum { MONGOC_QUERY_NONE = 0, MONGOC_QUERY_TAILABLE_CURSOR = 1 << 1, MONGOC_QUERY_SLAVE_OK = 1 << 2, MONGOC_QUERY_OPLOG_REPLAY = 1 << 3, MONGOC_QUERY_NO_CURSOR_TIMEOUT = 1 << 4, MONGOC_QUERY_AWAIT_DATA = 1 << 5, MONGOC_QUERY_EXHAUST = 1 << 6, MONGOC_QUERY_PARTIAL = 1 << 7, } mongoc_query_flags_t; Description These flags correspond to…
mongoc_matcher_t – Client-side document matching abstraction Synopsis typedef struct _mongoc_matcher_t mongoc_matcher_t; mongoc_matcher_t provides a reduced-interface for client-side matching of BSON documents. It can perform the basics such as $in, $nin, $eq, $neq, $gt, $gte, $lt, and $lte. NOTE mongoc_matcher_t does not currently support the full spectrum of query operations that the MongoDB server supports. Deprecated…
mongoc_matcher_new() – None Synopsis mongoc_matcher_t * mongoc_matcher_new (const bson_t *query, bson_error_t *error); Create a new mongoc_matcher_t using the query specification provided. Deprecated NOTE mongoc_matcher_t is deprecated and will be removed in version 2.0. Parameters query A bson_t \&. error An optional location for a bson_error_t or NULL \&. Errors Errors are propagated via the error…
mongoc_matcher_match() – None Synopsis bool mongoc_matcher_match (const mongoc_matcher_t *matcher, const bson_t *document); This function will check to see if the query compiled in matcher matches document \&. Deprecated NOTE mongoc_matcher_t is deprecated and will be removed in version 2.0. Parameters matcher A mongoc_matcher_t \&. query A bson_t that contains the query. Returns true if document…
mongoc_matcher_destroy() – None Synopsis void mongoc_matcher_destroy (mongoc_matcher_t *matcher); Release all resources associated with matcher including freeing the structure. Deprecated NOTE mongoc_matcher_t is deprecated and will be removed in version 2.0. Parameters matcher A mongoc_matcher_t \&. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_iovec_t – Synopsis #include <mongoc.h> #ifdef _WIN32 typedef struct { u_long iov_len; char *iov_base; } mongoc_iovec_t; #else typedef struct iovec mongoc_iovec_t; #endif Synopsis Synopsis #include <mongoc.h> #ifdef _WIN32 typedef struct { u_long iov_len; char *iov_base; } mongoc_iovec_t; #else typedef struct iovec mongoc_iovec_t; #endif The mongoc_iovec_t structure is a portability abstraction for consumers of the mongoc_stream_t interfaces. It allows…