Skip to content

Commit 7c88f2b

Browse files
author
Dave Cuthbert
authored
DOCSP-25986 improve style of limitations page (#2047)
* DOCSP-25986 timeseries limitations restyling * DOCSP-25986 timeseries limitations restyling * Review Feedback * Staging fixes * Merge feedback
1 parent 62daa11 commit 7c88f2b

File tree

2 files changed

+63
-60
lines changed

2 files changed

+63
-60
lines changed

source/core/timeseries/timeseries-limitations.txt

Lines changed: 58 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,33 @@ Time Series Collection Limitations
1616
:description: Time Series, IOT
1717
:keywords: Time Series, IOT
1818

19-
This page describes limitations of time series collections.
19+
This page describes limitations on using :ref:`time series collections
20+
<manual-timeseries-collection>`.
2021

2122
Unsupported Features
2223
~~~~~~~~~~~~~~~~~~~~~
2324

24-
The following features are not supported for
25-
:ref:`time series collections <manual-timeseries-collection>`.
25+
The following features are not supported for time series collections:
2626

2727
* :atlas:`Atlas Search </atlas-search>`
28-
* :doc:`Change streams </changeStreams>`
28+
* :ref:`Change streams <changeStreams>`
2929
* :ref:`{+csfle+} <manual-csfle-feature>`
3030
* :realm:`Database Triggers </triggers/database-triggers>`
3131
* :realm:`GraphQL API </graphql>`
32-
* :realm:`Atlas Device Sync </sync>` (Atlas Device Sync is supported if
33-
the time series collections are asymmetrically synchronized. For
34-
details, see :realm:`Enable Atlas Device Sync
35-
</sync/configure/enable-sync>`.)
32+
* :ref:`Schema validation rules <schema-validation-overview>`
3633
* :dbcommand:`reIndex`
3734
* :dbcommand:`renameCollection`
38-
* :doc:`Schema validation rules </core/schema-validation>`
35+
36+
:realm:`Atlas Device Sync </sync>` is only supported if the time series
37+
collections are asymmetrically synchronized. For details, see
38+
:realm:`Enable Atlas Device Sync </sync/configure/enable-sync>`.
3939

4040
Aggregation $out and $merge
4141
~~~~~~~~~~~~~~~~~~~~~~~~~~~
4242

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.
43+
You cannot use the :pipeline:`$out` or :pipeline:`$merge` aggregation
44+
pipeline stages to add data from another collection to a time series
45+
collection.
4646

4747
.. _timeseries-limitations-updates-deletes:
4848

@@ -54,18 +54,19 @@ operations.
5454

5555
Delete commands must meet the following requirements:
5656

57-
- The query may only match on ``metaField`` field values.
58-
- The delete command may not limit the number of documents to be
59-
deleted. You must use a delete command with ``justOne: false`` or the
57+
- You can only match on :ref:`metaField <time-series-fields>` field
58+
values.
59+
- Your delete command must not limit the number of documents to be
60+
deleted. Set ``justOne: false`` or use the
6061
:method:`~db.collection.deleteMany()` method.
6162

6263
Update commands must meet the following requirements:
6364

6465
.. include:: /includes/time-series/fact-update-limitations.rst
6566

66-
In MongoDB 5.0, :ref:`Time series collections
67-
<manual-timeseries-collection>` only support insert operations and read
68-
queries. Updates and manual delete operations result in an error.
67+
In MongoDB 5.0, time series collections only support insert operations
68+
and read queries. Updates and manual delete operations result in an
69+
error.
6970

7071
To automatically delete old data, :ref:`set up automatic removal (TTL)
7172
<set-up-automatic-removal>`.
@@ -78,32 +79,32 @@ To remove all documents from a collection, use the
7879
Time Series Secondary Indexes
7980
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8081

82+
There is improved support for secondary indexes in MongoDB 6.0.
83+
8184
Time Series Secondary Indexes with MongoDB 6.0 and Later
8285
````````````````````````````````````````````````````````
8386

8487
Starting in MongoDB 6.0, you can add a :term:`secondary index <secondary
8588
index>` to any field.
8689

87-
These index types aren't supported:
88-
89-
- :doc:`Text </core/index-text>`
90-
- :doc:`2d </core/2d>`
90+
These index types are not supported:
9191

92-
These index properties aren't supported:
92+
- :ref:`Text indexes <index-feature-text>`
93+
- :ref:`2d indexes <2d-index>`
94+
- :ref:`Unique indexes <index-type-unique>`
9395

94-
- :doc:`TTL </core/index-ttl>`. For TTL deletion, use
95-
:ref:`expireAfterSeconds <db.createCollection.expireAfterSeconds>`.
96-
- :doc:`Unique </core/index-unique>`
96+
The :ref:`TTL <index-feature-ttl>` index property is not supported. For
97+
TTL deletion, use :ref:`expireAfterSeconds
98+
<db.createCollection.expireAfterSeconds>`.
9799

98-
The :doc:`multikey index </core/index-multikey>` type is allowed on the
99-
``metaField`` only.
100+
You can only use the :ref:`multikey index <index-type-multikey>` type on
101+
the ``metaField``.
100102

101-
These index properties are partially supported:
103+
These index properties are partially supported. You can create:
102104

103-
- :doc:`Partial indexes </core/index-partial>` are allowed on all fields
104-
except the ``metaField`` and ``timeField``.
105-
- :doc:`Sparse indexes </core/index-sparse>` are allowed on the
106-
``metaField`` only.
105+
- :ref:`partial indexes <index-type-partial>` on every field except
106+
``metaField`` and ``timeField``.
107+
- :ref:`sparse indexes <index-type-sparse>` on the ``metaField``.
107108

108109
For improvements to time series secondary indexes available starting in
109110
MongoDB 6.0, see :ref:`timeseries-add-secondary-index-mongodb-6.0`.
@@ -115,10 +116,10 @@ Time Series Secondary Indexes with MongoDB 5.0 and Earlier
115116

116117
In MongoDB 5.0 and earlier:
117118

118-
- Secondary indexes can only be defined on the ``metaField`` or the
119-
``timeField``.
119+
- The ``metaField`` can have secondary indexes.
120+
- The ``timeField`` can have secondary indexes.
120121
- If the ``metaField`` is a document, you can add secondary indexes on
121-
fields inside that document.
122+
fields inside the document.
122123

123124
.. seealso::
124125

@@ -127,18 +128,18 @@ In MongoDB 5.0 and earlier:
127128
Capped Collections
128129
~~~~~~~~~~~~~~~~~~
129130

130-
A time series collection can't be created as a :ref:`capped collection
131+
You cannot create a time series collection as a :ref:`capped collection
131132
<manual-capped-collection>`.
132133

133134
Modification of Collection Type
134135
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135136

136-
A collection's type can only be set when creating the collection:
137+
You can only set the collection type when you create a collection:
137138

138-
- An existing collection can't be converted into a :ref:`time series
139-
collection <manual-capped-collection>`.
140-
- A :ref:`time series collection <manual-capped-collection>` can't be
141-
converted into a different collection type.
139+
- An existing collection cannot be converted into a time series
140+
collection.
141+
- A time series collection cannot be converted into a different
142+
collection type.
142143

143144
To move data from an existing collection to a time series collection,
144145
:ref:`migrate data into a time series collection
@@ -148,27 +149,29 @@ Modification of ``timeField`` and ``metaField``
148149
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149150

150151
You can only set a collection's ``timeField`` and ``metaField``
151-
parameters when creating the collection. After creation these parameters
152-
can't be modified.
152+
parameters when you create the collection. You cannot modify these
153+
parameters later.
153154

154155
.. _timeseries-limitations-granularity:
155156

156157
Modification of ``granularity``
157158
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
158159

159-
Once the ``granularity`` is set it can only be increased by one level at
160-
a time. From ``"seconds"`` to ``"minutes"`` or from ``"minutes"`` to
161-
``"hours"``. Other changes are not allowed. If you need to change the
162-
``granularity`` from ``"seconds"`` to ``"hours"``, first increase the
163-
``granularity`` to ``"minutes"`` and then to ``"hours"``.
160+
After you set the ``granularity``, you can only increase it one level at
161+
a time. The ``granularity`` can change from ``"seconds"`` to
162+
``"minutes"`` or from ``"minutes"`` to ``"hours"``. Other changes are
163+
not allowed.
164+
165+
To change the ``granularity`` from ``"seconds"`` to ``"hours"``, first
166+
increase the ``granularity`` to ``"minutes"`` and then to ``"hours"``.
164167

165168
.. _time-series-limitations-sharding:
166169

167170
Sharding
168171
~~~~~~~~
169172

170-
Starting in MongoDB 5.1 (and 5.0.6), sharded time series collections are
171-
supported.
173+
Starting in MongoDB 5.1 (and 5.0.6), you can create sharded time series
174+
collections.
172175

173176
In versions earlier than MongoDB 5.0.6, you cannot shard time series
174177
collections.
@@ -191,14 +194,13 @@ Shard Key Fields
191194
Resharding
192195
``````````
193196

194-
You can't reshard sharded time series collections.
197+
You cannot reshard sharded time series collections.
195198

196199
Transactions
197200
~~~~~~~~~~~~
198201

199-
You can't write to :ref:`time series collections
200-
<manual-timeseries-collection>` in :doc:`transactions
201-
</core/transactions>`.
202+
You cannot write to time series collections in :ref:`transactions
203+
<transactions>`.
202204

203205
.. note::
204206

@@ -213,3 +215,4 @@ Views
213215

214216
- You cannot create a view from a time series bucket collection
215217
namespace (namely, a collection prefixed with ``system.buckets``).
218+
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
- The query only matches on ``metaField`` field values.
2-
- The update command only modifies the ``metaField`` field value.
3-
- The update document can only contain :ref:`update operator
1+
- You can only match on the ``metaField`` field value.
2+
- You can only modify the ``metaField`` field value.
3+
- Your update document can only contain :ref:`update operator
44
<update-operators>` expressions.
5-
- The update command must not limit the number of documents to be
5+
- Your update command must not limit the number of documents to be
66
updated. Set ``multi: true`` or use the
77
:method:`~db.collection.updateMany()` method.
8-
- The update command must not set :ref:`upsert: true <update-upsert>`.
8+
- Your update command must not set :ref:`upsert: true <update-upsert>`.

0 commit comments

Comments
 (0)