MongoDB C++ Driver mongocxx-3.4.0
Loading...
Searching...
No Matches
create_view.hpp
1// Copyright 2016 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/pipeline.hpp>
20#include <mongocxx/stdx.hpp>
21#include <mongocxx/write_concern.hpp>
22
23#include <mongocxx/config/prelude.hpp>
24
25namespace mongocxx {
26MONGOCXX_INLINE_NAMESPACE_BEGIN
27namespace options {
28
35class MONGOCXX_API create_view {
36 public:
37 create_view() = default;
38
39 create_view(const create_view& other) = delete;
40 create_view& operator=(const create_view& other) = delete;
41
56
66 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
67
79
86 const stdx::optional<class pipeline>& pipeline() const;
87
99
106 const stdx::optional<class mongocxx::write_concern>& write_concern() const;
107
117 MONGOCXX_DEPRECATED bsoncxx::document::value to_document() const;
118 bsoncxx::document::value to_document_deprecated() const;
119
125 MONGOCXX_DEPRECATED MONGOCXX_INLINE operator bsoncxx::document::value() const;
126
127 private:
128 stdx::optional<bsoncxx::document::view_or_value> _collation;
129 stdx::optional<class pipeline> _pipeline;
130 stdx::optional<class write_concern> _write_concern;
131};
132
133MONGOCXX_INLINE create_view::operator bsoncxx::document::value() const {
134 return to_document_deprecated();
135}
136
137} // namespace options
138MONGOCXX_INLINE_NAMESPACE_END
139} // namespace mongocxx
140
141#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 view creation operation.
Definition create_view.hpp:35
create_view & write_concern(mongocxx::write_concern write_concern)
Sets the write concern that will be used when computing this view.
const stdx::optional< class mongocxx::write_concern > & write_concern() const
Gets the write concern that will be used when computing this view.
create_view & collation(bsoncxx::document::view_or_value collation)
Sets the default collation for this view.
const stdx::optional< class pipeline > & pipeline() const
Gets the pipeline that will be used to compute this view.
create_view & pipeline(pipeline pipeline)
Sets the pipeline that will be used to compute this view.
bsoncxx::document::value to_document() const
Return a bson document representing the options set on this object.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Gets the default collation for this view.
Class representing a MongoDB aggregation pipeline.
Definition pipeline.hpp:37
Class representing the server-side requirement for reporting the success of a write operation.
Definition write_concern.hpp:56
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24