@@ -28,71 +28,67 @@ Procedure
28
28
29
29
.. step:: Enter the collection name.
30
30
31
- .. step:: Click the :guilabel:`Advanced Collection Options` dropdown.
32
-
33
- Check the :guilabel:`Time Series Collection` option.
31
+ .. step:: Check the :guilabel:`Time Series Collection` option.
34
32
35
33
.. step:: Specify a :guilabel:`timeField`.
36
34
37
35
Specify which field should be used as the ``timeField`` for the time-series
38
36
collection. This field must have a :manual:`BSON type date </reference/bson-types/>`.
39
37
40
- The following fields are optional:
38
+ .. step:: *Optional*. Specify a :guilabel:`metaField`.
41
39
42
- .. list-table::
43
- :header-rows: 1
44
- :widths: 20 20 60
40
+ Specify the name of the field that contains metadata in each time
41
+ series document. The metadata in the specified field should be
42
+ data that is used to label a unique series of documents.
45
43
46
- * - Field
47
- - Type
48
- - Description
44
+ .. step:: *Optional*. Select a :guilabel:`granularity` from the dropdown.
49
45
50
- * - ``metaField``
51
- - string
52
- - The name of the field that contains metadata in each time series
53
- document. The metadata in the specified field should be data that
54
- is used to label a unique series of documents.
46
+ Specify a coarser granularity so measurements over a longer time
47
+ span can be more efficiently stored and queried. The default value
48
+ is ``"seconds"``.
55
49
56
- * - ``granularity``
57
- - string
58
- - Specifies a coarser granularity so measurements over a
59
- longer time span can be more efficiently stored and queried.
50
+ If you set the ``granularity`` parameter, you can't set the
51
+ ``bucketMaxSpanSeconds`` and ``bucketRoundingSeconds`` parameters.
60
52
61
- The default value is ``"seconds"`` .
53
+ .. step:: *Optional*. Specify a numeric value for the following fields .
62
54
63
- If you set the ``granularity`` parameter, you can't set the
64
- ``bucketMaxSpanSeconds`` and ``bucketRoundingSeconds`` parameters.
55
+ .. list-table::
56
+ :widths: 20 10 70
57
+ :header-rows: 1
65
58
66
- * - ``expireAfterSeconds``
67
- - number
68
- - Enables the automatic deletion of documents that are older than
69
- the specified number of seconds.
59
+ * - Field
60
+ - Type
61
+ - Description
70
62
71
63
* - ``bucketMaxSpanSeconds``
72
64
- number
73
- - Specifies the maximum time span between measurements in a bucket.
65
+ - Specifies the maximum time span between measurements in a bucket.
74
66
75
- The value of ``bucketMaxSpanSeconds`` must be the same as
76
- ``bucketRoundingSeconds``. If you set the ``bucketMaxSpanSeconds``,
77
- parameter, you can't set the ``granularity`` parameter.
67
+ The value of ``bucketMaxSpanSeconds`` must be the same as
68
+ ``bucketRoundingSeconds``. If you set the ``bucketMaxSpanSeconds``,
69
+ parameter, you can't set the ``granularity`` parameter.
78
70
79
71
* - ``bucketRoundingSeconds``
80
72
- number
81
- - Specifies the time interval that determines the starting timestamp
82
- for a new bucket.
73
+ - Specifies the time interval that determines the starting timestamp
74
+ for a new bucket.
83
75
84
- The value of ``bucketRoundingSeconds`` must be the same as
85
- ``bucketMaxSpanSeconds``. If you set the ``bucketRoundingSeconds``,
86
- parameter, you can't set the ``granularity`` parameter.
76
+ The value of ``bucketRoundingSeconds`` must be the same as
77
+ ``bucketMaxSpanSeconds``. If you set the ``bucketRoundingSeconds``,
78
+ parameter, you can't set the ``granularity`` parameter.
87
79
88
- For more information on time series fields, see
89
- :manual:`Time Series Object Fields
90
- </core/timeseries/timeseries-procedures/#timeseries-object-fields>`.
80
+ * - ``expireAfterSeconds``
81
+ - number
82
+ - Enables the automatic deletion of documents that are older than
83
+ the specified number of seconds.
91
84
92
85
.. step:: Click :guilabel:`Create Collection` to create the collection.
93
86
94
87
Your collection will be marked by a :guilabel:`time series` badge.
95
88
89
+ For more information on time series fields, see :manual:`Time Series
90
+ Object Fields </core/timeseries/timeseries-procedures/#timeseries-object-fields>`.
91
+
96
92
Restrictions and Limitations
97
93
----------------------------
98
94
0 commit comments