FreeBSD Manual Pages
MONGOC_COLLECTION_VALIDATE(3) libmongoc MONGOC_COLLECTION_VALIDATE(3) WARNING: Deprecated since version 1.10.0: Run the validate command directly with mongoc_client_read_command_with_opts() instead. SYNOPSIS bool mongoc_collection_validate (mongoc_collection_t *collection, const bson_t *options, bson_t *reply, bson_error_t *error); PARAMETERS • collection: A mongoc_collection_t. • options: A bson_t. • 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 This function is a helper function to execute the validate MongoDB com- mand. Currently, the only supported options are full, which is a boolean and scandata, also a boolean. See the MongoDB documentation for more information on this command. 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 if it's not NULL and must be destroyed with bson_destroy(). AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.2 Apr 12, 2025 MONGOC_COLLECTION_VALIDATE(3)
WARNING: | SYNOPSIS | PARAMETERS | DESCRIPTION | ERRORS | RETURNS | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_collection_validate&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>