MongoDB C++ Driver mongocxx-3.10.1
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 <mongocxx/client-fwd.hpp>
20#include <mongocxx/collection-fwd.hpp>
21#include <mongocxx/database-fwd.hpp>
22#include <mongocxx/options/change_stream-fwd.hpp>
23
24#include <bsoncxx/document/view_or_value.hpp>
25#include <bsoncxx/string/view_or_value.hpp>
26#include <bsoncxx/types.hpp>
27#include <bsoncxx/types/bson_value/view_or_value.hpp>
28#include <mongocxx/stdx.hpp>
29
30#include <mongocxx/config/prelude.hpp>
31
32namespace mongocxx {
33namespace v_noabi {
34namespace options {
35
40 public:
42
71
78 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>& full_document()
79 const;
80
101 bsoncxx::v_noabi::string::view_or_value full_doc_before_change);
102
109 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>&
111
123
130 const stdx::optional<std::int32_t>& batch_size() const;
131
143
150 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>& comment() const;
151
168
175 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& resume_after() const;
176
195
202 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& start_after() const;
203
215
222 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
223
235 change_stream& max_await_time(std::chrono::milliseconds max_time);
236
243 const stdx::optional<std::chrono::milliseconds>& max_await_time() const;
244
260
261 private:
262 friend ::mongocxx::v_noabi::client;
263 friend ::mongocxx::v_noabi::collection;
264 friend ::mongocxx::v_noabi::database;
265
266 bsoncxx::v_noabi::document::value as_bson() const;
267 stdx::optional<bsoncxx::v_noabi::string::view_or_value> _full_document;
268 stdx::optional<bsoncxx::v_noabi::string::view_or_value> _full_document_before_change;
269 stdx::optional<std::int32_t> _batch_size;
270 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
271 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
272 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _resume_after;
273 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _start_after;
274 stdx::optional<std::chrono::milliseconds> _max_await_time;
275 // _start_at_operation_time is not wrapped in a stdx::optional because of a longstanding bug in
276 // the MNMLSTC polyfill that has been fixed on master, but not in the latest release:
277 // https://github.com/mnmlstc/core/pull/23
278 bsoncxx::v_noabi::types::b_timestamp _start_at_operation_time = {};
279 bool _start_at_operation_time_set = false;
280};
281
282} // namespace options
283} // namespace v_noabi
284} // namespace mongocxx
285
286#include <mongocxx/config/postlude.hpp>
A read-only BSON document that owns its underlying buffer.
Definition value.hpp:38
Class representing a view-or-value variant type for strings.
Definition view_or_value.hpp:38
Class representing MongoDB change stream options.
Definition change_stream.hpp:39
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
change_stream & resume_after(bsoncxx::v_noabi::document::view_or_value resume_after)
Specifies the logical starting point for the new change stream.
change_stream & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
const stdx::optional< std::chrono::milliseconds > & max_await_time() const
The current max_time setting.
change_stream & start_after(bsoncxx::v_noabi::document::view_or_value token)
Specifies the logical starting point of the new change stream.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
change_stream & start_at_operation_time(bsoncxx::v_noabi::types::b_timestamp timestamp)
Specifies the logical starting point for the new change stream.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & start_after() const
Retrieves the current startAfter token for this change stream.
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 & full_document(bsoncxx::v_noabi::string::view_or_value full_doc)
Sets the fullDocument option for the $changeStream.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & resume_after() const
Retrieves the current resumeToken for this change stream.
change_stream & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
change_stream & full_document_before_change(bsoncxx::v_noabi::string::view_or_value full_doc_before_change)
Sets the fullDocumentBeforeChange option for the $changeStream.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > & full_document_before_change() const
Gets the current fullDocumentBeforeChange option.
change_stream & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Sets the current value of the comment option.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > & full_document() const
Gets the current fullDocument option.
const stdx::optional< std::int32_t > & batch_size() const
The current batch size setting.
The top-level namespace for mongocxx library entities.
Definition bulk_write-fwd.hpp:19
A BSON replication timestamp value.
Definition types.hpp:566