Linux Manuals

mongoc_gridfs_file_set_metadata() – Sets the metadata associated with file. Synopsisvoid mongoc_gridfs_file_set_metadata (mongoc_gridfs_file_t *file, const bson_t *metadata);Parametersfile A mongoc_gridfs_file_t \&.bson A bson_t containing metadata for file \&.DescriptionSets the metadata associated with file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_set_metadata() – Sets the metadata associated with file. Synopsisvoid mongoc_gridfs_file_set_metadata (mongoc_gridfs_file_t *file, const bson_t *metadata);Parametersfile A mongoc_gridfs_file_t \&.bson A bson_t containing metadata for file \&.DescriptionSets the metadata associated with file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_set_md5() – Sets the MD5 checksum for file. Synopsisvoid mongoc_gridfs_file_set_md5 (mongoc_gridfs_file_t *file, const char *md5);Parametersfile A mongoc_gridfs_file_t \&.str A string containing the MD5 of the file.DescriptionSets the MD5 checksum for file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_set_filename() – Sets the filename for file. Synopsisvoid mongoc_gridfs_file_set_filename (mongoc_gridfs_file_t *file, const char *filename);Parametersfile A mongoc_gridfs_file_t \&.str A UTF-8 encoded string containing the filename.DescriptionSets the filename for file \&. You need to call mongoc_gridfs_file_save(3) to persist this change. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_set_content_type() – Sets the content type for the gridfs file. This should be something like "text/plain". Synopsisvoid mongoc_gridfs_file_set_content_type (mongoc_gridfs_file_t *file, const char *content_type);Parametersfile A mongoc_gridfs_file_t \&.str A string containing the content type.DescriptionSets the content type for the gridfs file. This should be something like text/plain \&. You need to call mongoc_gridfs_file_save(3) to persist this change….

mongoc_gridfs_file_set_aliases() – Sets the aliases for a gridfs file. Synopsisvoid mongoc_gridfs_file_set_aliases (mongoc_gridfs_file_t *file, const bson_t *bson);Parametersfile A mongoc_gridfs_file_t \&.bson A bson_t containing the aliases.DescriptionSets the aliases for a gridfs file. You need to call mongoc_gridfs_file_save(3) to persist this change. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

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): Synopsisint mongoc_gridfs_file_seek (mongoc_gridfs_file_t *file, int64_t delta, int whence);Parametersfile A mongoc_gridfs_file_t \&.delta The amount to move the file position. May be positive or negative.whence One of SEEK_SET, SEEK_CUR or SEEK_END.DescriptionAdjust…

mongoc_gridfs_file_save() – Saves modifications to file to the MongoDB server. Synopsisbool mongoc_gridfs_file_save (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionSaves 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) \&. ReturnsReturns true if successful, otherwise false. ColophonThis page is part of MongoDB C Driver. Please…

mongoc_gridfs_file_remove() – Removes file and its data chunks from the MongoDB server. Synopsisbool mongoc_gridfs_file_remove (mongoc_gridfs_file_t *file, bson_error_t *error);Parametersfile A mongoc_gridfs_file_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionRemoves file and its data chunks from the MongoDB server. ReturnsReturns true if successful, otherwise false and error is set. ErrorsErrors are propagated via the error…

mongoc_gridfs_file_readv() – This function performs a scattered read from file, potentially blocking to read from the MongoDB server. Synopsisssize_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);Parametersfile 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 bytes that must be read or…

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. Synopsistypedef 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;DescriptionThis structure contains options that can be set…

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;Descriptionmongoc_gridfs_file_list_t provides a gridfs file list abstraction. It provides iteration and basic marshalling on top of a regular mongoc_collection_find(3) style query….

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. Synopsismongoc_gridfs_file_t * mongoc_gridfs_file_list_next (mongoc_gridfs_file_list_t *list);Parameterslist A mongoc_gridfs_file_list_t \&.DescriptionThis function shall iterate the underlying gridfs file list, returning the next file each iteration. This is a blocking function. ReturnsA newly allocated mongoc_gridfs_file_t that should…

mongoc_gridfs_file_list_error() – Fetches any error that has occurred while trying to retrieve the file list. Synopsisbool mongoc_gridfs_file_list_error (mongoc_gridfs_file_list_t *list, bson_error_t *error);Parameterslist A mongoc_gridfs_file_list_t \&.error An optional location for a bson_error_t or NULL \&.DescriptionFetches any error that has occurred while trying to retrieve the file list. ErrorsErrors are propagated via the error parameter. Returnsfalse if no…

mongoc_gridfs_file_list_destroy() – Frees a mongoc_gridfs_file_list_t and releases any associated resources. Synopsisvoid mongoc_gridfs_file_list_destroy (mongoc_gridfs_file_list_t *list);Parameterslist A mongoc_gridfs_file_list_t \&.DescriptionFrees a mongoc_gridfs_file_list_t and releases any associated resources. ColophonThis 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. Synopsisint64_t mongoc_gridfs_file_get_upload_date (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionFetches the specified upload date of the gridfs file in milliseconds since the UNIX epoch. ReturnsA signed int64 with the upload date in milliseconds since the UNIX epoch. ColophonThis page is part…

mongoc_gridfs_file_get_metadata() – Fetches a bson document containing the metadata for the gridfs file. Synopsisconst bson_t * mongoc_gridfs_file_get_metadata (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionFetches a bson document containing the metadata for the gridfs file. ReturnsReturns a const bson_t * that should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any…

mongoc_gridfs_file_get_md5() – Fetches the pre-computed MD5 for the underlying gridfs file. Synopsisconst char * mongoc_gridfs_file_get_md5 (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionFetches the pre-computed MD5 for the underlying gridfs file. ReturnsReturns a string that should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_get_length() – Fetches the length of the gridfs file in bytes. Synopsisint64_t mongoc_gridfs_file_get_length (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionFetches the length of the gridfs file in bytes. ReturnsA 64-bit signed integer. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_gridfs_file_get_id() – Fetches the id of a gridfs file. Synopsisconst bson_value_t * mongoc_gridfs_file_get_id (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&.DescriptionFetches the id of a gridfs file. The C Driver always uses an ObjectId for _id , but files created by other drivers may have any type of _id \&. ReturnsReturns a const bson_value_t * that should not…