TimeSeriesOptions Class |
Defines the time series options to use when creating a time-series collection.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e
SyntaxThe TimeSeriesOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TimeSeriesOptions |
Initializes a new instance of the TimeSeriesOptions class.
|
Properties| Name | Description | |
|---|---|---|
 | Granularity |
The coarse granularity of time-series data.
|
| MetaField |
The name of the field which contains metadata in each time-series document.
|
| TimeField |
The name of the field which contains the date and time in each time-series document.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToBsonDocument |
The BSON representation of the time-series options.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also