RUST-666 Add options for timeseries collection creation

src/bson_util/mod.rs

@@ -82,7 +82,6 @@ pub(crate) fn serialize_duration_as_int_millis<S: Serializer>(
     }
 }
 
-#[cfg(test)]
 pub(crate) fn serialize_duration_option_as_int_secs<S: Serializer>(
     val: &Option<Duration>,
     serializer: S,

src/db/options.rs

@@ -1,3 +1,5 @@
+use std::time::Duration;
+
 use serde::{Deserialize, Serialize};
 use serde_with::skip_serializing_none;
 use typed_builder::TypedBuilder;
@@ -83,6 +85,18 @@ pub struct CreateCollectionOptions {
 
     /// The default configuration for indexes created on this collection, including the _id index.
     pub index_option_defaults: Option<IndexOptionDefaults>,
+
+    /// Specifies options for creating a timeseries collection.  This feature is only available on
+    /// server versions 5.0 and above.
+    pub timeseries: Option<TimeseriesOptions>,
+
+    /// Duration indicating after how long old time-series data should be deleted.
+    #[serde(
+        default,
+        deserialize_with = "bson_util::deserialize_duration_from_u64_seconds",
+        serialize_with = "bson_util::serialize_duration_option_as_int_secs"
+    )]
+    pub expire_after_seconds: Option<Duration>,
 }
 
 /// Specifies how strictly the database should apply validation rules to existing documents during
@@ -123,6 +137,39 @@ pub struct IndexOptionDefaults {
     pub storage_engine: Document,
 }
 
+/// Specifies options for creating a timeseries collection.
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+#[non_exhaustive]
+pub struct TimeseriesOptions {
+    /// Name of the top-level field to be used for time. Inserted documents must have this field,
+    /// and the field must be of the BSON UTC datetime type.
+    pub time_field: String,
+
+    /// Name of the top-level field describing the series. This field is used to group related data
+    /// and may be of any BSON type, except for array. This name may not be the same as the
+    /// timeField or _id.
+    pub meta_field: Option<String>,
+
+    /// The units you'd use to describe the expected interval between subsequent measurements for a
+    /// time-series.  Defaults to `TimeseriesGranularity::Seconds` if unset.
+    pub granularity: Option<TimeseriesGranularity>,
+}
+
+/// The units you'd use to describe the expected interval between subsequent measurements for a
+/// time-series.
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+#[non_exhaustive]
+pub enum TimeseriesGranularity {
+    /// The expected interval between subsequent measurements is in seconds.
+    Seconds,
+    /// The expected interval between subsequent measurements is in minutes.
+    Minutes,
+    /// The expected interval between subsequent measurements is in hours.
+    Hours,
+}
+
 /// Specifies the options to a [`Database::drop`](../struct.Database.html#method.drop) operation.
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]

src/test/spec/collection_management.rs

@@ -0,0 +1,10 @@
+use crate::test::{run_spec_test, LOCK};
+
+use super::run_unified_format_test;
+
+#[cfg_attr(feature = "tokio-runtime", tokio::test)]
+#[cfg_attr(feature = "async-std-runtime", async_std::test)]
+async fn run() {
+    let _guard = LOCK.run_exclusively().await;
+    run_spec_test(&["collection-management"], run_unified_format_test).await;
+}

src/test/spec/json/collection-management/README.rst

@@ -0,0 +1,7 @@
+===========================
+Collection Management Tests
+===========================
+
+This directory contains tests for collection management. They are implemented
+in the `Unified Test Format <../../unified-test-format/unified-test-format.rst>`__
+and require schema version 1.0.

src/test/spec/json/collection-management/timeseries-collection.json

@@ -0,0 +1,255 @@
+{
+  "description": "timeseries-collection",
+  "schemaVersion": "1.0",
+  "runOnRequirements": [
+    {
+      "minServerVersion": "5.0"
+    }
+  ],
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0",
+        "observeEvents": [
+          "commandStartedEvent"
+        ]
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "ts-tests"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "test"
+      }
+    }
+  ],
+  "initialData": [
+    {
+      "collectionName": "test",
+      "databaseName": "ts-tests",
+      "documents": []
+    }
+  ],
+  "tests": [
+    {
+      "description": "createCollection with all options",
+      "operations": [
+        {
+          "name": "dropCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test"
+          }
+        },
+        {
+          "name": "createCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test",
+            "expireAfterSeconds": 604800,
+            "timeseries": {
+              "timeField": "time",
+              "metaField": "meta",
+              "granularity": "minutes"
+            }
+          }
+        },
+        {
+          "name": "assertCollectionExists",
+          "object": "testRunner",
+          "arguments": {
+            "databaseName": "ts-tests",
+            "collectionName": "test"
+          }
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "drop": "test"
+                },
+                "databaseName": "ts-tests"
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "create": "test",
+                  "expireAfterSeconds": 604800,
+                  "timeseries": {
+                    "timeField": "time",
+                    "metaField": "meta",
+                    "granularity": "minutes"
+                  }
+                },
+                "databaseName": "ts-tests"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "description": "insertMany with duplicate ids",
+      "operations": [
+        {
+          "name": "dropCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test"
+          }
+        },
+        {
+          "name": "createCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test",
+            "expireAfterSeconds": 604800,
+            "timeseries": {
+              "timeField": "time",
+              "metaField": "meta",
+              "granularity": "minutes"
+            }
+          }
+        },
+        {
+          "name": "assertCollectionExists",
+          "object": "testRunner",
+          "arguments": {
+            "databaseName": "ts-tests",
+            "collectionName": "test"
+          }
+        },
+        {
+          "name": "insertMany",
+          "object": "collection0",
+          "arguments": {
+            "documents": [
+              {
+                "_id": 1,
+                "time": {
+                  "$date": {
+                    "$numberLong": "1552949630482"
+                  }
+                }
+              },
+              {
+                "_id": 1,
+                "time": {
+                  "$date": {
+                    "$numberLong": "1552949630483"
+                  }
+                }
+              }
+            ]
+          }
+        },
+        {
+          "name": "find",
+          "object": "collection0",
+          "arguments": {
+            "filter": {},
+            "sort": {
+              "time": 1
+            }
+          },
+          "expectResult": [
+            {
+              "_id": 1,
+              "time": {
+                "$date": {
+                  "$numberLong": "1552949630482"
+                }
+              }
+            },
+            {
+              "_id": 1,
+              "time": {
+                "$date": {
+                  "$numberLong": "1552949630483"
+                }
+              }
+            }
+          ]
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "drop": "test"
+                },
+                "databaseName": "ts-tests"
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "create": "test",
+                  "expireAfterSeconds": 604800,
+                  "timeseries": {
+                    "timeField": "time",
+                    "metaField": "meta",
+                    "granularity": "minutes"
+                  }
+                },
+                "databaseName": "ts-tests"
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "insert": "test",
+                  "documents": [
+                    {
+                      "_id": 1,
+                      "time": {
+                        "$date": {
+                          "$numberLong": "1552949630482"
+                        }
+                      }
+                    },
+                    {
+                      "_id": 1,
+                      "time": {
+                        "$date": {
+                          "$numberLong": "1552949630483"
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "find": "test",
+                  "filter": {},
+                  "sort": {
+                    "time": 1
+                  }
+                },
+                "databaseName": "ts-tests"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}