1MONGOC_GRIDFS_FIND_ONE(3)          libmongoc         MONGOC_GRIDFS_FIND_ONE(3)
2
3
4

NAME

6       mongoc_gridfs_find_one - mongoc_gridfs_find_one()
7

DEPRECATED

9       This  function  is deprecated, use mongoc_gridfs_find_one_with_opts in‐
10       stead.
11

SYNOPSIS

13          mongoc_gridfs_file_t *
14          mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,
15                                  const bson_t *query,
16                                  bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT
17             BSON_GNUC_DEPRECATED_FOR (mongoc_gridfs_find_one_with_opts);
18

PARAMETERS

20       • gridfs: A mongoc_gridfs_t.
21
22       • query: A bson_t.
23
24       • error: An optional location for a bson_error_t or NULL.
25

DESCRIPTION

27       This function shall execute a query on the underlying gridfs  implemen‐
28       tation.  The first file matching query will be returned. If there is an
29       error, NULL is returned and error is filled out; if there is  no  error
30       but  no matching file is found, NULL is returned and the error code and
31       domain are 0.
32
33       This function is considered a retryable read operation.  Upon  a  tran‐
34       sient error (a network error, errors due to replica set failover, etc.)
35       the operation is safely retried once.  If retryreads is  false  in  the
36       URI (see mongoc_uri_t) the retry behavior does not apply.
37

ERRORS

39       Errors are propagated via the error parameter.
40

RETURNS

42       A  newly  allocated  mongoc_gridfs_file_t  or  NULL if no file could be
43       found. You must free the  resulting  file  with  mongoc_gridfs_file_de‐
44       stroy() if non-NULL.
45

AUTHOR

47       MongoDB, Inc
48

50       2017-present, MongoDB, Inc
51
52
53
54
551.20.0                           Nov 18, 2021        MONGOC_GRIDFS_FIND_ONE(3)
Impressum