Class TimeSeriesOptions

Options used to configure timeseries options.

Added in MongoDB 5.0 https://www.mongodb.com/docs/manual/core/timeseries-collections/

Hierarchy

TimeSeriesOptions

Index

Constructors

constructor

Methods

Constructors

constructor

new TimeSeriesOptions(): TimeSeriesOptions
new TimeSeriesOptions(obj: TimeSeriesOptions | {}): TimeSeriesOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:920
Returns TimeSeriesOptions
- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:922
Parameters
- obj: TimeSeriesOptions | {}
Returns TimeSeriesOptions

Methods

getGranularity

getGranularity(): TimeSeriesGranularity

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:928
Returns TimeSeriesGranularity

getMetaField

getMetaField(): string

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:936
Returns string

getTimeField

getTimeField(): string

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:944
Returns string

setGranularity

setGranularity(granularity: TimeSeriesGranularity): TimeSeriesOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:932
Parameters
- granularity: TimeSeriesGranularity
Returns TimeSeriesOptions

setMetaField

setMetaField(metaField: string): TimeSeriesOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:940
Parameters
- metaField: string
Returns TimeSeriesOptions

setTimeField

setTimeField(timeField: string): TimeSeriesOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:948
Parameters
- timeField: string
Returns TimeSeriesOptions

toJson

toJson(): {}

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:951
Returns {}
- [key: string]: any

Generated using TypeDoc