mongocxx::options::modify_collection Class Reference

Class representing the optional arguments to a MongoDB collMod command. More...

#include <modify_collection.hpp>

Public Member Functions
modify_collection &	index (bsoncxx::document::view_or_value index_spec, std::chrono::seconds seconds)
	The index flag changes the expiration time of a TTL collection. More...
modify_collection &	no_padding (bool no_padding)
	When true, disables the power of 2 sizes allocation for the collection. More...
modify_collection &	validation_criteria (class validation_criteria validation)
	Specify validation criteria for this collection. More...
bsoncxx::document::value	to_document () const
	Return a bson document representing a collMod command with the given options set on this object. More...

Detailed Description

Class representing the optional arguments to a MongoDB collMod command.

Deprecated:

This class is deprecated. See the database::modify_collection() method comment for more information.

Member Function Documentation

index()

modify_collection& mongocxx::options::modify_collection::index	(	bsoncxx::document::view_or_value	index_spec,
		std::chrono::seconds	seconds
	)

The index flag changes the expiration time of a TTL collection.

Parameters

index_spec	the spec for an existing index in the collection
seconds	number of seconds to subtract from the current time

See also

https://docs.mongodb.com/master/tutorial/expire-data/

no_padding()

modify_collection& mongocxx::options::modify_collection::no_padding

(

bool

no_padding

)

When true, disables the power of 2 sizes allocation for the collection.

See also

: https://docs.mongodb.com/master/reference/method/db.createCollection/

Parameters

no_padding

When true, disables power of 2 sizing for this collection.

Returns

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

to_document()

bsoncxx::document::value mongocxx::options::modify_collection::to_document

(

)

const

Return a bson document representing a collMod command with the given options set on this object.

Returns

Options, as a document.

validation_criteria()

modify_collection& mongocxx::options::modify_collection::validation_criteria

(

class validation_criteria

validation

)

Specify validation criteria for this collection.

Parameters

validation

Validation criteria for this collection.

See also

https://docs.mongodb.com/master/core/document-validation/

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/modify_collection.hpp