MongoDB C++ Driver
mongocxx-3.10.2
|
Class representing MongoDB change stream options. More...
#include <change_stream.hpp>
Public Member Functions | |
change_stream & | full_document (bsoncxx::v_noabi::string::view_or_value full_doc) |
Sets the fullDocument option for the $changeStream. More... | |
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > & | full_document () const |
Gets the current fullDocument option. More... | |
change_stream & | full_document_before_change (bsoncxx::v_noabi::string::view_or_value full_doc_before_change) |
Sets the fullDocumentBeforeChange option for the $changeStream. More... | |
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > & | full_document_before_change () const |
Gets the current fullDocumentBeforeChange option. More... | |
change_stream & | batch_size (std::int32_t batch_size) |
Sets the number of documents to return per batch. More... | |
const stdx::optional< std::int32_t > & | batch_size () const |
The current batch size setting. More... | |
change_stream & | comment (bsoncxx::v_noabi::types::bson_value::view_or_value comment) |
Sets the current value of the comment option. More... | |
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & | comment () const |
Gets the current value of the comment option. More... | |
change_stream & | resume_after (bsoncxx::v_noabi::document::view_or_value resume_after) |
Specifies the logical starting point for the new change stream. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | resume_after () const |
Retrieves the current resumeToken for this change stream. More... | |
change_stream & | start_after (bsoncxx::v_noabi::document::view_or_value token) |
Specifies the logical starting point of the new change stream. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | start_after () const |
Retrieves the current startAfter token for this change stream. More... | |
change_stream & | collation (bsoncxx::v_noabi::document::view_or_value collation) |
Sets the collation for this operation. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | collation () const |
Retrieves the current collation for this operation. More... | |
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 stream query. More... | |
const stdx::optional< std::chrono::milliseconds > & | max_await_time () const |
The current max_time setting. More... | |
change_stream & | start_at_operation_time (bsoncxx::v_noabi::types::b_timestamp timestamp) |
Specifies the logical starting point for the new change stream. More... | |
Class representing MongoDB change stream options.
const stdx::optional<std::int32_t>& mongocxx::v_noabi::options::change_stream::batch_size | ( | ) | const |
The current batch size setting.
change_stream& mongocxx::v_noabi::options::change_stream::batch_size | ( | std::int32_t | batch_size | ) |
Sets the number of documents to return per batch.
batch_size | The size of the batches to request. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::change_stream::collation | ( | ) | const |
Retrieves the current collation for this operation.
change_stream& mongocxx::v_noabi::options::change_stream::collation | ( | bsoncxx::v_noabi::document::view_or_value | collation | ) |
Sets the collation for this operation.
collation | The new collation. |
const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>& mongocxx::v_noabi::options::change_stream::comment | ( | ) | const |
Gets the current value of the comment option.
change_stream& mongocxx::v_noabi::options::change_stream::comment | ( | bsoncxx::v_noabi::types::bson_value::view_or_value | comment | ) |
Sets the current value of the comment option.
comment | The new comment option. |
const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>& mongocxx::v_noabi::options::change_stream::full_document | ( | ) | const |
Gets the current fullDocument option.
change_stream& mongocxx::v_noabi::options::change_stream::full_document | ( | bsoncxx::v_noabi::string::view_or_value | full_doc | ) |
Sets the fullDocument option for the $changeStream.
Allowed values: 'default', 'updateLookup', 'whenAvailable', 'required'.
The default is to not send a value, which is equivalent to 'default'. By default, the change notification for partial updates will include a delta describing the changes to the document.
When set to 'updateLookup', the change notification for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from some time after the change occurred.
When set to 'whenAvailable', configures the change stream to return the post-image of the modified document for replace and update change events if the post-image for this event is available.
When set to 'required', the same behavior as 'whenAvailable' except that an error is raised if the post-image is not available.
full_doc | The fullDocument option to use on this stream. |
const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>& mongocxx::v_noabi::options::change_stream::full_document_before_change | ( | ) | const |
Gets the current fullDocumentBeforeChange option.
change_stream& mongocxx::v_noabi::options::change_stream::full_document_before_change | ( | bsoncxx::v_noabi::string::view_or_value | full_doc_before_change | ) |
Sets the fullDocumentBeforeChange option for the $changeStream.
The allowed values are: 'whenAvailable', 'required', 'off'. If none set, defaults to 'off'.
When set to 'whenAvailable', configures the change stream to return the pre-image of the modified document for replace, update, and delete change events if it is available.
When set to 'required', the same behavior as 'whenAvailable' except that an error is raised if the pre-image is not available.
full_doc_before_change | The fullDocumentBeforeChange option to use on this stream. |
const stdx::optional<std::chrono::milliseconds>& mongocxx::v_noabi::options::change_stream::max_await_time | ( | ) | const |
The current max_time setting.
change_stream& mongocxx::v_noabi::options::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 stream query.
max_time | The max amount of time (in milliseconds) for the server to wait on new documents. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::change_stream::resume_after | ( | ) | const |
Retrieves the current resumeToken for this change stream.
change_stream& mongocxx::v_noabi::options::change_stream::resume_after | ( | bsoncxx::v_noabi::document::view_or_value | resume_after | ) |
Specifies the logical starting point for the new change stream.
The value returned by calling change_stream::get_resume_token can be used here.
start_after, resume_after, and start_at_operation_time are mutually exclusive options. Setting more than one of these will result in a server error.
resume_after | The resumeToken to use when starting the change stream. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::change_stream::start_after | ( | ) | const |
Retrieves the current startAfter token for this change stream.
change_stream& mongocxx::v_noabi::options::change_stream::start_after | ( | bsoncxx::v_noabi::document::view_or_value | token | ) |
Specifies the logical starting point of the new change stream.
The new stream will return the first notification after the given token.
The value returned by calling change_stream::get_resume_token can be used here.
Unlike resumeAfter, this can resume notifications after an "invalidate" event.
start_after, resume_after, and start_at_operation_time are mutually exclusive options. Setting more than one of these will result in a server error.
token | The token representing the logical starting point of the change stream. |
change_stream& mongocxx::v_noabi::options::change_stream::start_at_operation_time | ( | bsoncxx::v_noabi::types::b_timestamp | timestamp | ) |
Specifies the logical starting point for the new change stream.
Changes are returned at or after the specified operation time.
start_after, resume_after, and start_at_operation_time are mutually exclusive options. Setting more than one of these will result in a server error.
timestamp | The starting operation time. |