mongocxx::options::create_collection Class Reference

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

#include <create_collection.hpp>

Public Member Functions
create_collection &	capped (bool capped)
	To create a capped collection, specify true.
create_collection &	auto_index_id (bool auto_index_id)
	Specify false to disable the automatic creation of an index on the _id field.
create_collection &	size (int max_size)
	A maximum size, in bytes, for a capped collection.
create_collection &	max (int max_documents)
	The maximum number of documents allowed in the capped collection.
create_collection &	storage_engine (bsoncxx::document::view_or_value storage_engine_opts)
	Specify configuration to the storage on a per-collection basis.
create_collection &	no_padding (bool no_padding)
	When true, disables the power of 2 sizes allocation for the collection.
create_collection &	validation_criteria (class validation_criteria validation)
	Specify validation criteria for this collection.
bsoncxx::document::value	to_document () const
	Return a bson document representing the options set on this object.

Detailed Description

Class representing the optional arguments to a MongoDB createCollection command.

Member Function Documentation

auto_index_id()

create_collection & mongocxx::options::create_collection::auto_index_id

(

bool

auto_index_id

)

Specify false to disable the automatic creation of an index on the _id field.

Note

For replica sets, all collections must have autoIndexId set to true.

Parameters

auto_index_id

Whether or not this collection will automatically generate an index on _id.

capped()

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

See also

https://docs.mongodb.org/manual/reference/glossary/#term-capped-collection

max()

create_collection & mongocxx::options::create_collection::max

(

int

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)

no_padding()

create_collection & mongocxx::options::create_collection::no_padding

(

bool

no_padding

)

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

See also

: https://docs.mongodb.org/manual/reference/method/db.createCollection/

Parameters

no_padding

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

size()

create_collection & mongocxx::options::create_collection::size

(

int

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)

storage_engine()

create_collection & mongocxx::options::create_collection::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_options

Configuration options specific to the storage engine.

to_document()

bsoncxx::document::value mongocxx::options::create_collection::to_document

(

)

const

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

Returns

Options, as a document.

validation_criteria()

create_collection & mongocxx::options::create_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.org/manual/core/document-validation/

---

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

• src/mongocxx/options/create_collection.hpp