MongoDB C++ Driver mongocxx-3.6.7
validation_criteria.hpp
1// Copyright 2015 MongoDB Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <bsoncxx/document/view_or_value.hpp>
18#include <bsoncxx/stdx/optional.hpp>
19#include <mongocxx/stdx.hpp>
20
21#include <mongocxx/config/prelude.hpp>
22
23namespace mongocxx {
24MONGOCXX_INLINE_NAMESPACE_BEGIN
25
31class MONGOCXX_API validation_criteria {
32 public:
44
51 const stdx::optional<bsoncxx::document::view_or_value>& rule() const;
52
61 enum class validation_level {
62 k_off,
63 k_moderate,
64 k_strict,
65 };
66
78
85 const stdx::optional<validation_level>& level() const;
86
94 enum class validation_action {
95 k_error,
96 k_warn,
97 };
98
110
118 const stdx::optional<validation_action>& action() const;
119
129 MONGOCXX_DEPRECATED bsoncxx::document::value to_document() const;
130 bsoncxx::document::value to_document_deprecated() const;
131
137 MONGOCXX_DEPRECATED MONGOCXX_INLINE operator bsoncxx::document::value() const;
138
139 private:
140 stdx::optional<bsoncxx::document::view_or_value> _rule;
141 stdx::optional<validation_level> _level;
142 stdx::optional<validation_action> _action;
143};
144
145MONGOCXX_API bool MONGOCXX_CALL operator==(const validation_criteria& lhs,
146 const validation_criteria& rhs);
147MONGOCXX_API bool MONGOCXX_CALL operator!=(const validation_criteria& lhs,
148 const validation_criteria& rhs);
149
150MONGOCXX_INLINE validation_criteria::operator bsoncxx::document::value() const {
151 return to_document_deprecated();
152}
153
154MONGOCXX_INLINE_NAMESPACE_END
155} // namespace mongocxx
156
157#include <mongocxx/config/postlude.hpp>
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33
Class representing criteria for document validation, to be applied to a collection.
Definition: validation_criteria.hpp:31
const stdx::optional< validation_level > & level() const
Gets the validation level.
validation_criteria & rule(bsoncxx::document::view_or_value rule)
Sets a validation rule for this validation object.
validation_criteria & action(validation_action action)
Sets a validation action to run when documents failing validation are inserted or modified.
const stdx::optional< bsoncxx::document::view_or_value > & rule() const
Gets the validation rule for this validation object.
const stdx::optional< validation_action > & action() const
Gets the validation action to run when documents failing validation are inserted or modified.
validation_level
A class to represent the different validation level options.
Definition: validation_criteria.hpp:61
validation_criteria & level(validation_level level)
Sets a validation level.
validation_action
A class to represent the different validation action options.
Definition: validation_criteria.hpp:94
MONGOCXX_DEPRECATED bsoncxx::document::value to_document() const
Returns a bson document representing this set of validation criteria.
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24