Public Member Functions
change_stream &	full_document (bsoncxx::string::view_or_value full_doc)
	Sets the fullDocument stage for the $changeStream. More...

const bsoncxx::stdx::optional< bsoncxx::string::view_or_value > &	full_document () const
	Gets the current fullDocument setting. 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 &	resume_after (bsoncxx::document::view_or_value resume_after)
	Specifies the logical starting point for the new change stream. More...

const stdx::optional< bsoncxx::document::view_or_value > &	resume_after () const
	Retrieves the current resumeToken for this change stream. More...

change_stream &	start_after (bsoncxx::document::view_or_value token)
	Specifies the logical starting point of the new change stream. More...

const stdx::optional< bsoncxx::document::view_or_value > &	start_after () const
	Retrieves the current startAfter token for this change stream. More...

change_stream &	collation (bsoncxx::document::view_or_value collation)
	Sets the collation for this operation. More...

const stdx::optional< bsoncxx::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::types::b_timestamp timestamp)
	Specifies the logical starting point for the new change stream. More...

Member Function Documentation

◆ batch_size() [1/2]

const stdx::optional<std::int32_t>& mongocxx::options::change_stream::batch_size ( ) const

The current batch size setting.

Returns: The current batch size.

◆ batch_size() [2/2]

change_stream& mongocxx::options::change_stream::batch_size ( std::int32_t batch_size )

Sets the number of documents to return per batch.

Parameters

batch_size The size of the batches to request.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ collation() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::change_stream::collation ( ) const

Retrieves the current collation for this operation.

Returns: The current collation.

◆ collation() [2/2]

change_stream& mongocxx::options::change_stream::collation ( bsoncxx::document::view_or_value collation )

Sets the collation for this operation.

Parameters

collation The new collation.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ full_document() [1/2]

const bsoncxx::stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::change_stream::full_document ( ) const

Gets the current fullDocument setting.

Returns: The current fullDocument setting.

◆ full_document() [2/2]

change_stream& mongocxx::options::change_stream::full_document ( bsoncxx::string::view_or_value full_doc )

Sets the fullDocument stage for the $changeStream.

The allowed values are: ‘default’, ‘updateLookup’. If none set, defaults to ‘default’.

When set to ‘updateLookup’, the change stream 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. This will be stored in the "fullDocument" field of the notification.

Parameters

full_doc The fullDocument setting to use on this stream.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ max_await_time() [1/2]

const stdx::optional<std::chrono::milliseconds>& mongocxx::options::change_stream::max_await_time ( ) const

The current max_time setting.

Returns: The current max time (in milliseconds).

◆ max_await_time() [2/2]

change_stream& mongocxx::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.

Parameters

max_time The max amount of time (in milliseconds) for the server to wait on new documents.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ resume_after() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::change_stream::resume_after ( ) const

Retrieves the current resumeToken for this change stream.

Returns: The current resumeToken.

◆ resume_after() [2/2]

change_stream& mongocxx::options::change_stream::resume_after ( bsoncxx::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.

Parameters

resume_after The resumeToken to use when starting the change stream.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ start_after() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::change_stream::start_after ( ) const

Retrieves the current startAfter token for this change stream.

Returns: The current startAfter token.

◆ start_after() [2/2]

change_stream& mongocxx::options::change_stream::start_after ( bsoncxx::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.

Parameters

token The token representing the logical starting point of the change stream.

Returns: A reference to the object on which this function is being called.

◆ start_at_operation_time()

change_stream& mongocxx::options::change_stream::start_at_operation_time ( bsoncxx::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.

Parameters

timestamp The starting operation time.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

The documentation for this class was generated from the following file:

src/mongocxx/options/change_stream.hpp

Public Member Functions

Member Function Documentation

◆ batch_size() [1/2]

◆ batch_size() [2/2]

◆ collation() [1/2]

◆ collation() [2/2]

◆ full_document() [1/2]

◆ full_document() [2/2]

◆ max_await_time() [1/2]

◆ max_await_time() [2/2]

◆ resume_after() [1/2]

◆ resume_after() [2/2]

◆ start_after() [1/2]

◆ start_after() [2/2]

◆ start_at_operation_time()