MongoDB C++ Driver  mongocxx-3.1.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:
41  create_collection& auto_index_id(bool auto_index_id);
42 
49  const stdx::optional<bool>& auto_index_id() const;
50 
61  create_collection& capped(bool capped);
62 
71  const stdx::optional<bool>& capped() const;
72 
83 
93  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
94 
105  create_collection& max(int max_documents);
106 
114  const stdx::optional<int>& max() const;
115 
124  create_collection& no_padding(bool no_padding);
125 
134  const stdx::optional<bool>& no_padding() const;
135 
147  create_collection& size(int max_size);
148 
155  const stdx::optional<int>& size() const;
156 
165  create_collection& storage_engine(bsoncxx::document::view_or_value storage_engine_opts);
166 
173  const stdx::optional<bsoncxx::document::view_or_value>& storage_engine() const;
174 
184 
193  const stdx::optional<class validation_criteria>& validation_criteria() const;
194 
204  bsoncxx::document::value to_document() const;
205 
211  MONGOCXX_INLINE operator bsoncxx::document::value() const;
212 
213  private:
214  stdx::optional<bool> _auto_index_id;
215  stdx::optional<bool> _capped;
216  stdx::optional<bsoncxx::document::view_or_value> _collation;
217  stdx::optional<int> _max_documents;
218  stdx::optional<int> _max_size;
219  stdx::optional<bool> _no_padding;
220  stdx::optional<bsoncxx::document::view_or_value> _storage_engine_opts;
221  stdx::optional<class validation_criteria> _validation;
222 };
223 
224 MONGOCXX_INLINE create_collection::operator bsoncxx::document::value() const {
225  return to_document();
226 }
227 
228 } // namespace options
229 MONGOCXX_INLINE_NAMESPACE_END
230 } // namespace mongocxx
231 
232 #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
Definition: bulk_write.hpp:22
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33