SYNOPSIS

mongoc_gridfs_file_t *
mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,


                        const bson_t *query,


                        bson_error_t *error);

PARAMETERS

DESCRIPTION

This function shall execute a query on the underlying gridfs implementation. The first file matching query will be returned. If there is an error, NULL is returned and error is filled out; if there is no error but no matching file is found, NULL is returned and the error code and domain are 0.

This function is considered a retryable read operation. Upon a transient error (a network error, errors due to replica set failover, etc.) the operation is safely retried once. If retryreads is false in the URI (see mongoc_uri_t <>) the retry behavior does not apply.

ERRORS

Errors are propagated via the error parameter.

RETURNS

A newly allocated mongoc_gridfs_file_t <> or NULL if no file could be found. You must free the resulting file with mongoc_gridfs_file_destroy() <> if non-NULL.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.