Struct CreateCollection

pub struct CreateCollection<'a> { /* private fields */ }

Creates a new collection. Construct with Database::create_collection.

Implementations

impl<'a> CreateCollection<'a>

pub fn session(self, value: impl Into<&'a mut ClientSession>) -> Self

Use the provided session when running the operation.

pub fn with_options( self, value: impl Into<Option<CreateCollectionOptions>>, ) -> Self

Set all options. Note that this will replace all previous values set.

pub fn capped(self, value: bool) -> Self

Whether the collection should be capped. If true, size must also be set.

pub fn size(self, value: u64) -> Self

The maximum size (in bytes) for a capped collection. This option is ignored if capped is not set to true.

pub fn max(self, value: u64) -> Self

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

pub fn storage_engine(self, value: Document) -> Self

The storage engine that the collection should use. The value should take the following form:

{ <storage-engine-name>: <options> }

pub fn validator(self, value: Document) -> Self

Specifies a validator to restrict the schema of documents which can exist in the collection. Expressions can be specified using any query operators except $near, $nearSphere, $text, and $where.

pub fn validation_level(self, value: ValidationLevel) -> Self

Specifies how strictly the database should apply the validation rules to existing documents during an update.

pub fn validation_action(self, value: ValidationAction) -> Self

Specifies whether the database should return an error or simply raise a warning if inserted documents do not pass the validation.

pub fn view_on(self, value: impl Into<String>) -> Self

The name of the source collection or view to base this view on. If specified, this will cause a view to be created rather than a collection.

pub fn pipeline(self, value: impl IntoIterator<Item = Document>) -> Self

An array that consists of the aggregation pipeline stages to run against view_on to determine the contents of the view.

pub fn collation(self, value: Collation) -> Self

The default collation for the collection or view.

pub fn write_concern(self, value: WriteConcern) -> Self

The write concern for the operation.

pub fn index_option_defaults(self, value: IndexOptionDefaults) -> Self

The default configuration for indexes created on this collection, including the _id index.

pub fn timeseries(self, value: TimeseriesOptions) -> Self

An object containing options for creating time series collections. See the create command documentation for supported options, and the Time Series Collections documentation for more information.

This feature is only available on server versions 5.0 and above.

pub fn expire_after_seconds(self, value: Duration) -> Self

Used to automatically delete documents in time series collections. See the create command documentation for more information.

pub fn change_stream_pre_and_post_images( self, value: ChangeStreamPreAndPostImages, ) -> Self

Options for supporting change stream pre- and post-images.

pub fn clustered_index(self, value: ClusteredIndex) -> Self

Options for clustered collections. This option is only available on server versions 5.3+.

pub fn comment(self, value: impl Into<Bson>) -> Self

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

This option is only available on server versions 4.4+.

pub fn encrypted_fields(self, value: Document) -> Self

Available on crate feature in-use-encryption only.

Map of encrypted fields for the created collection.

impl<'a> CreateCollection<'a>

pub fn run(self) -> Result<()>

Available on crate feature sync only.

Synchronously execute this action.

Trait Implementations

impl<'a> Action for CreateCollection<'a>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a> IntoFuture for CreateCollection<'a>

type Output = Result<(), Error>

The output that the future will produce on completion.

type IntoFuture = CreateCollectionFuture<'a>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.