DOCSP-15476 secondary indexes on time series metrics (#253)

* DOCSP-15476 secondary indexes on time series metrics

* DOCSP-15476 secondary indexes on time series metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

* DOCSP-15476-secondary-indexes-on-time-series-metrics

Co-authored-by: jason-price-mongodb <[email protected]>

Author: jason-price-mongodb

source/core/timeseries-collections.txt

@@ -130,6 +130,8 @@ Other options allowed with the ``timeseries`` option are:
 
    :method:`db.createCollection()` and :dbcommand:`create`.
 
+.. _timeseries-collections-insert:
+
 Insert Measurements into a Time Series Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

source/core/timeseries/timeseries-limitations.txt

@@ -1,8 +1,8 @@
 .. _manual-timeseries-collection-limitations:
 
-==================================
-Time Series Collection Limitations
-==================================
+============================================
+Time Series Collection Notes and Limitations
+============================================
 
 .. default-domain:: mongodb
 
@@ -59,14 +59,79 @@ To remove all documents from a collection, use the
 
 .. _timeseries-limitations-secondary-indexes:
 
-Secondary Indexes
-~~~~~~~~~~~~~~~~~
+Time Series Secondary Indexes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can add :term:`secondary indexes <secondary index>` on the fields
 specified as the ``timeField`` and the ``metaField``. If the field value
 for the ``metaField`` field is a document, you can also create secondary
 indexes on fields inside that document.
 
+The following sections describe:
+
+- Additional secondary indexes you can add.
+
+- Secondary index limitations.
+
+Time Series Secondary Indexes in MongoDB 5.3
+````````````````````````````````````````````
+
+Starting in MongoDB 5.3:
+
+- You can add the following secondary indexes to a :ref:`time series
+  collection <manual-timeseries-collection>`:
+  
+  - :doc:`Partial
+    </core/index-partial>`, :doc:`2d </core/2d>`, and :doc:`2dsphere
+    </core/2dsphere>` indexes to a metadata field. 
+
+  - :doc:`2dsphere </core/2dsphere>` and :doc:`partial
+    </core/index-partial>` indexes to a measurement field.
+
+  - :doc:`Compound index </core/index-compound>` on time, metadata, or
+    measurement fields.
+
+- If you need to downgrade the Feature Compatibility Version (FCV), 
+  you must first drop any indexes that are incompatible with the
+  downgraded FCV. See :dbcommand:`setFeatureCompatibilityVersion`.
+
+- You can use the :query:`$or`, :query:`$in`, and :query:`$geoWithin`
+  operators with :doc:`partial indexes </core/index-partial>` on a time
+  series collection.
+
+- You can use the :pipeline:`$geoNear` pipeline operator with a:
+
+  .. include:: /includes/geoNear-time-series.rst
+
+For example, the following ``sensorData`` collection contains
+temperature readings:
+
+.. code-block:: javascript
+
+   db.sensorData.insertMany( [
+      {
+         "metadata": { "sensorId": 5578, "type": "temperature" },
+         "timestamp": ISODate("2022-01-15T00:00:00.000Z"),
+         "temperatureReading": 12
+      },
+      {
+         "metadata": { "sensorId": 5578, "type": "temperature" },
+         "timestamp": ISODate("2022-01-15T04:00:00.000Z"),
+         "temperatureReading": 11
+      }
+   ] )
+
+The following example creates an ascending secondary index on the
+``metadata.sensorId`` and ``temperatureReading`` fields in the
+``sensorData`` collection:
+
+.. code-block:: javascript
+
+   db.sensorData.createIndex( { "metadata.sensorId": 1, "temperatureReading": 1 } )
+
+Secondary Index Limitations
+```````````````````````````
+
 In MongoDB 5.1, the ``metaField`` doesn't support :doc:`text
 </core/index-text>` indexes.
 
@@ -79,9 +144,12 @@ types:
 
 Secondary indexes don't support the following index properties:
 
+- :doc:`2d </core/2d>` in MongoDB 5.2 and lower
+- :doc:`2dsphere </core/2dsphere>` in MongoDB 5.2 and lower
 - :doc:`TTL </core/index-ttl>`
 - :doc:`Unique </core/index-unique>`
-- :doc:`Partial </core/index-partial>`
+- :doc:`Partial </core/index-partial>` in MongoDB 5.2 and lower
+- :doc:`Multikey index </core/index-multikey>` on a measurement field
 
 ``reIndex``
 ~~~~~~~~~~~

source/includes/geoNear-time-series.rst

@@ -0,0 +1,5 @@
+- :doc:`2dsphere </core/2dsphere>` index on a :ref:`time series
+  collection <manual-timeseries-collection>`.
+
+- Query on any field in a time series collection, including
+  metadata fields. 

source/reference/operator/aggregation/geoNear.txt

@@ -201,13 +201,18 @@ When using :pipeline:`$geoNear`, consider that:
 
 - .. include:: /includes/extracts/views-unsupported-geoNear.rst
 
-- Starting in version 4.2, :pipeline:`$geoNear` no longer has a default
+- Starting in MongoDB 4.2, :pipeline:`$geoNear` no longer has a default
   limit of 100 documents.
 
 - Starting in MongoDB 5.1, the ``near`` parameter supports the 
   :ref:`let option <geoNear_let_example>` and
   :ref:`bound let option <geoNear_bounded_let_example>`.
 
+- Starting in MongoDB 5.3, you can use the :pipeline:`$geoNear` pipeline
+  operator with a:
+
+  .. include:: /includes/geoNear-time-series.rst
+
 Examples
 --------
 

source/release-notes/5.3-compatibility.txt

@@ -15,3 +15,12 @@ Compatibility Changes in MongoDB 5.3
 This page is a work in progress and will be updated with changes
 introduced in 5.3 that can affect compatibility with older versions of
 MongoDB.
+
+Time Series Collections
+-----------------------
+
+If there are :term:`secondary indexes <secondary index>` on :ref:`time
+series collections <manual-timeseries-collection>` and you need to
+downgrade the Feature Compatibility Version (FCV), you must first drop
+any secondary indexes that are incompatible with the downgraded FCV. See
+:ref:`timeseries-limitations-secondary-indexes`.

source/release-notes/5.3.txt

@@ -12,46 +12,23 @@ Release Notes for MongoDB 5.3
 
 .. include:: /includes/in-dev.rst
 
-.. _5.3-rel-notes-aggregation:
-
-Aggregation
------------
-
-.. _5.3-rel-notes-new-agg-operators:
-
-New Aggregation Operators
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-MongoDB 5.3 introduces the following aggregation operators:
-
-.. list-table::
-   :header-rows: 1
-   :widths: 20 80
-
-   * - Operator
-     - Description
-
-   * - <<TBD>>
-     - <<TBD>>
-
-.. _5.3-rel-notes-sharding:
-
-Sharding
---------
-
-<<TBD>>
-
 .. _5.3-rel-notes-general:
 
 General Improvements
 --------------------
 
-<<TBD>>
+Time Series Collection Improvements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting in MongoDB 5.3, you can:
+
+- Add additional :term:`secondary index <secondary index>` types to
+  :ref:`time series collections <manual-timeseries-collection>`. See
+  :ref:`timeseries-limitations-secondary-indexes`.
 
-Replica Sets
-------------
+- Use the :pipeline:`$geoNear` pipeline operator with a:
 
-<<TBD>>
+  .. include:: /includes/geoNear-time-series.rst
 
 Security
 --------