File tree Expand file tree Collapse file tree 2 files changed +14
-14
lines changed Expand file tree Collapse file tree 2 files changed +14
-14
lines changed Original file line number Diff line number Diff line change 1
- Optional. The name of the field which contains metadata in each
2
- time series document. The metadata in the specified field should
3
- be data that is used to label a unique series of documents. The
4
- metadata should rarely, if ever, change.
1
+ Optional. The name of the field which contains metadata in
2
+ each time series document. The metadata in the specified field
3
+ should be data that is used to label a unique series of
4
+ documents. The metadata should rarely, if ever, change
5
+ The name of the specified field may not be ``_id `` or the same
6
+ as the ``timeseries.timeField ``. The field can be of any type
7
+ except array.
5
8
6
- The name of the specified field may not be ``_id `` or the same as
7
- the ``timeseries.timeField ``. The field can be of any type.
9
+ Although the ``metaField `` field is optional, using metadata can improve
10
+ query optimization. For example, MongoDB automatically
11
+ :ref: `creates a compound index <timeseries-add-secondary-index >`
12
+ on the ``metaField `` and ``timeField `` fields for new collections.
13
+ If you do not provide a value for this field, the data is bucketed solely
14
+ based on time.
Original file line number Diff line number Diff line change @@ -106,14 +106,7 @@ The ``create`` command has the following fields:
106
106
107
107
* - ``timeseries.metaField``
108
108
- string
109
- - Optional. The name of the field which contains metadata in
110
- each time series document. The metadata in the specified field
111
- should be data that is used to label a unique series of
112
- documents. The metadata should rarely, if ever, change.
113
-
114
- The name of the specified field may not be ``_id`` or the same
115
- as the ``timeseries.timeField``. The field can be of any type
116
- except array.
109
+ - .. include:: /includes/time-series/fact-meta-field-description.rst
117
110
118
111
* - ``timeseries.granularity``
119
112
You can’t perform that action at this time.
0 commit comments