MongoDB C++ Driver  mongocxx-3.3.0
All Classes Namespaces Functions Enumerations Enumerator Friends Pages
create_collection.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 #include <mongocxx/validation_criteria.hpp>
21 
22 #include <mongocxx/config/prelude.hpp>
23 
24 namespace mongocxx {
25 MONGOCXX_INLINE_NAMESPACE_BEGIN
26 namespace options {
27 
31 class MONGOCXX_API create_collection {
32  public:
47  MONGOCXX_DEPRECATED create_collection& auto_index_id(bool auto_index_id);
48  create_collection& auto_index_id_deprecated(bool auto_index_id);
49 
60  MONGOCXX_DEPRECATED const stdx::optional<bool>& auto_index_id() const;
61  const stdx::optional<bool>& auto_index_id_deprecated() const;
62 
77  create_collection& capped(bool capped);
78 
87  const stdx::optional<bool>& capped() const;
88 
103 
113  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
114 
129  create_collection& max(std::int64_t max_documents);
130 
138  const stdx::optional<std::int64_t>& max() const;
139 
152  create_collection& no_padding(bool no_padding);
153 
162  const stdx::optional<bool>& no_padding() const;
163 
179  create_collection& size(std::int64_t max_size);
180 
187  const stdx::optional<std::int64_t>& size() const;
188 
201  create_collection& storage_engine(bsoncxx::document::view_or_value storage_engine_opts);
202 
209  const stdx::optional<bsoncxx::document::view_or_value>& storage_engine() const;
210 
224 
233  const stdx::optional<class validation_criteria>& validation_criteria() const;
234 
244  MONGOCXX_DEPRECATED bsoncxx::document::value to_document() const;
245  bsoncxx::document::value to_document_deprecated() const;
246 
252  MONGOCXX_DEPRECATED MONGOCXX_INLINE operator bsoncxx::document::value() const;
253 
254  private:
255  stdx::optional<bool> _auto_index_id;
256  stdx::optional<bool> _capped;
257  stdx::optional<bsoncxx::document::view_or_value> _collation;
258  stdx::optional<std::int64_t> _max_documents;
259  stdx::optional<std::int64_t> _max_size;
260  stdx::optional<bool> _no_padding;
261  stdx::optional<bsoncxx::document::view_or_value> _storage_engine_opts;
262  stdx::optional<class validation_criteria> _validation;
263 
264  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const create_collection&,
265  const create_collection&);
266  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const create_collection&,
267  const create_collection&);
268 };
269 
270 MONGOCXX_INLINE create_collection::operator bsoncxx::document::value() const {
271  return to_document_deprecated();
272 }
273 
274 } // namespace options
275 MONGOCXX_INLINE_NAMESPACE_END
276 } // namespace mongocxx
277 
278 #include <mongocxx/config/postlude.hpp>
Class representing criteria for document validation, to be applied to a collection.
Definition: validation_criteria.hpp:31
Class representing the optional arguments to a MongoDB createCollection command.
Definition: create_collection.hpp:31
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33