Skip to content

Commit 1ea5a6d

Browse files
author
Dave Cuthbert
authored
DOCSP-22998 create limitations page (#32)
* DOCSP-22998 create limitations page * DOCSP-22998 create limitations page * DOCSP-22998 create limitations page * Review feedback * Review feedback * Staging fixes * Staging fixes * Review feedback * Review feedback
1 parent af105e6 commit 1ea5a6d

File tree

3 files changed

+109
-2
lines changed

3 files changed

+109
-2
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

22
{+c2c-product-name+} supports synchronization between clusters. Both
33
the source and destination cluster must use MongoDB 6.0 or later. The
4-
:dbcommand:`Feature Compatibility Version (FCV)
4+
:dbcommand:`Feature Compatibility Version
55
<setFeatureCompatibilityVersion>` must also be set to 6.0 or later.

source/reference.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Reference
77
.. toctree::
88
:titlesonly:
99

10-
/reference/mongosync
1110
/reference/api
11+
/reference/mongosync
1212
/reference/mongosync-states
13+
/reference/limitations
14+

source/reference/limitations.txt

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
.. _c2c-limitations:
2+
3+
===========
4+
Limitations
5+
===========
6+
7+
.. include:: /includes/preview-warning
8+
9+
{+c2c-full-product-name+} is under active development. This preview
10+
release has several limitations. Review the list for changes after the
11+
{+c2c-product-name+} General Availability release.
12+
13+
.. warning::
14+
15+
``mongosync`` does not check for compliance with the following
16+
limitations. Please ensure that your application is not affected by
17+
these limitations. Running ``mongosync`` in the presence of one of
18+
these limitations could lead to undefined behavior on the destination
19+
cluster.
20+
21+
General Limitations
22+
-------------------
23+
24+
- The minimum supported server version is MongoDB 6.0.
25+
- The source and destination clusters must have the same release
26+
version.
27+
- The minimum supported :dbcommand:`Feature Compatibility Version
28+
<setFeatureCompatibilityVersion>` is 6.0.
29+
- The source and destination clusters must have the same Feature
30+
Compatibility Version.
31+
- The destination cluster must be empty.
32+
- DDL operations are currently not supported during syncing.
33+
- ``mongosync`` does not validate that the clusters or the environment
34+
are properly configured.
35+
- The primary shard cannot be :dbcommand:`reassigned <movePrimary>`
36+
while syncing.
37+
- Other clients must not write to the destination cluster while
38+
``mongosync`` is running.
39+
- If write blocking is disabled, the client must :ref:`prevent writes
40+
<c2c-api-start>` to the source cluster before starting the commit
41+
process.
42+
- Synchronizing a subset of the source data, "Filtered
43+
Synchronization", is not supported.
44+
- Network compression is not supported.
45+
- :dbcommand:`applyOps` operations from the source cluster are not
46+
supported.
47+
48+
MongoDB Community Edition
49+
-------------------------
50+
51+
{+c2c-product-name+} supports a limited number of operations with
52+
MongoDB Community Edition. Please contact a sales representative to
53+
discuss your requirements.
54+
55+
Unsupported Collection Types
56+
----------------------------
57+
58+
- Collections with collation are currently not supported.
59+
- Capped collections are currently not supported.
60+
- Time-series collections are not supported.
61+
62+
63+
Sharded Clusters
64+
----------------
65+
66+
- The :ref:`shard topologies <sharding-introduction>` must be the same
67+
in the source and target clusters. The following configurations are
68+
not supported.
69+
70+
- Replica set to sharded cluster.
71+
- Sharded cluster to replica set.
72+
- Unequal numbers of source and destination shards.
73+
74+
- There is no replication for zone configuration. ``mongosync``
75+
replicates data, it does not inherit zones.
76+
- Shards cannot be added or removed while synchronizing.
77+
- Only indexes which exist on all shards are synchronized.
78+
- The shard key cannot be :ref:`refined <shard-key-refine>` while
79+
synchronizing.
80+
- The shard key cannot be modified using :dbcommand:`reshardCollection`
81+
during resharding.
82+
83+
84+
Reversing
85+
---------
86+
87+
If the old source has :ref:`unique indexes <index-type-unique>` which
88+
are partially distributed across shards, reversing may cause failures.
89+
Ensure that unique indexes exist on all shards before reversing.
90+
91+
92+
Multiple Clusters
93+
-----------------
94+
95+
- Syncing multiple source clusters to one destination cluster is not
96+
supported.
97+
- Syncing one source cluster to many destination clusters is not
98+
supported.
99+
100+
101+
.. contents:: On this page
102+
:local:
103+
:backlinks: none
104+
:depth: 1
105+
:class: singlecol

0 commit comments

Comments
 (0)