mongoc_init() – This function should be called at the beginning of every program using the MongoDB C driver. It is responsible for initializing global state such as process counters, SSL, and threading primatives. Synopsis void mongoc_init (void); Description This function should be called at the beginning of every program using the MongoDB C driver. It…
mongoc_index_opt_wt_t – #include <mongoc.h> typedef struct { mongoc_index_opt_storage_t base; const char *config_str; void *padding[8]; } mongoc_index_opt_wt_t; Synopsis #include <mongoc.h> typedef struct { mongoc_index_opt_storage_t base; const char *config_str; void *padding[8]; } mongoc_index_opt_wt_t; Description This structure contains the options that may be used for tuning a WiredTiger specific index. See Also Colophon This page is part of MongoDB C Driver….
mongoc_index_opt_wt_init() – This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Synopsis void mongoc_index_opt_wt_init (mongoc_index_opt_wt_t *opt); Parameters opt A mongoc_index_opt_wt_t \&. Description This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Colophon This…
mongoc_index_opt_wt_get_default() – None Synopsis const mongoc_index_opt_wt_t * mongoc_index_opt_wt_get_default (void) BSON_GNUC_CONST; Returns Returns a pointer to the default WiredTiger index creation options. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_index_opt_t – #include <mongoc.h> typedef struct { bool is_initialized; bool background; bool unique; const char *name; bool drop_dups; bool sparse; int32_t expire_after_seconds; int32_t v; const bson_t *weights; const char *default_language; const char *language_override; mongoc_index_opt_geo_t *geo_options; mongoc_index_opt_storage_t *storage_options; const bson_t *partial_filter_expression; void *padding[5]; } mongoc_index_opt_t; Synopsis #include <mongoc.h> typedef struct { bool is_initialized; bool background; bool unique; const char *name; bool drop_dups; bool sparse; int32_t expire_after_seconds; int32_t v; const bson_t *weights;…
mongoc_index_opt_init() – This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Synopsis void mongoc_index_opt_init (mongoc_index_opt_t *opt); Parameters opt A mongoc_index_opt_t \&. Description This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Colophon This…
mongoc_index_opt_get_default() – None Synopsis const mongoc_index_opt_t * mongoc_index_opt_get_default (void) BSON_GNUC_CONST; Returns Returns a pointer to the default index creation options. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_index_opt_geo_t – #include <mongoc.h> typedef struct { uint8_t twod_sphere_version; uint8_t twod_bits_precision; double twod_location_min; double twod_location_max; double haystack_bucket_size; uint8_t *padding[32]; } mongoc_index_opt_geo_t; Synopsis #include <mongoc.h> typedef struct { uint8_t twod_sphere_version; uint8_t twod_bits_precision; double twod_location_min; double twod_location_max; double haystack_bucket_size; uint8_t *padding[32]; } mongoc_index_opt_geo_t; Description This structure contains the options that may be used for tuning a GEO index. See Also Colophon…
mongoc_index_opt_geo_init() – This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Synopsis void mongoc_index_opt_geo_init (mongoc_index_opt_geo_t *opt); Parameters opt A mongoc_index_opt_geo_t \&. Description This function will initialize opt to the default values. It should be called before modifying any fields within the structure. Colophon This…
mongoc_index_opt_geo_get_default() – None Synopsis const mongoc_index_opt_geo_t * mongoc_index_opt_geo_get_default (void) BSON_GNUC_CONST; Returns Returns a pointer to the default GEO index creation options. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_host_list_t – typedef struct { mongoc_host_list_t *next; char host [BSON_HOST_NAME_MAX + 1]; char host_and_port [BSON_HOST_NAME_MAX + 7]; uint16_t port; int family; void *padding [4]; } mongoc_host_list_t; Synopsis typedef struct { mongoc_host_list_t *next; char host [BSON_HOST_NAME_MAX + 1]; char host_and_port [BSON_HOST_NAME_MAX + 7]; uint16_t port; int family; void *padding [4]; } mongoc_host_list_t; Description The host and port of a MongoDB server. Can be part of a linked list: for…
mongoc_gridfs_t – mongoc_gridfs_t provides a MongoDB gridfs implementation. The system as a whole is made up of gridfs objects, which contain gridfs_files and gridfs_file_lists. Essentially, a basic file system API. Synopsis #include <mongoc.h> typedef struct _mongoc_gridfs_t mongoc_gridfs_t; Description mongoc_gridfs_t provides a MongoDB gridfs implementation. The system as a whole is made up of gridfs objects,…
mongoc_gridfs_remove_by_filename() – Removes all files matching filename and their data chunks from the MongoDB server. Synopsis bool mongoc_gridfs_remove_by_filename (mongoc_gridfs_t *gridfs, const char *filename, bson_error_t *error); Parameters gridfs A mongoc_gridfs_t \&. filename A UTF-8 encoded string containing the filename. error An optional location for a bson_error_t or NULL \&. Description Removes all files matching filename and…
mongoc_gridfs_get_files() – Retrieves the mongoc_collection_t containing the file metadata for GridFS. This instance is owned by the mongoc_gridfs_t and should not be modified or freed. Synopsis mongoc_collection_t * mongoc_gridfs_get_files (mongoc_gridfs_t *gridfs); Parameters gridfs A mongoc_gridfs_t \&. Description Retrieves the mongoc_collection_t containing the file metadata for GridFS. This instance is owned by the mongoc_gridfs_t and should…
mongoc_gridfs_get_chunks() – Returns a mongoc_collection_t that contains the chunks for files. This instance is owned by the mongoc_gridfs_t instance and should not be modified or freed. Synopsis mongoc_collection_t * mongoc_gridfs_get_chunks (mongoc_gridfs_t *gridfs); Parameters gridfs A mongoc_gridfs_t \&. Description Returns a mongoc_collection_t that contains the chunks for files. This instance is owned by the mongoc_gridfs_t instance…
mongoc_gridfs_find_one_by_filename() – Finds the first file matching the filename specified. If no file could be found, NULL is returned and error is set. Synopsis mongoc_gridfs_file_t * mongoc_gridfs_find_one_by_filename (mongoc_gridfs_t *gridfs, const char *filename, bson_error_t *error); Parameters gridfs A mongoc_gridfs_t \&. filename A UTF-8 encoded string containing the filename. error An optional location for a bson_error_t or…
mongoc_gridfs_find_one() – This function shall execute a query on the underlying gridfs implementation. The first file matching query will be returned. Synopsis mongoc_gridfs_file_t * mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs, const bson_t *query, bson_error_t *error); Parameters gridfs A mongoc_gridfs_t \&. query A bson_t \&. error An optional location for a bson_error_t or NULL \&. Description This function shall…
mongoc_gridfs_find() – Finds all gridfs files matching query. You can iterate the matched gridfs files with the resulting file list. Synopsis mongoc_gridfs_file_list_t * mongoc_gridfs_find (mongoc_gridfs_t *gridfs, const bson_t *query); Parameters gridfs A mongoc_gridfs_t \&. query A bson_t \&. Description Finds all gridfs files matching query \&. You can iterate the matched gridfs files with the…
mongoc_gridfs_file_writev() – Performs a gathered write to the underlying gridfs file. Synopsis ssize_t mongoc_gridfs_file_writev (mongoc_gridfs_file_t *file, mongoc_iovec_t *iov, size_t iovcnt, uint32_t timeout_msec); Parameters file A mongoc_gridfs_file_t \&. iov An array of mongoc_iovec_t \&. iovcnt The number of elements in iov \&. timeout_msec A uint32_t with the timeout in milliseconds. Description Performs a gathered write to…
mongoc_gridfs_file_tell() – This function returns the current position indicator within file. Synopsis uint64_t mongoc_gridfs_file_tell (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description This function returns the current position indicator within file \&. Returns Returns a file position as an unsigned 64-bit integer. Colophon This page is part of MongoDB C Driver. Please report any bugs…