Skip to content

Commit 0079bce

Browse files
(DOCSP-23054): File copy based initial sync improvements (#1193)
* (DOCSP-23054): File copy based initial sync improvements * reordering * wording * clarify local db limitation * members > member
1 parent e37365a commit 0079bce

File tree

2 files changed

+34
-28
lines changed

2 files changed

+34
-28
lines changed

source/core/replica-set-sync.txt

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,12 @@ To perform an initial sync, see
7171
File Copy Based Initial Sync
7272
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7373

74-
File copy based initial sync runs the initial sync process by copying
75-
and moving files on the file system.
74+
*Available in MongoDB Enterprise only.*
7675

77-
File copy based initial sync can be faster than
76+
File copy based initial sync runs the initial sync process by copying
77+
and moving files on the file system. This sync method can be faster than
7878
:ref:`logical initial sync <replica-set-initial-sync-logical>`.
7979

80-
It is only available on Enterprise Server.
81-
8280
.. important:: File copy based initial sync may cause inaccurate counts
8381

8482
After file copy based initial sync completes, if you run the
@@ -90,29 +88,36 @@ It is only available on Enterprise Server.
9088

9189
To learn more, see :ref:`count-method-behavior-query-predicate`.
9290

93-
Limitations
94-
```````````
91+
Enable File Copy Based Initial Sync
92+
```````````````````````````````````
9593

96-
- File copy based initial sync replaces the ``local`` database on the
97-
node being *synced to* with the ``local`` database from the node
98-
being *synced from*.
94+
To enable file copy based initial sync, set the
95+
:parameter:`initialSyncMethod` parameter to ``fileCopyBased`` on the
96+
destination member for the initial sync. This parameter can only be set
97+
at startup.
9998

100-
- You can only run an initial sync from one given node at a time.
99+
Behavior
100+
````````
101101

102-
- You cannot run a backup on the node that is being *synced to* during
103-
the initial sync.
102+
File copy based initial sync replaces the ``local`` database on the
103+
member being *synced to* with the ``local`` database from the member
104+
being *synced from*.
104105

105-
- You cannot run a backup on the node that is being *synced from* during
106-
the initial sync.
106+
Limitations
107+
```````````
107108

108-
- You cannot use file copy based initial sync with encrypted storage
109-
engine to re-key the data.
109+
- During a file copy based initial sync:
110110

111-
.. warning::
111+
- You cannot run a backup on the member that is being *synced to* or
112+
the member that is being *synced from*.
112113

113-
You cannot write to the ``local`` database during a file copy based
114-
sync.
114+
- You cannot write to the ``local`` database on the member that is being
115+
*synced to*.
115116

117+
- You can only run an initial sync from one given member at a time.
118+
119+
- You cannot use file copy based initial sync with encrypted storage
120+
engine to re-key the data.
116121

117122
.. _init-sync-retry:
118123

source/reference/parameters.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2471,24 +2471,26 @@ If you attempt to update ``disableSplitHorizonIPCheck`` at runtime,
24712471

24722472
*Type*: String
24732473

2474-
*Default*: ``logical``
2474+
*Default*: ``logical``
2475+
2476+
Available only in MongoDB Enterprise.
24752477

24762478
Method used for :ref:`initial sync <replica-set-initial-sync>`.
24772479

24782480
Set to ``logical`` to use :ref:`logical initial sync
24792481
<replica-set-initial-sync-logical>`. Set to ``fileCopyBased`` to
24802482
use :ref:`file copy based initial sync
2481-
<replica-set-initial-sync-file-copy-based>`.
2483+
<replica-set-initial-sync-file-copy-based>`.
2484+
2485+
This parameter only affects the sync method for the member on which
2486+
it is specified. Setting this parameter on a single replica set
2487+
member does not affect the sync method of any other replica set
2488+
members.
24822489

24832490
You can only set this parameter on startup, using either the
24842491
:setting:`setParameter` configuration file setting or the
24852492
:option:`--setParameter <mongod --setParameter>` command line option.
24862493

2487-
.. note::
2488-
2489-
Available only in MongoDB Enterprise.
2490-
2491-
24922494
.. parameter:: maxNumSyncSourceChangesPerHour
24932495

24942496
.. versionadded:: 5.0
@@ -4718,4 +4720,3 @@ Slot-Based Execution Parameters
47184720
.. code-block:: javascript
47194721

47204722
db.adminCommand( { setParameter: 1, planCacheSize: "80MB" } )
4721-

0 commit comments

Comments
 (0)