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

#include <create_collection.hpp>

Public Member Functions
create_collection_deprecated &	capped (bool capped)
	To create a capped collection, specify true. More...

const stdx::optional< bool > &	capped () const
	Gets the current capped setting. More...

create_collection_deprecated &	collation (bsoncxx::document::view_or_value collation)
	Sets the default collation for this collection. More...

const stdx::optional< bsoncxx::document::view_or_value > &	collation () const
	Gets the default collation for this collection. More...

create_collection_deprecated &	max (std::int64_t max_documents)
	The maximum number of documents allowed in the capped collection. More...

const stdx::optional< std::int64_t > &	max () const
	Gets the current setting for the maximum number of documents allowed in the capped collection. More...

create_collection_deprecated &	no_padding (bool no_padding)
	When true, disables the power of 2 sizes allocation for the collection. More...

const stdx::optional< bool > &	no_padding () const
	Gets the current value of the "no padding" option for the collection. More...

create_collection_deprecated &	size (std::int64_t max_size)
	A maximum size, in bytes, for a capped collection. More...

const stdx::optional< std::int64_t > &	size () const
	Gets the current size setting, for a capped collection. More...

create_collection_deprecated &	storage_engine (bsoncxx::document::view_or_value storage_engine_opts)
	Specify configuration to the storage on a per-collection basis. More...

const stdx::optional< bsoncxx::document::view_or_value > &	storage_engine () const
	Gets the current storage engine configuration for this collection. More...

create_collection_deprecated &	validation_criteria (class validation_criteria validation)
	Specify validation criteria for this collection. More...

const stdx::optional< class validation_criteria > &	validation_criteria () const
	Gets the current validation criteria for this collection. More...

bsoncxx::document::value	to_document () const
	Return a bson document representing the options set on this object. More...

	operator bsoncxx::document::value () const

Detailed Description

Class representing the optional arguments to a MongoDB createCollection command.

This class is deprecated, as are the database class methods that use this class. Please use the new database::create_collection methods that take options as a BSON document.

Member Function Documentation

◆ capped() [1/2]

const stdx::optional<bool>& mongocxx::options::create_collection_deprecated::capped ( ) const

Gets the current capped setting.

Returns: Whether or not this collection will be capped.

See also: https://docs.mongodb.com/manual/reference/glossary/#term-capped-collection

◆ capped() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::capped ( bool capped )

To create a capped collection, specify true.

Note: If you specify true, you must also set a maximum size using the size() method.

Parameters

capped Whether or not this collection will be capped.

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

See also: https://docs.mongodb.com/manual/reference/glossary/#term-capped-collection

◆ collation() [1/2]

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

Gets the default collation for this collection.

Returns: The default collation for the collection.

See also: https://docs.mongodb.com/manual/reference/collation/

◆ collation() [2/2]

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

Sets the default collation for this collection.

Parameters

collation The default collation for the collection.

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

See also: https://docs.mongodb.com/manual/reference/collation/

◆ max() [1/2]

const stdx::optional<std::int64_t>& mongocxx::options::create_collection_deprecated::max ( ) const

Gets the current setting for the maximum number of documents allowed in the capped collection.

Returns: Maximum number of documents allowed in the collection (if capped).

◆ max() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::max ( std::int64_t max_documents )

The maximum number of documents allowed in the capped collection.

Note: The size limit takes precedence over this limit. If a capped collection reaches the size limit before it reaches the maximum number of documents, MongoDB removes old documents.

Parameters

max_documents Maximum number of documents allowed in the collection (if capped).

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

◆ no_padding() [1/2]

const stdx::optional<bool>& mongocxx::options::create_collection_deprecated::no_padding ( ) const

Gets the current value of the "no padding" option for the collection.

See also: https://docs.mongodb.com/manual/reference/command/create/

Returns: When true, power of 2 sizing is disabled for this collection.

◆ no_padding() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::no_padding ( bool no_padding )

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

See also: https://docs.mongodb.com/manual/reference/command/create/

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.

◆ operator bsoncxx::document::value()

mongocxx::options::create_collection_deprecated::operator bsoncxx::document::value ( ) const

Deprecated:: This method is deprecated.

To determine which options are set on this object, use the provided accessors instead.

◆ size() [1/2]

const stdx::optional<std::int64_t>& mongocxx::options::create_collection_deprecated::size ( ) const

Gets the current size setting, for a capped collection.

Returns: Maximum size, in bytes, of this collection (if capped).

◆ size() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::size ( std::int64_t max_size )

A maximum size, in bytes, for a capped collection.

Note: Once a capped collection reaches its maximum size, MongoDB removes older documents to make space for new documents.; Size is required for capped collections and ignored for other collections.

Parameters

max_size Maximum size, in bytes, of this collection (if capped).

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

◆ storage_engine() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::create_collection_deprecated::storage_engine ( ) const

Gets the current storage engine configuration for this collection.

Returns: Configuration options specific to the storage engine.

◆ storage_engine() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::storage_engine ( bsoncxx::document::view_or_value storage_engine_opts )

Specify configuration to the storage on a per-collection basis.

Note: This option is currently only available with the WiredTiger storage engine.

Parameters

storage_engine_opts Configuration options specific to the storage engine.

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::create_collection_deprecated::to_document ( ) const

Return a bson document representing the options set on this object.

Deprecated:: This method is deprecated. To determine which options are set on this object, use the provided accessors instead.

Returns: Options, as a document.

◆ validation_criteria() [1/2]

const stdx::optional<class validation_criteria>& mongocxx::options::create_collection_deprecated::validation_criteria ( ) const

Gets the current validation criteria for this collection.

Returns: Validation criteria for this collection.

See also: https://docs.mongodb.com/manual/core/document-validation/

◆ validation_criteria() [2/2]

create_collection_deprecated& mongocxx::options::create_collection_deprecated::validation_criteria ( class validation_criteria validation )

Specify validation criteria for this collection.

Parameters

validation Validation criteria for this collection.

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

See also: https://docs.mongodb.com/manual/core/document-validation/

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

src/mongocxx/options/create_collection.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ capped() [1/2]

◆ capped() [2/2]

◆ collation() [1/2]

◆ collation() [2/2]

◆ max() [1/2]

◆ max() [2/2]

◆ no_padding() [1/2]

◆ no_padding() [2/2]

◆ operator bsoncxx::document::value()

◆ size() [1/2]

◆ size() [2/2]

◆ storage_engine() [1/2]

◆ storage_engine() [2/2]

◆ to_document()

◆ validation_criteria() [1/2]

◆ validation_criteria() [2/2]