Time Series Collections

Overview

In this guide, you can learn about time series collections in MongoDB, and how to interact with them in the MongoDB Kotlin driver.

Time series collections efficiently store sequences of measurements over a period of time. Time series data consists of any data collected over time, metadata that describes the measurement, and the time of the measurement.

Create a Time Series Collection

To create a time series collection, pass the following parameters to the createCollection() method:

• The name of the new collection to create

• The TimeSeriesOptions for creating the collection in a CreateCollectionOptions object

val database = mongoClient.getDatabase("fall_weather")
val tsOptions = TimeSeriesOptions("temperature")
val collOptions = CreateCollectionOptions().timeSeriesOptions(tsOptions)
database.createCollection("september2021", collOptions)

To check if you successfully created the collection, send the "listCollections" command to the runCommand() method.

val commandResult = database.listCollections().toList()
    .find { it["name"] == "september2021" }
println(commandResult?.toJson(JsonWriterSettings.builder().indent(true).build()))

{
  "name": "september2021",
  "type": "timeseries",
  "options": {
    "timeseries": {
      "timeField": "temperature",
      "granularity": "seconds",
      "bucketMaxSpanSeconds": 3600
    }
  },
  "info": {
    "readOnly": false
  }
}

Query a Time Series Collection

To query in a time series collection, use the same conventions as you would for retrieving and aggregating data.

For more information, see our Aggregates Builders guide.