mongoc_collection_validate man page

mongoc_collection_validate() — This function is a helper function to execute the validate MongoDB command.

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
An optional location for a bson_t
error
An optional location for a bson_error_t or NULL

Description

This function is a helper function to execute the validate MongoDB command.

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

true if successful, otherwise false and error is set.

reply is always initialized if it's not NULL and must be destroyed with bson_destroy(3)

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐11‐07 MongoDB C Driver