MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
change_stream.hpp
1 // Copyright 2018-present 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 <chrono>
18 
19 #include <bsoncxx/document/view_or_value.hpp>
20 #include <bsoncxx/string/view_or_value.hpp>
21 #include <bsoncxx/types.hpp>
22 #include <bsoncxx/types/bson_value/view_or_value.hpp>
23 #include <mongocxx/stdx.hpp>
24 
25 #include <mongocxx/config/prelude.hpp>
26 
27 namespace mongocxx {
28 inline namespace v_noabi {
29 class client;
30 class collection;
31 class database;
32 
33 namespace options {
34 
38 class MONGOCXX_API change_stream {
39  public:
40  change_stream();
41 
69  change_stream& full_document(bsoncxx::string::view_or_value full_doc);
70 
77  const bsoncxx::stdx::optional<bsoncxx::string::view_or_value>& full_document() const;
78 
99  bsoncxx::string::view_or_value full_doc_before_change);
100 
107  const bsoncxx::stdx::optional<bsoncxx::string::view_or_value>& full_document_before_change()
108  const;
109 
120  change_stream& batch_size(std::int32_t batch_size);
121 
128  const stdx::optional<std::int32_t>& batch_size() const;
129 
141 
148  const stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
149 
165  change_stream& resume_after(bsoncxx::document::view_or_value resume_after);
166 
173  const stdx::optional<bsoncxx::document::view_or_value>& resume_after() const;
174 
192  change_stream& start_after(bsoncxx::document::view_or_value token);
193 
200  const stdx::optional<bsoncxx::document::view_or_value>& start_after() const;
201 
212  change_stream& collation(bsoncxx::document::view_or_value collation);
213 
220  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
221 
233  change_stream& max_await_time(std::chrono::milliseconds max_time);
234 
241  const stdx::optional<std::chrono::milliseconds>& max_await_time() const;
242 
257  change_stream& start_at_operation_time(bsoncxx::types::b_timestamp timestamp);
258 
259  private:
260  friend class ::mongocxx::client;
261  friend class ::mongocxx::collection;
262  friend class ::mongocxx::database;
263 
264  bsoncxx::document::value as_bson() const;
265  stdx::optional<bsoncxx::string::view_or_value> _full_document;
266  stdx::optional<bsoncxx::string::view_or_value> _full_document_before_change;
267  stdx::optional<std::int32_t> _batch_size;
268  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
269  stdx::optional<bsoncxx::document::view_or_value> _collation;
270  stdx::optional<bsoncxx::document::view_or_value> _resume_after;
271  stdx::optional<bsoncxx::document::view_or_value> _start_after;
272  stdx::optional<std::chrono::milliseconds> _max_await_time;
273  // _start_at_operation_time is not wrapped in a stdx::optional because of a longstanding bug in
274  // the MNMLSTC polyfill that has been fixed on master, but not in the latest release:
275  // https://github.com/mnmlstc/core/pull/23
276  bsoncxx::types::b_timestamp _start_at_operation_time = {};
277  bool _start_at_operation_time_set = false;
278 };
279 } // namespace options
280 } // namespace v_noabi
281 } // namespace mongocxx
282 
283 #include <mongocxx/config/postlude.hpp>
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:29
Class representing MongoDB change stream options.
Definition: change_stream.hpp:38
change_stream & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const bsoncxx::stdx::optional< bsoncxx::string::view_or_value > & full_document_before_change() const
Gets the current fullDocumentBeforeChange option.
change_stream & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
change_stream & resume_after(bsoncxx::document::view_or_value resume_after)
Specifies the logical starting point for the new change stream.
const stdx::optional< bsoncxx::document::view_or_value > & resume_after() const
Retrieves the current resumeToken for this change stream.
const bsoncxx::stdx::optional< bsoncxx::string::view_or_value > & full_document() const
Gets the current fullDocument option.
change_stream & max_await_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for for the server to wait on new documents to satisfy a change strea...
change_stream & start_after(bsoncxx::document::view_or_value token)
Specifies the logical starting point of the new change stream.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
const stdx::optional< bsoncxx::document::view_or_value > & start_after() const
Retrieves the current startAfter token for this change stream.
change_stream & start_at_operation_time(bsoncxx::types::b_timestamp timestamp)
Specifies the logical starting point for the new change stream.
change_stream & full_document(bsoncxx::string::view_or_value full_doc)
Sets the fullDocument option for the $changeStream.
const stdx::optional< std::chrono::milliseconds > & max_await_time() const
The current max_time setting.
change_stream & full_document_before_change(bsoncxx::string::view_or_value full_doc_before_change)
Sets the fullDocumentBeforeChange option for the $changeStream.
const stdx::optional< std::int32_t > & batch_size() const
The current batch size setting.
change_stream & comment(bsoncxx::types::bson_value::view_or_value comment)
Sets the current value of the comment option.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24