Skip to content

Commit b076c1d

Browse files
authored
Documents the time series collection index creation. (#5682) (#5737)
* Add info about time series collection auto-index creation * replace with links * better linking * how about a link that is formatted correctly? * review suggestion
1 parent 2fa5573 commit b076c1d

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

source/core/timeseries-collections.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,13 @@ and query your data as you normally would.
111111
MongoDB treats time series collections as writable non-materialized
112112
:ref:`views <views-landing-page>` backed by an internal collection. When
113113
you insert data, the internal collection automatically organizes time
114-
series data into an optimized storage format.
114+
series data into an optimized storage format.
115115

116-
When you query time series collections, you operate on one document per
117-
measurement. Queries on time series collections take advantage of the
118-
optimized internal storage format and return results faster.
116+
Since MongoDB 6.3, when you create a new time series collection, MongodDB
117+
generates a :ref:`compound index <index-create-compound>` on the
118+
:ref:`metaField and timeField <time-series-fields>` fields. Queries on time
119+
series collections take advantage of this index, as well as the optimized
120+
storage format, to improve query performance.
119121

120122
.. tip::
121123

source/release-notes/6.3.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,13 @@ MongoDB 6.3 adds the following :ref:`time series parameters
210210
Starting in MongoDB 6.3, the :dbcommand:`compact` command works with
211211
:ref:`time series collections <manual-timeseries-landing>`.
212212

213+
Time Series Indexing
214+
--------------------
215+
216+
Starting in MongoDB 6.3, MongoDB automatically generates a compound
217+
index on the ``metaField`` and ``timeField`` fields when the collection is
218+
created.
219+
213220
Report an Issue
214221
---------------
215222

0 commit comments

Comments
 (0)