Skip to content

Commit fec7e5e

Browse files
authored
(DOCSP-24293): Add note about writeCopy only supporting PBS (#2074)
1 parent e6bbf92 commit fec7e5e

File tree

4 files changed

+13
-0
lines changed

4 files changed

+13
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. note:: Partition-Based Sync Only
2+
3+
This method only supports Partition-Based Sync. If your app uses
4+
Flexible Sync, you must manually iterate through the objects in one
5+
realm and copy them into the other realm.

source/sdk/node/examples/open-and-close-a-realm.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ To copy data from an existing realm to a new realm with different
131131
configuration options, pass the new configuration the
132132
:js-sdk:`Realm.writeCopyTo() <Realm.html#writeCopyTo>` method.
133133

134+
.. include:: /includes/note-writecopy-pbs-only.rst
135+
134136
In the new realm's configuration, you *must* specify the ``path``.
135137

136138
If you write the copied realm to a realm file that already exists, the data is written object by object.

source/sdk/react-native/examples/open-and-close-a-realm.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ To copy data from an existing realm to a new realm with different
131131
configuration options, pass the new configuration the
132132
:js-sdk:`Realm.writeCopyTo() <Realm.html#writeCopyTo>` method.
133133

134+
.. include:: /includes/note-writecopy-pbs-only.rst
135+
134136
In the new realm's configuration, you *must* specify the ``path``.
135137

136138
If you write the copied realm to a realm file that already exists, the data is written object by object.

source/sdk/swift/sync/configure-and-open-a-synced-realm.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ configuration.
193193
After you copy the realm for the new Sync user's configuration, you can
194194
open the copy as a synced realm for that user.
195195

196+
.. include:: /includes/note-writecopy-pbs-only.rst
197+
196198
.. literalinclude:: /examples/generated/code/start/ConvertSyncLocalRealms.snippet.convert-sync-to-sync.swift
197199
:language: swift
198200

@@ -215,6 +217,8 @@ synced realm. Any changes you make to the synced realm will reflect
215217
in the synced realm file, and they will also propogate to other devices and
216218
the Atlas App Services backend.
217219

220+
.. include:: /includes/note-writecopy-pbs-only.rst
221+
218222
.. literalinclude:: /examples/generated/code/start/ConvertSyncLocalRealms.snippet.convert-local-to-sync.swift
219223
:language: swift
220224

0 commit comments

Comments
 (0)