Click or drag to resize

TimeSeriesOptions Class

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.
Inheritance Hierarchy
SystemObject
  MongoDB.DriverTimeSeriesOptions

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
Copy
public class TimeSeriesOptions

The TimeSeriesOptions type exposes the following members.

Constructors
  NameDescription
Public methodTimeSeriesOptions
Initializes a new instance of the TimeSeriesOptions class.
Top
Properties
  NameDescription
Public propertyGranularity
The coarse granularity of time series data.
Public propertyMetaField
The name of the field which contains metadata in each time series document.
Public propertyTimeField
The name of the field which contains the date and time in each time series document.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToBsonDocument
The BSON representation of the time series options.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also