Struct mongodb::options::TimeseriesOptions

#[non_exhaustive]
pub struct TimeseriesOptions {
    pub time_field: String,
    pub meta_field: Option<String>,
    pub granularity: Option<TimeseriesGranularity>,
    pub bucket_max_span: Option<Duration>,
    pub bucket_rounding: Option<Duration>,
}

Specifies options for creating a timeseries collection.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time_field: String

Name of the top-level field to be used for time. Inserted documents must have this field, and the field must be of the BSON UTC datetime type.

meta_field: Option<String>

Name of the top-level field describing the series. This field is used to group related data and may be of any BSON type, except for array. This name may not be the same as the timeField or _id.

granularity: Option<TimeseriesGranularity>

The units you’d use to describe the expected interval between subsequent measurements for a time-series. Defaults to TimeseriesGranularity::Seconds if unset.

bucket_max_span: Option<Duration>

The maximum time between timestamps in the same bucket. This value must be between 1 and 31,536,000 seconds. If this value is set, the same value should be set for bucket_rounding and granularity should not be set.

This option is only available on MongoDB 6.3+.

bucket_rounding: Option<Duration>

The time interval that determines the starting timestamp for a new bucket. When a document requires a new bucket, MongoDB rounds down the document’s timestamp value by this interval to set the minimum time for the bucket. If this value is set, the same value should be set for bucket_max_span and granularity should not be set.

This option is only available on MongoDB 6.3+.

Implementations

impl TimeseriesOptions

pub fn builder() -> TimeseriesOptionsBuilder<((), (), (), (), ())>

Create a builder for building TimeseriesOptions. On the builder, call .time_field(...)(optional), .meta_field(...)(optional), .granularity(...)(optional), .bucket_max_span(...)(optional), .bucket_rounding(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TimeseriesOptions.

Trait Implementations

impl Clone for TimeseriesOptions

fn clone(&self) -> TimeseriesOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimeseriesOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeseriesOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TimeseriesOptions

fn eq(&self, other: &TimeseriesOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TimeseriesOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeseriesOptions