mongocxx::validation_criteria Class Reference

Class representing criteria for document validation, to be applied to a collection. More...

#include <validation_criteria.hpp>

Public Types
enum class	validation_level
	A class to represent the different validation level options.
enum class	validation_action
	A class to represent the different validation action options. More...

Public Member Functions
void	rule (bsoncxx::document::view_or_value rule)
	Set a validation rule for this validation object.
void	level (validation_level level)
	Set a validation level.
void	action (validation_action action)
	Set a validation action to run when documents failing validation are inserted or modified.
bsoncxx::document::value	to_document () const
	Return a bson document representing this set of validation criteria.
	operator bsoncxx::document::value () const

Detailed Description

Class representing criteria for document validation, to be applied to a collection.

See also

https://docs.mongodb.org/manual/core/document-validation/

Member Enumeration Documentation

validation_action

enum class mongocxx::validation_criteria::validation_action

strong

A class to represent the different validation action options.

Todo:

document enum values

Member Function Documentation

action()

void mongocxx::validation_criteria::action

(

validation_action

action

)

Set a validation action to run when documents failing validation are inserted or modified.

Parameters

action

A validation action, either "error" or "warn."

level()

void mongocxx::validation_criteria::level

(

validation_level

level

)

Set a validation level.

Parameters

level

A validation level, "off," "strict," or "moderate."

operator bsoncxx::document::value()

mongocxx::validation_criteria::operator bsoncxx::document::value

(

)

const

Todo:

document this method

rule()

void mongocxx::validation_criteria::rule

(

bsoncxx::document::view_or_value

rule

)

Set a validation rule for this validation object.

Parameters

rule	Document representing a validation rule.

to_document()

bsoncxx::document::value mongocxx::validation_criteria::to_document

(

)

const

Return a bson document representing this set of validation criteria.

Returns

Validation criteria, as a document.

---

The documentation for this class was generated from the following file:

• src/mongocxx/validation_criteria.hpp