@@ -57,10 +57,11 @@ Settings
57
57
| The date format pattern the connector should use to convert the
58
58
source data contained in the field specified by the
59
59
``timeseries.timefield`` setting.
60
- The connector passes the date format pattern to the Java
60
+ |
61
+ | The connector passes the date format pattern to the Java
61
62
`DateTimeFormatter.ofPattern(pattern, locale) <https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ofPattern-java.lang.String-java.util.Locale->`__
62
63
method to perform date and time conversions on the time field.
63
-
64
+ |
64
65
| If the date value from the source data only contains date information,
65
66
the connector sets the time information to the start of the specified
66
67
day. If the date value does not contain the timezone offset, the
@@ -80,7 +81,7 @@ Settings
80
81
| **Description:**
81
82
| Whether to convert the data in the field into the BSON ``Date``
82
83
format.
83
-
84
+ |
84
85
| When set to ``true``, the connector uses the milliseconds
85
86
after epoch and discards fractional parts if the value is
86
87
a number. If the value is a string, the connector uses the
@@ -101,8 +102,9 @@ Settings
101
102
|
102
103
| **Description:**
103
104
| Which ``DateTimeFormatter`` locale language tag to use with the date
104
- format pattern (e.g. ``"en-US"``). For more information on
105
- locales, see the Java SE documentation of `Locale <https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html>`__.
105
+ format pattern (e.g. ``"en-US"``).
106
+ |
107
+ | To learn more about locales, see the Java SE documentation of `Locale <https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html>`__.
106
108
|
107
109
| **Default**: ``ROOT``
108
110
| **Accepted Values**: A valid ``Locale`` language tag format
@@ -113,10 +115,10 @@ Settings
113
115
| **Description:**
114
116
| Which top-level field to read from the source data to describe
115
117
a group of related time series documents.
116
-
117
- :gold:`IMPORTANT:` This field must not be the ``_id`` field nor the field you specified
118
- in the ``timeseries.timefield`` setting.
119
-
118
+ |
119
+ | :gold:`IMPORTANT:` This field must not be the ``_id`` field nor the field you specified
120
+ in the ``timeseries.timefield`` setting.
121
+ |
120
122
| **Default**: ``""``
121
123
| **Accepted Values**: An empty string or the name of a field
122
124
that contains any BSON type except ``BsonArray``.
@@ -128,8 +130,9 @@ Settings
128
130
| The number of seconds MongoDB should wait before automatically
129
131
removing the time series collection data. The connector disables
130
132
timed expiry when the setting value is less than ``1``.
131
- For more information on this collection setting, see the MongoDB
132
- Server Manual page on :manual:`Automatic Removal for Time Series Collections </core/timeseries/timeseries-automatic-removal/>`.
133
+ |
134
+ | To learn more, see :manual:`Set up Automatic Removal for Time Series Collections </core/timeseries/timeseries-automatic-removal/>`
135
+ in the MongoDB manual.
133
136
|
134
137
| **Default**: ``0``
135
138
| **Accepted Values**: An integer
@@ -140,9 +143,10 @@ Settings
140
143
|
141
144
| **Description:**
142
145
| The expected interval between subsequent measurements of your
143
- source data. For more information on this setting, see the
144
- MongoDB server manual page on :manual:`Granularity for Time
145
- Series Data </core/timeseries/timeseries-granularity/>`.
146
+ source data.
147
+ |
148
+ | To learn more, see :manual:`Set Granularity for Time Series Data
149
+ </core/timeseries/timeseries-granularity/>` in the MongoDB manual.
146
150
|
147
151
| *Optional*
148
152
| **Default**: ``""``
0 commit comments