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

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_COLLECTION_STATS(3)	   libmongoc	    MONGOC_COLLECTION_STATS(3)

WARNING:
	  Deprecated  since  version  1.10.0:  Use  the	$collStats aggregation
	  pipeline stage with mongoc_collection_aggregate() instead.

SYNOPSIS
	  bool
	  mongoc_collection_stats (mongoc_collection_t *collection,
				   const bson_t	*options,
				   bson_t *reply,
				   bson_error_t	*error);

PARAMETERS
        collection: A mongoc_collection_t.

        options: An optional bson_t containing	extra options to pass  to  the
	 collStats command.

        reply:	 A  maybe-NULL pointer to overwritable storage for a bson_t to
	 contain the results.

        error:	An optional location for a bson_error_t	or NULL.

DESCRIPTION
       Run the collStats command to retrieve statistics	about the collection.

       The command uses	the mongoc_read_prefs_t	set on collection.

ERRORS
       Errors are propagated via the error parameter.

RETURNS
       Returns true if successful. Returns false and sets error	if  there  are
       invalid arguments or a server or	network	error.

       reply is	always initialized and must be freed with bson_destroy().

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025	    MONGOC_COLLECTION_STATS(3)

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

home | help