Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_GRIDFS_FIND_ONE(3)	   libmongoc	     MONGOC_GRIDFS_FIND_ONE(3)

WARNING:
	  Deprecated  since  version  1.5.0:  This function is deprecated, use
	  mongoc_gridfs_find_one_with_opts() instead.

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 execute a query on the underlying gridfs  implemen-
       tation.	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	 tran-
       sient 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.

1.30.2				 Apr 12, 2025	     MONGOC_GRIDFS_FIND_ONE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_gridfs_find_one&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help