MongoDB C++ Driver  mongocxx-3.2.0
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:
49  MONGOCXX_DEPRECATED create_collection& auto_index_id(bool auto_index_id);
50  create_collection& auto_index_id_deprecated(bool auto_index_id);
51 
58  const stdx::optional<bool>& auto_index_id() const;
59 
74  create_collection& capped(bool capped);
75 
84  const stdx::optional<bool>& capped() const;
85 
100 
110  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
111 
126  create_collection& max(std::int64_t max_documents);
127 
135  const stdx::optional<std::int64_t>& max() const;
136 
149  create_collection& no_padding(bool no_padding);
150 
159  const stdx::optional<bool>& no_padding() const;
160 
176  create_collection& size(std::int64_t max_size);
177 
184  const stdx::optional<std::int64_t>& size() const;
185 
198  create_collection& storage_engine(bsoncxx::document::view_or_value storage_engine_opts);
199 
206  const stdx::optional<bsoncxx::document::view_or_value>& storage_engine() const;
207 
221 
230  const stdx::optional<class validation_criteria>& validation_criteria() const;
231 
241  MONGOCXX_DEPRECATED bsoncxx::document::value to_document() const;
242  bsoncxx::document::value to_document_deprecated() const;
243 
249  MONGOCXX_DEPRECATED MONGOCXX_INLINE operator bsoncxx::document::value() const;
250 
251  private:
252  stdx::optional<bool> _auto_index_id;
253  stdx::optional<bool> _capped;
254  stdx::optional<bsoncxx::document::view_or_value> _collation;
255  stdx::optional<std::int64_t> _max_documents;
256  stdx::optional<std::int64_t> _max_size;
257  stdx::optional<bool> _no_padding;
258  stdx::optional<bsoncxx::document::view_or_value> _storage_engine_opts;
259  stdx::optional<class validation_criteria> _validation;
260 
261  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const create_collection&,
262  const create_collection&);
263  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const create_collection&,
264  const create_collection&);
265 };
266 
267 MONGOCXX_INLINE create_collection::operator bsoncxx::document::value() const {
268  return to_document_deprecated();
269 }
270 
271 } // namespace options
272 MONGOCXX_INLINE_NAMESPACE_END
273 } // namespace mongocxx
274 
275 #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:22
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33