MongoDB C++ Driver  mongocxx-3.4.0
index_model.hpp
1 // Copyright 2017 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/value.hpp>
18 #include <bsoncxx/document/view_or_value.hpp>
19 #include <mongocxx/options/index.hpp>
20 
21 #include <mongocxx/config/prelude.hpp>
22 
23 namespace mongocxx {
24 MONGOCXX_INLINE_NAMESPACE_BEGIN
25 
29 class MONGOCXX_API index_model {
30  public:
35  const bsoncxx::document::view_or_value& options = {});
36 
37  index_model() = delete;
38 
42  index_model(index_model&&) noexcept;
43 
47  index_model& operator=(index_model&&) noexcept;
48 
52  index_model(const index_model&);
53 
54  index_model& operator=(const index_model&) = delete;
55 
59  ~index_model();
60 
64  bsoncxx::document::view keys() const;
65 
69  bsoncxx::document::view options() const;
70 
71  private:
73  bsoncxx::document::value _options;
74 };
75 
76 MONGOCXX_INLINE_NAMESPACE_END
77 } // namespace mongocxx
78 
79 #include <mongocxx/config/postlude.hpp>
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
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
Class representing an index on a MongoDB server.
Definition: index_model.hpp:29