MongoDB C++ Driver mongocxx-3.7.0
Loading...
Searching...
No Matches
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
27namespace mongocxx {
28MONGOCXX_INLINE_NAMESPACE_BEGIN
29
30class client;
31class collection;
32class database;
33
34namespace options {
35
39class MONGOCXX_API change_stream {
40 public:
42
71
78 const bsoncxx::stdx::optional<bsoncxx::string::view_or_value>& full_document() const;
79
100 bsoncxx::string::view_or_value full_doc_before_change);
101
108 const bsoncxx::stdx::optional<bsoncxx::string::view_or_value>& full_document_before_change()
109 const;
110
121 change_stream& batch_size(std::int32_t batch_size);
122
129 const stdx::optional<std::int32_t>& batch_size() const;
130
142
149 const stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
150
167
174 const stdx::optional<bsoncxx::document::view_or_value>& resume_after() const;
175
194
201 const stdx::optional<bsoncxx::document::view_or_value>& start_after() const;
202
214
221 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
222
234 change_stream& max_await_time(std::chrono::milliseconds max_time);
235
242 const stdx::optional<std::chrono::milliseconds>& max_await_time() const;
243
259
260 private:
261 friend class ::mongocxx::client;
262 friend class ::mongocxx::collection;
263 friend class ::mongocxx::database;
264
265 bsoncxx::document::value as_bson() const;
266 stdx::optional<bsoncxx::string::view_or_value> _full_document;
267 stdx::optional<bsoncxx::string::view_or_value> _full_document_before_change;
268 stdx::optional<std::int32_t> _batch_size;
269 stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
270 stdx::optional<bsoncxx::document::view_or_value> _collation;
271 stdx::optional<bsoncxx::document::view_or_value> _resume_after;
272 stdx::optional<bsoncxx::document::view_or_value> _start_after;
273 stdx::optional<std::chrono::milliseconds> _max_await_time;
274 // _start_at_operation_time is not wrapped in a stdx::optional because of a longstanding bug in
275 // the MNMLSTC polyfill that has been fixed on master, but not in the latest release:
276 // https://github.com/mnmlstc/core/pull/23
277 bsoncxx::types::b_timestamp _start_at_operation_time = {};
278 bool _start_at_operation_time_set = false;
279};
280} // namespace options
281MONGOCXX_INLINE_NAMESPACE_END
282} // namespace mongocxx
283
284#include <mongocxx/config/postlude.hpp>
A read-only BSON document that owns its underlying buffer.
Definition value.hpp:34
Class representing a view-or-value variant type for strings.
Definition view_or_value.hpp:36
Class representing a view-or-value variant type.
Definition view_or_value.hpp:30
Class representing MongoDB change stream options.
Definition change_stream.hpp:39
change_stream & comment(bsoncxx::types::bson_value::view_or_value comment)
Sets the current value of the comment option.
const stdx::optional< std::chrono::milliseconds > & max_await_time() const
The current max_time setting.
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...
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
change_stream & start_at_operation_time(bsoncxx::types::b_timestamp timestamp)
Specifies the logical starting point for the new change stream.
const stdx::optional< bsoncxx::document::view_or_value > & start_after() const
Retrieves the current startAfter token for this change stream.
const stdx::optional< bsoncxx::document::view_or_value > & resume_after() const
Retrieves the current resumeToken for this change stream.
change_stream & start_after(bsoncxx::document::view_or_value token)
Specifies the logical starting point of the new change stream.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
const bsoncxx::stdx::optional< bsoncxx::string::view_or_value > & full_document() const
Gets the current fullDocument option.
change_stream & full_document(bsoncxx::string::view_or_value full_doc)
Sets the fullDocument option for the $changeStream.
change_stream & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
change_stream & full_document_before_change(bsoncxx::string::view_or_value full_doc_before_change)
Sets the fullDocumentBeforeChange option for the $changeStream.
change_stream & resume_after(bsoncxx::document::view_or_value resume_after)
Specifies the logical starting point for the new change stream.
const stdx::optional< std::int32_t > & batch_size() const
The current batch size setting.
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.
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24
A BSON replication timestamp value.
Definition types.hpp:577