Skip to content

Commit e602cbc

Browse files
DOCSP-20266 Add Data API as a time series limitation (#822) (#866)
* DOCSP-20266: Update Time Series limitations with Data API info * DOCSP-20266: reverting commit * DOCSP-20266: Add Data API the the time series limitations page * DOCSP-20266 * DOCSP-20266:Fix link typo. * DOCSP-20266:Fix link typo. * DOCSP-20266: Incorporate review comments * DOCSP-20266: Upate with review feedback. * DOCSP-20266: Minor edit Co-authored-by: Sarah Olson <[email protected]> Co-authored-by: Sarah Olson <[email protected]> "continue cherry-pick"
1 parent cc42675 commit e602cbc

File tree

1 file changed

+34
-51
lines changed

1 file changed

+34
-51
lines changed

source/core/timeseries/timeseries-limitations.txt

Lines changed: 34 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,36 @@ Time Series Collection Limitations
1616
:description: Time Series, IOT
1717
:keywords: Time Series, IOT
1818

19+
Unsupported Features
20+
~~~~~~~~~~~~~~~~~~~~~
21+
22+
The following features are not supported for
23+
:ref:`time series collections <manual-timeseries-collection>`.
24+
25+
* :doc:`Client-side field level encryption </core/security-client-side-encryption>`
26+
* :dbcommand:`reIndex`
27+
* :doc:`Change streams </changeStreams>`
28+
* :realm:`Database Triggers </triggers/database-triggers>`
29+
* :realm:`GraphQL API </graphql>`
30+
* :atlas:`Atlas Search </atlas-search>`
31+
* :realm:`Realm Sync </sync>`
32+
* :atlas:`Data API </api/data-api>`
33+
* :doc:`Schema validation rules </core/schema-validation>`
34+
1935
Constraints
2036
~~~~~~~~~~~
2137

2238
The maximum size of a measurement document is 4 MB.
2339

40+
Aggregation $out and $merge
41+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
42+
43+
You can't use aggregation pipeline stages :pipeline:`$out` and :pipeline:`$merge`
44+
to output or merge into to :ref:`time series collections
45+
<manual-timeseries-collection>` from another collection.
46+
47+
.. _timeseries-limitations-updates-deletes:
48+
2449
Updates and Deletes
2550
~~~~~~~~~~~~~~~~~~~
2651

@@ -73,12 +98,6 @@ Secondary indexes don't support the following index properties:
7398
- :doc:`Unique </core/index-unique>`
7499
- :doc:`Partial </core/index-partial>`
75100

76-
``reIndex``
77-
~~~~~~~~~~~
78-
79-
The :dbcommand:`reIndex` command is not supported for :ref:`time series
80-
collections <manual-timeseries-collection>`.
81-
82101
Capped Collections
83102
~~~~~~~~~~~~~~~~~~
84103

@@ -117,18 +136,7 @@ a time. From ``"seconds"`` to ``"minutes"`` or from ``"minutes"`` to
117136
``granularity`` from ``"seconds"`` to ``"hours"``, first increase the
118137
``granularity`` to ``"minutes"`` and then to ``"hours"``.
119138

120-
Schema Validation
121-
~~~~~~~~~~~~~~~~~
122-
123-
You cannot specify :doc:`validation rules </core/schema-validation>` for
124-
:ref:`time series collections <manual-timeseries-collection>`.
125-
126-
Client-Side Field Level Encryption
127-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128-
129-
:doc:`Client-side field level encryption
130-
</core/security-client-side-encryption>` is not supported for
131-
:ref:`time series collections <manual-timeseries-collection>`.
139+
.. _time-series-limitations-sharding:
132140

133141
Sharding
134142
~~~~~~~~
@@ -150,12 +158,15 @@ Starting in 5.0.6, you can run :ref:`sharding administration commands
150158
In versions earlier than MongoDB 5.0.6, you cannot run sharding
151159
administration commands for sharded time series collections.
152160

153-
Aggregation $out and $merge
154-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
161+
Shard Zones
162+
```````````
163+
164+
.. include:: /includes/time-series/fact-shard-zone-limitations.rst
155165

156-
The aggregation pipeline stages :pipeline:`$out` and :pipeline:`$merge`
157-
can't output to :ref:`time series collections
158-
<manual-timeseries-collection>`.
166+
Shard Keys
167+
``````````
168+
169+
.. include:: /includes/time-series/fact-shard-key-limitations.rst
159170

160171
Transactions
161172
~~~~~~~~~~~~
@@ -168,33 +179,5 @@ You can't write to :ref:`time series collections
168179

169180
Reads from time series collections are supported in transactions.
170181

171-
Change Streams
172-
~~~~~~~~~~~~~~
173-
174-
:doc:`Change streams </changeStreams>` are not supported for
175-
:ref:`time series collections <manual-timeseries-collection>`.
176-
177-
Database Triggers
178-
~~~~~~~~~~~~~~~~~
179-
180-
:realm:`Database Triggers </triggers/database-triggers>` are not
181-
supported for :ref:`time series collections
182-
<manual-timeseries-collection>`.
183-
184-
GraphQL API
185-
~~~~~~~~~~~
186-
187-
:realm:`GraphQL API </graphql>` is not supported for :ref:`time series
188-
collections <manual-timeseries-collection>`.
189-
190-
Atlas Search
191-
~~~~~~~~~~~~
192-
193-
:atlas:`Atlas Search </atlas-search>` is not supported for :ref:`time
194-
series collections <manual-timeseries-collection>`.
195182

196-
Realm Sync
197-
~~~~~~~~~~
198183

199-
:realm:`Realm Sync </sync>` is not supported for :ref:`time series
200-
collections <manual-timeseries-collection>`.

0 commit comments

Comments
 (0)