mongoc_gridfs_file_t – This structure provides a MongoDB GridFS file abstraction. It provides several APIs. Synopsis typedef struct _mongoc_gridfs_file_t mongoc_gridfs_file_t; Description This structure provides a MongoDB GridFS file abstraction. It provides several APIs. \[bu] readv, writev, seek, and tell. \[bu] General file metadata such as filename and length. \[bu] GridFS metadata such as md5, filename, content_type,…
mongoc_gridfs_file_set_metadata() – Sets the metadata associated with file. Synopsis void mongoc_gridfs_file_set_metadata (mongoc_gridfs_file_t *file, const bson_t *metadata); Parameters file A mongoc_gridfs_file_t \&. bson A bson_t containing metadata for file \&. Description Sets the metadata associated with file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. Colophon This page is part of MongoDB C Driver….
mongoc_gridfs_file_set_metadata() – Sets the metadata associated with file. Synopsis void mongoc_gridfs_file_set_metadata (mongoc_gridfs_file_t *file, const bson_t *metadata); Parameters file A mongoc_gridfs_file_t \&. bson A bson_t containing metadata for file \&. Description Sets the metadata associated with file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. Colophon This page is part of MongoDB C Driver….
mongoc_gridfs_file_set_md5() – Sets the MD5 checksum for file. Synopsis void mongoc_gridfs_file_set_md5 (mongoc_gridfs_file_t *file, const char *md5); Parameters file A mongoc_gridfs_file_t \&. str A string containing the MD5 of the file. Description Sets the MD5 checksum for file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. Colophon This page is part of MongoDB C…
mongoc_gridfs_file_set_filename() – Sets the filename for file. Synopsis void mongoc_gridfs_file_set_filename (mongoc_gridfs_file_t *file, const char *filename); Parameters file A mongoc_gridfs_file_t \&. str A UTF-8 encoded string containing the filename. Description Sets the filename for file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. Colophon This page is part of MongoDB C Driver. Please report…
mongoc_gridfs_file_set_content_type() – Sets the content type for the gridfs file. This should be something like "text/plain". Synopsis void mongoc_gridfs_file_set_content_type (mongoc_gridfs_file_t *file, const char *content_type); Parameters file A mongoc_gridfs_file_t \&. str A string containing the content type. Description Sets the content type for the gridfs file. This should be something like text/plain \&. You need to…
mongoc_gridfs_file_set_aliases() – Sets the aliases for a gridfs file. Synopsis void mongoc_gridfs_file_set_aliases (mongoc_gridfs_file_t *file, const bson_t *bson); Parameters file A mongoc_gridfs_file_t \&. bson A bson_t containing the aliases. Description Sets the aliases for a gridfs file. You need to call mongoc_gridfs_file_save(3) to persist this change. Colophon This page is part of MongoDB C Driver. Please…
mongoc_gridfs_file_seek() – Adjust the file position pointer in the given file by delta, starting from the position whence. The whence argument is interpreted as in fseek(2): Synopsis int mongoc_gridfs_file_seek (mongoc_gridfs_file_t *file, int64_t delta, int whence); Parameters file A mongoc_gridfs_file_t \&. delta The amount to move the file position. May be positive or negative. whence One…
mongoc_gridfs_file_save() – Saves modifications to file to the MongoDB server. Synopsis bool mongoc_gridfs_file_save (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description Saves modifications to file to the MongoDB server. If an error occurred, false is returned and the error can be retrieved with mongoc_gridfs_file_error(3) \&. Returns Returns true if successful, otherwise false. Colophon This page…
mongoc_gridfs_file_remove() – Removes file and its data chunks from the MongoDB server. Synopsis bool mongoc_gridfs_file_remove (mongoc_gridfs_file_t *file, bson_error_t *error); Parameters file A mongoc_gridfs_file_t \&. error An optional location for a bson_error_t or NULL \&. Description Removes file and its data chunks from the MongoDB server. Returns Returns true if successful, otherwise false and error is…
mongoc_gridfs_file_readv() – This function performs a scattered read from file, potentially blocking to read from the MongoDB server. Synopsis ssize_t mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file, mongoc_iovec_t *iov, size_t iovcnt, size_t min_bytes, 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 \&. min_bytes The minimum number of…
mongoc_gridfs_file_opt_t – This structure contains options that can be set on a mongoc_gridfs_file_t. It can be used by various functions when creating a new gridfs file. Synopsis typedef struct { const char *md5; const char *filename; const char *content_type; const bson_t *aliases; const bson_t *metadata; uint32_t chunk_size; } mongoc_gridfs_file_opt_t; Description This structure contains options that…
mongoc_gridfs_file_list_t – mongoc_gridfs_file_list_t provides a gridfs file list abstraction. It provides iteration and basic marshalling on top of a regular mongoc_collection_find() style query. In interface, it’s styled after mongoc_cursor_t. Synopsis #include <mongoc.h> typedef struct _mongoc_gridfs_file_list_t mongoc_gridfs_file_list_t; Description mongoc_gridfs_file_list_t provides a gridfs file list abstraction. It provides iteration and basic marshalling on top of a regular…
mongoc_gridfs_file_list_next() – This function shall iterate the underlying gridfs file list, returning the next file each iteration. This is a blocking function. Synopsis mongoc_gridfs_file_t * mongoc_gridfs_file_list_next (mongoc_gridfs_file_list_t *list); Parameters list A mongoc_gridfs_file_list_t \&. Description This function shall iterate the underlying gridfs file list, returning the next file each iteration. This is a blocking function. Returns…
mongoc_gridfs_file_list_error() – Fetches any error that has occurred while trying to retrieve the file list. Synopsis bool mongoc_gridfs_file_list_error (mongoc_gridfs_file_list_t *list, bson_error_t *error); Parameters list A mongoc_gridfs_file_list_t \&. error An optional location for a bson_error_t or NULL \&. Description Fetches any error that has occurred while trying to retrieve the file list. Errors Errors are propagated…
mongoc_gridfs_file_list_destroy() – Frees a mongoc_gridfs_file_list_t and releases any associated resources. Synopsis void mongoc_gridfs_file_list_destroy (mongoc_gridfs_file_list_t *list); Parameters list A mongoc_gridfs_file_list_t \&. Description Frees a mongoc_gridfs_file_list_t and releases any associated resources. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_gridfs_file_get_upload_date() – Fetches the specified upload date of the gridfs file in milliseconds since the UNIX epoch. Synopsis int64_t mongoc_gridfs_file_get_upload_date (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description Fetches the specified upload date of the gridfs file in milliseconds since the UNIX epoch. Returns A signed int64 with the upload date in milliseconds since the…
mongoc_gridfs_file_get_metadata() – Fetches a bson document containing the metadata for the gridfs file. Synopsis const bson_t * mongoc_gridfs_file_get_metadata (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description Fetches a bson document containing the metadata for the gridfs file. Returns Returns a const bson_t * that should not be modified or freed. Colophon This page is part…
mongoc_gridfs_file_get_md5() – Fetches the pre-computed MD5 for the underlying gridfs file. Synopsis const char * mongoc_gridfs_file_get_md5 (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description Fetches the pre-computed MD5 for the underlying gridfs file. Returns Returns a string that should not be modified or freed. Colophon This page is part of MongoDB C Driver. Please report…
mongoc_gridfs_file_get_length() – Fetches the length of the gridfs file in bytes. Synopsis int64_t mongoc_gridfs_file_get_length (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. Description Fetches the length of the gridfs file in bytes. Returns A 64-bit signed integer. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.