Class TimeSeriesOptions

Defines the time series options to use when creating a time series collection. See https://www.mongodb.com/docs/manual/reference/command/create/ for supported options and https://www.mongodb.com/docs/manual/core/timeseries-collections/ for more information on time series collections.

public class TimeSeriesOptions

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Initializes a new instance of the TimeSeriesOptions class.

public TimeSeriesOptions(string timeField, Optional<string> metaField = default, Optional<TimeSeriesGranularity?> granularity = default)

timeField string: The name of the top-level field to be used for time.
metaField Optional<string>: The name of the top-level field describing the series upon which related data will be grouped.
granularity Optional<TimeSeriesGranularity?>: The TimeSeriesGranularity for the time series.

The coarse granularity of time series data.

public TimeSeriesGranularity? Granularity { get; }

The name of the field which contains metadata in each time series document.

public string MetaField { get; }

The name of the field which contains the date and time in each time series document.

public string TimeField { get; }

The BSON representation of the time series options.

public BsonDocument ToBsonDocument()