MongoDB C++ Driver mongocxx-3.4.0
Loading...
Searching...
No Matches
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
24namespace mongocxx {
25MONGOCXX_INLINE_NAMESPACE_BEGIN
26namespace options {
27
31class 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
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
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
265MONGOCXX_INLINE create_collection::operator bsoncxx::document::value() const {
266 return to_document_deprecated();
267}
268
269} // namespace options
270MONGOCXX_INLINE_NAMESPACE_END
271} // namespace mongocxx
272
273#include <mongocxx/config/postlude.hpp>
A read-only BSON document that owns its underlying buffer.
Definition value.hpp:33
Class representing the optional arguments to a MongoDB createCollection command.
Definition create_collection.hpp:31
bsoncxx::document::value to_document() const
Return a bson document representing the options set on this object.
const stdx::optional< bool > & auto_index_id() const
Gets the current auto_index_id setting.
create_collection & size(std::int64_t max_size)
A maximum size, in bytes, for a capped collection.
create_collection & max(std::int64_t max_documents)
The maximum number of documents allowed in the capped collection.
const stdx::optional< std::int64_t > & max() const
Gets the current setting for the maximum number of documents allowed in the capped collection.
create_collection & capped(bool capped)
To create a capped collection, specify true.
const stdx::optional< std::int64_t > & size() const
Gets the current size setting, for a capped collection.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Gets the default collation for this collection.
create_collection & storage_engine(bsoncxx::document::view_or_value storage_engine_opts)
Specify configuration to the storage on a per-collection basis.
create_collection & auto_index_id(bool auto_index_id)
Specify false to disable the automatic creation of an index on the _id field.
const stdx::optional< class validation_criteria > & validation_criteria() const
Gets the current validation criteria for this collection.
create_collection & validation_criteria(class validation_criteria validation)
Specify validation criteria for this collection.
create_collection & collation(bsoncxx::document::view_or_value collation)
Sets the default collation for this collection.
const stdx::optional< bool > & capped() const
Gets the current capped setting.
create_collection & no_padding(bool no_padding)
When true, disables the power of 2 sizes allocation for the collection.
const stdx::optional< bsoncxx::document::view_or_value > & storage_engine() const
Gets the current storage engine configuration for this collection.
const stdx::optional< bool > & no_padding() const
Gets the current value of the "no padding" option for the collection.
Class representing criteria for document validation, to be applied to a collection.
Definition validation_criteria.hpp:31
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24