From ccee05afe469996d8e1f9573a26ec787d6256ba0 Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Thu, 1 Aug 2024 14:32:48 -0400 Subject: [PATCH 01/11] added warning to flutter as test --- source/includes/warning-device-sync-query-size-limit.rst | 4 ++++ source/sdk/flutter/sync.txt | 2 ++ 2 files changed, 6 insertions(+) create mode 100644 source/includes/warning-device-sync-query-size-limit.rst diff --git a/source/includes/warning-device-sync-query-size-limit.rst b/source/includes/warning-device-sync-query-size-limit.rst new file mode 100644 index 0000000000..c25d58ad3e --- /dev/null +++ b/source/includes/warning-device-sync-query-size-limit.rst @@ -0,0 +1,4 @@ +.. warning:: Query Size Limit + + The **size limit** for queries from your client application when using Device Sync is + **256 kB**. Exceeding this limit in a query will result in a :ref:`LimitsExceeded Error`. \ No newline at end of file diff --git a/source/sdk/flutter/sync.txt b/source/sdk/flutter/sync.txt index 074ce39a40..bd532656f6 100644 --- a/source/sdk/flutter/sync.txt +++ b/source/sdk/flutter/sync.txt @@ -86,6 +86,8 @@ write the documents. If documents match the query, but the client does not have the permission to read or write them, they do not sync to the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + You can form Flexible Sync queries using a limited subset of :ref:`Realm Query Language `. To learn more about which fields you can query, refer to the :ref:`Queryable Fields documentation `. From 663397c497b1ea247f4d659ec965381c15cfffb6 Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Thu, 1 Aug 2024 15:14:16 -0400 Subject: [PATCH 02/11] fixed other SDK pages --- source/sdk/cpp/sync.txt | 4 +++- source/sdk/dotnet/sync.txt | 4 +++- source/sdk/java/sync.txt | 4 +++- source/sdk/kotlin/sync/add-sync-to-app.txt | 2 ++ source/sdk/node/sync.txt | 4 +++- source/sdk/react-native/sync-data.txt | 4 +++- source/sdk/swift/sync.txt | 4 +++- 7 files changed, 20 insertions(+), 6 deletions(-) diff --git a/source/sdk/cpp/sync.txt b/source/sdk/cpp/sync.txt index d63a0d3112..5a6456de00 100644 --- a/source/sdk/cpp/sync.txt +++ b/source/sdk/cpp/sync.txt @@ -54,7 +54,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you @@ -65,6 +65,8 @@ with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. For more information, refer to :ref:`cpp-manage-flexible-sync-subscriptions`. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + Group Updates for Improved Performance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/sdk/dotnet/sync.txt b/source/sdk/dotnet/sync.txt index 68b85f483b..d70b613c28 100644 --- a/source/sdk/dotnet/sync.txt +++ b/source/sdk/dotnet/sync.txt @@ -44,7 +44,7 @@ the client application. You can form queries using :ref:`Realm Query Language ` or LINQ. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You can have multiple subscriptions if you have many types of Realm objects. @@ -53,6 +53,8 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + .. tip:: Device Sync supports two Sync Modes: Flexible Sync, and the older diff --git a/source/sdk/java/sync.txt b/source/sdk/java/sync.txt index 625c552084..4792944adf 100644 --- a/source/sdk/java/sync.txt +++ b/source/sdk/java/sync.txt @@ -54,7 +54,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -63,6 +63,8 @@ To use Flexible Sync in your client application, open a synced realm with a flexible sync configuration. Then, manage subscriptions to determine which documents to sync. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + .. _java-sync-data: Sync Data diff --git a/source/sdk/kotlin/sync/add-sync-to-app.txt b/source/sdk/kotlin/sync/add-sync-to-app.txt index 32b9df23b1..12548f02b7 100644 --- a/source/sdk/kotlin/sync/add-sync-to-app.txt +++ b/source/sdk/kotlin/sync/add-sync-to-app.txt @@ -91,6 +91,8 @@ App Services only syncs objects that match the query. You can define multiple queries in your client app. You must define at least one query for each object type in your data model. +.. include:: /includes/warning-device-sync-query-size-limit.rst + App Services ensures that your client-side queries are consistent with your App Services schema through **queryable fields**. These are the fields from your data model that can be used in a subscription query. You diff --git a/source/sdk/node/sync.txt b/source/sdk/node/sync.txt index ddbccbfd36..f250df1f13 100644 --- a/source/sdk/node/sync.txt +++ b/source/sdk/node/sync.txt @@ -61,7 +61,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -70,6 +70,8 @@ To use Flexible Sync in your client application, open a synced realm with a flexible sync configuration. Then, manage subscriptions to determine which documents to sync. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + Group Updates for Improved Performance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/sdk/react-native/sync-data.txt b/source/sdk/react-native/sync-data.txt index 5a21d02b7b..ff868a6a70 100644 --- a/source/sdk/react-native/sync-data.txt +++ b/source/sdk/react-native/sync-data.txt @@ -51,7 +51,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -60,6 +60,8 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + .. seealso:: - Learn how to configure and open a realm using :ref:`Flexible Sync `. diff --git a/source/sdk/swift/sync.txt b/source/sdk/swift/sync.txt index f931d26d58..586dbd89bc 100644 --- a/source/sdk/swift/sync.txt +++ b/source/sdk/swift/sync.txt @@ -56,7 +56,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you @@ -66,6 +66,8 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst + .. tip:: Device Sync supports two Sync Modes: Flexible Sync, and the older From d32f026cd28f99ddd1ca84ffbff4bac13ae374ce Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Thu, 1 Aug 2024 15:46:45 -0400 Subject: [PATCH 03/11] fixed call out ordering --- source/sdk/cpp/sync.txt | 6 +++--- source/sdk/dotnet/sync.txt | 6 +++--- source/sdk/java/sync.txt | 6 +++--- source/sdk/node/sync.txt | 6 +++--- source/sdk/react-native/sync-data.txt | 6 +++--- source/sdk/swift/sync.txt | 6 +++--- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/sdk/cpp/sync.txt b/source/sdk/cpp/sync.txt index 5a6456de00..5924fbe970 100644 --- a/source/sdk/cpp/sync.txt +++ b/source/sdk/cpp/sync.txt @@ -45,6 +45,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -54,7 +56,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you @@ -65,8 +67,6 @@ with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. For more information, refer to :ref:`cpp-manage-flexible-sync-subscriptions`. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - Group Updates for Improved Performance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/sdk/dotnet/sync.txt b/source/sdk/dotnet/sync.txt index d70b613c28..70e5720197 100644 --- a/source/sdk/dotnet/sync.txt +++ b/source/sdk/dotnet/sync.txt @@ -35,6 +35,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -44,7 +46,7 @@ the client application. You can form queries using :ref:`Realm Query Language ` or LINQ. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You can have multiple subscriptions if you have many types of Realm objects. @@ -53,8 +55,6 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - .. tip:: Device Sync supports two Sync Modes: Flexible Sync, and the older diff --git a/source/sdk/java/sync.txt b/source/sdk/java/sync.txt index 4792944adf..8f725ba6ed 100644 --- a/source/sdk/java/sync.txt +++ b/source/sdk/java/sync.txt @@ -45,6 +45,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -54,7 +56,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -63,8 +65,6 @@ To use Flexible Sync in your client application, open a synced realm with a flexible sync configuration. Then, manage subscriptions to determine which documents to sync. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - .. _java-sync-data: Sync Data diff --git a/source/sdk/node/sync.txt b/source/sdk/node/sync.txt index f250df1f13..3f4a8ceb3b 100644 --- a/source/sdk/node/sync.txt +++ b/source/sdk/node/sync.txt @@ -52,6 +52,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -61,7 +63,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -70,8 +72,6 @@ To use Flexible Sync in your client application, open a synced realm with a flexible sync configuration. Then, manage subscriptions to determine which documents to sync. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - Group Updates for Improved Performance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/sdk/react-native/sync-data.txt b/source/sdk/react-native/sync-data.txt index ff868a6a70..8896e560e8 100644 --- a/source/sdk/react-native/sync-data.txt +++ b/source/sdk/react-native/sync-data.txt @@ -42,6 +42,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -51,7 +53,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you have many types of Realm objects. @@ -60,8 +62,6 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - .. seealso:: - Learn how to configure and open a realm using :ref:`Flexible Sync `. diff --git a/source/sdk/swift/sync.txt b/source/sdk/swift/sync.txt index 586dbd89bc..b8d42e57e9 100644 --- a/source/sdk/swift/sync.txt +++ b/source/sdk/swift/sync.txt @@ -47,6 +47,8 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. +.. include:: /includes/warning-device-sync-query-size-limit.rst + A subscription set contains a set of queries. Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or @@ -56,7 +58,7 @@ the client application. You can form queries using :ref:`Realm Query Language `. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst Subscription sets are based on a specific type of :ref:`Realm object `. You might have multiple subscriptions if you @@ -66,8 +68,6 @@ To use Flexible Sync in your client application, open a synced realm with a Flexible Sync configuration. Then, manage subscriptions to determine which documents to sync. -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - .. tip:: Device Sync supports two Sync Modes: Flexible Sync, and the older From 38335ada0ae17b4c2ffe4a7ec2b9efb4ba391a2d Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Fri, 2 Aug 2024 10:34:28 -0400 Subject: [PATCH 04/11] switched around warning placement --- source/sdk/cpp/sync.txt | 4 +--- source/sdk/cpp/sync/sync-subscriptions.txt | 4 +++- source/sdk/dotnet/sync/flexible-sync.txt | 4 +++- source/sdk/flutter/sync/manage-sync-subscriptions.txt | 2 ++ source/sdk/java/sync/flexible-sync.txt | 2 ++ source/sdk/kotlin/sync/subscribe.txt | 2 ++ source/sdk/node/sync/flexible-sync.txt | 2 ++ source/sdk/react-native/sync-data/flexible-sync.txt | 2 ++ 8 files changed, 17 insertions(+), 5 deletions(-) diff --git a/source/sdk/cpp/sync.txt b/source/sdk/cpp/sync.txt index 5924fbe970..5a3633a4bf 100644 --- a/source/sdk/cpp/sync.txt +++ b/source/sdk/cpp/sync.txt @@ -43,9 +43,7 @@ When you select :ref:`Flexible Sync ` for your backend App configuration, your client implementation must include subscriptions to queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the -client application. - -.. include:: /includes/warning-device-sync-query-size-limit.rst +client application. A subscription set contains a set of queries. Flexible Sync returns documents matching those queries, where the user has the appropriate diff --git a/source/sdk/cpp/sync/sync-subscriptions.txt b/source/sdk/cpp/sync/sync-subscriptions.txt index 4eea63ab1f..6b3a79b636 100644 --- a/source/sdk/cpp/sync/sync-subscriptions.txt +++ b/source/sdk/cpp/sync/sync-subscriptions.txt @@ -76,7 +76,9 @@ client application can query. In the client application, the :cpp-sdk:`sync_subscription_set ` is a list of zero or more :cpp-sdk:`sync_subscription ` objects that determine what -objects the realm can store. +objects the realm can store. + +.. include:: /includes/warning-device-sync-query-size-limit.rst The Realm C++ SDK also has a :cpp-sdk:`mutable_sync_subscription_set ` that enables you to diff --git a/source/sdk/dotnet/sync/flexible-sync.txt b/source/sdk/dotnet/sync/flexible-sync.txt index 3694cd9106..76ea2695b8 100644 --- a/source/sdk/dotnet/sync/flexible-sync.txt +++ b/source/sdk/dotnet/sync/flexible-sync.txt @@ -87,7 +87,9 @@ Add a Subscription ~~~~~~~~~~~~~~~~~~ You must have at least one subscription before you can read from or write to the realm. You should create one or more initial subscriptions when you -configure Flexible Sync, rather than adding subscriptions after initialization. +configure Flexible Sync, rather than adding subscriptions after initialization. + +.. include:: /includes/warning-device-sync-query-size-limit.rst .. _dotnet-initial-subscriptions: diff --git a/source/sdk/flutter/sync/manage-sync-subscriptions.txt b/source/sdk/flutter/sync/manage-sync-subscriptions.txt index 1d208d95e7..4ac2525f37 100644 --- a/source/sdk/flutter/sync/manage-sync-subscriptions.txt +++ b/source/sdk/flutter/sync/manage-sync-subscriptions.txt @@ -90,6 +90,8 @@ method. When called, the SDK creates the new subscription and adds it to the ``MutableSubscriptionSet``, similar to :ref:`manually creating subscription `. +.. include:: /includes/warning-device-sync-query-size-limit.rst + You can optionally pass a unique subscription name for the query. If you add a subscription with the same name as an existing subscription, the SDK overwrites the existing subscription. diff --git a/source/sdk/java/sync/flexible-sync.txt b/source/sdk/java/sync/flexible-sync.txt index ac12c59704..3bb02c923d 100644 --- a/source/sdk/java/sync/flexible-sync.txt +++ b/source/sdk/java/sync/flexible-sync.txt @@ -138,6 +138,8 @@ Add a Subscription Add a subscription in a subscriptions write block. You append each new subscription to the client's Realm subscriptions. +.. include:: /includes/warning-device-sync-query-size-limit.rst + .. tabs-realm-languages:: .. tab:: diff --git a/source/sdk/kotlin/sync/subscribe.txt b/source/sdk/kotlin/sync/subscribe.txt index df2b2ea716..422ee7ba8c 100644 --- a/source/sdk/kotlin/sync/subscribe.txt +++ b/source/sdk/kotlin/sync/subscribe.txt @@ -178,6 +178,8 @@ This creates an unnamed subscription and adds it to the :ref:`manually add the subscription ` to the subscription set. +.. include:: /includes/warning-device-sync-query-size-limit.rst + Subscribe to a Query with a Name ```````````````````````````````` diff --git a/source/sdk/node/sync/flexible-sync.txt b/source/sdk/node/sync/flexible-sync.txt index b0e223a4d8..2e849a84a6 100644 --- a/source/sdk/node/sync/flexible-sync.txt +++ b/source/sdk/node/sync/flexible-sync.txt @@ -80,6 +80,8 @@ We recommend that you name your subscriptions. This makes finding and managing your subscriptions easier. Subscription names must be unique. Trying to add a subscription with the same name as an existing subscription throws an error. +.. include:: /includes/warning-device-sync-query-size-limit.rst + To subscribe to a query: #. Query for the objects that you want to read and write. diff --git a/source/sdk/react-native/sync-data/flexible-sync.txt b/source/sdk/react-native/sync-data/flexible-sync.txt index f5ddac04c9..5bb4464c4d 100644 --- a/source/sdk/react-native/sync-data/flexible-sync.txt +++ b/source/sdk/react-native/sync-data/flexible-sync.txt @@ -98,6 +98,8 @@ your subscriptions easier. Subscription names must be unique. Trying to add a subscription with the same name as an existing subscription overwrites the existing subscription. +.. include:: /includes/warning-device-sync-query-size-limit.rst + To subscribe to a query: #. Query for the objects that you want to read and write. From 3ec628fd591af8136ccb6bd161af9ddbec658d7f Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Fri, 2 Aug 2024 11:17:20 -0400 Subject: [PATCH 05/11] removed extras --- source/sdk/cpp/sync.txt | 2 +- source/sdk/dotnet/sync.txt | 2 -- source/sdk/flutter/sync.txt | 2 -- source/sdk/java/sync.txt | 2 -- source/sdk/kotlin/sync/add-sync-to-app.txt | 2 -- source/sdk/node/sync.txt | 2 -- source/sdk/react-native/sync-data.txt | 2 -- 7 files changed, 1 insertion(+), 13 deletions(-) diff --git a/source/sdk/cpp/sync.txt b/source/sdk/cpp/sync.txt index 5a3633a4bf..d63a0d3112 100644 --- a/source/sdk/cpp/sync.txt +++ b/source/sdk/cpp/sync.txt @@ -43,7 +43,7 @@ When you select :ref:`Flexible Sync ` for your backend App configuration, your client implementation must include subscriptions to queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the -client application. +client application. A subscription set contains a set of queries. Flexible Sync returns documents matching those queries, where the user has the appropriate diff --git a/source/sdk/dotnet/sync.txt b/source/sdk/dotnet/sync.txt index 70e5720197..68b85f483b 100644 --- a/source/sdk/dotnet/sync.txt +++ b/source/sdk/dotnet/sync.txt @@ -35,8 +35,6 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or diff --git a/source/sdk/flutter/sync.txt b/source/sdk/flutter/sync.txt index bd532656f6..074ce39a40 100644 --- a/source/sdk/flutter/sync.txt +++ b/source/sdk/flutter/sync.txt @@ -86,8 +86,6 @@ write the documents. If documents match the query, but the client does not have the permission to read or write them, they do not sync to the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - You can form Flexible Sync queries using a limited subset of :ref:`Realm Query Language `. To learn more about which fields you can query, refer to the :ref:`Queryable Fields documentation `. diff --git a/source/sdk/java/sync.txt b/source/sdk/java/sync.txt index 8f725ba6ed..625c552084 100644 --- a/source/sdk/java/sync.txt +++ b/source/sdk/java/sync.txt @@ -45,8 +45,6 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or diff --git a/source/sdk/kotlin/sync/add-sync-to-app.txt b/source/sdk/kotlin/sync/add-sync-to-app.txt index 12548f02b7..32b9df23b1 100644 --- a/source/sdk/kotlin/sync/add-sync-to-app.txt +++ b/source/sdk/kotlin/sync/add-sync-to-app.txt @@ -91,8 +91,6 @@ App Services only syncs objects that match the query. You can define multiple queries in your client app. You must define at least one query for each object type in your data model. -.. include:: /includes/warning-device-sync-query-size-limit.rst - App Services ensures that your client-side queries are consistent with your App Services schema through **queryable fields**. These are the fields from your data model that can be used in a subscription query. You diff --git a/source/sdk/node/sync.txt b/source/sdk/node/sync.txt index 3f4a8ceb3b..ddbccbfd36 100644 --- a/source/sdk/node/sync.txt +++ b/source/sdk/node/sync.txt @@ -52,8 +52,6 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or diff --git a/source/sdk/react-native/sync-data.txt b/source/sdk/react-native/sync-data.txt index 8896e560e8..5a21d02b7b 100644 --- a/source/sdk/react-native/sync-data.txt +++ b/source/sdk/react-native/sync-data.txt @@ -42,8 +42,6 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - A subscription set contains a set of queries. Realm Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or From 5748489aa99695016381f31b7cc0e20527979492 Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Sat, 3 Aug 2024 19:48:54 -0400 Subject: [PATCH 06/11] temp --- source/sdk/java/sync/flexible-sync.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/sdk/java/sync/flexible-sync.txt b/source/sdk/java/sync/flexible-sync.txt index 3bb02c923d..a4f875a77b 100644 --- a/source/sdk/java/sync/flexible-sync.txt +++ b/source/sdk/java/sync/flexible-sync.txt @@ -138,7 +138,7 @@ Add a Subscription Add a subscription in a subscriptions write block. You append each new subscription to the client's Realm subscriptions. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. include:: /includes/warning-device-sync-query-size-limit.rst/ .. tabs-realm-languages:: From d79b35696a9e0747b7c73accf3aab8551c226464 Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Tue, 6 Aug 2024 13:58:18 -0400 Subject: [PATCH 07/11] added warning to Limitations section and removed from some pages --- source/includes/flex-sync-limitations.rst | 7 +++++++ source/includes/warning-device-sync-query-size-limit.rst | 5 +++-- source/sdk/cpp/sync/sync-subscriptions.txt | 4 ++-- source/sdk/dotnet/sync/flexible-sync.txt | 2 -- source/sdk/flutter/sync/manage-sync-subscriptions.txt | 2 -- source/sdk/java/sync/flexible-sync.txt | 2 -- source/sdk/kotlin/sync/subscribe.txt | 2 -- source/sdk/node/sync/flexible-sync.txt | 2 -- source/sdk/react-native/sync-data/flexible-sync.txt | 2 -- source/sdk/swift/sync.txt | 2 -- 10 files changed, 12 insertions(+), 18 deletions(-) diff --git a/source/includes/flex-sync-limitations.rst b/source/includes/flex-sync-limitations.rst index b862e019f2..0afb2bae4d 100644 --- a/source/includes/flex-sync-limitations.rst +++ b/source/includes/flex-sync-limitations.rst @@ -105,3 +105,10 @@ Embedded or Linked Objects Flexible Sync does not support querying on properties in Embedded Objects or links. For example, ``obj1.field == "foo"``. + +Query Size Limit +~~~~~~~~~~~~~~~~ + +The **size limit** for a subscription to a query from your client application is **256 kB** +when using Device Sync. Exceeding this limit in a query will result in a +:ref:`LimitsExceeded Error`. diff --git a/source/includes/warning-device-sync-query-size-limit.rst b/source/includes/warning-device-sync-query-size-limit.rst index c25d58ad3e..4aaff96595 100644 --- a/source/includes/warning-device-sync-query-size-limit.rst +++ b/source/includes/warning-device-sync-query-size-limit.rst @@ -1,4 +1,5 @@ .. warning:: Query Size Limit - The **size limit** for queries from your client application when using Device Sync is - **256 kB**. Exceeding this limit in a query will result in a :ref:`LimitsExceeded Error`. \ No newline at end of file + The **size limit** for a subscription to a query from your client application is **256 kB** + when using Device Sync. Exceeding this limit in a query will result in a + :ref:`LimitsExceeded Error`. \ No newline at end of file diff --git a/source/sdk/cpp/sync/sync-subscriptions.txt b/source/sdk/cpp/sync/sync-subscriptions.txt index 6b3a79b636..31b018c8a4 100644 --- a/source/sdk/cpp/sync/sync-subscriptions.txt +++ b/source/sdk/cpp/sync/sync-subscriptions.txt @@ -78,12 +78,12 @@ is a list of zero or more :cpp-sdk:`sync_subscription ` objects that determine what objects the realm can store. -.. include:: /includes/warning-device-sync-query-size-limit.rst - The Realm C++ SDK also has a :cpp-sdk:`mutable_sync_subscription_set ` that enables you to add, change, and remove ``sync_subscription`` objects. +.. include:: /includes/warning-device-sync-query-size-limit.rst + .. _cpp-verify-subscription-size-find-subscription: Verify Number of Subscriptions or Find a Specific Subscription diff --git a/source/sdk/dotnet/sync/flexible-sync.txt b/source/sdk/dotnet/sync/flexible-sync.txt index 76ea2695b8..2d730be03b 100644 --- a/source/sdk/dotnet/sync/flexible-sync.txt +++ b/source/sdk/dotnet/sync/flexible-sync.txt @@ -89,8 +89,6 @@ You must have at least one subscription before you can read from or write to the realm. You should create one or more initial subscriptions when you configure Flexible Sync, rather than adding subscriptions after initialization. -.. include:: /includes/warning-device-sync-query-size-limit.rst - .. _dotnet-initial-subscriptions: Bootstrap the Realm with Initial Subscriptions diff --git a/source/sdk/flutter/sync/manage-sync-subscriptions.txt b/source/sdk/flutter/sync/manage-sync-subscriptions.txt index 4ac2525f37..1d208d95e7 100644 --- a/source/sdk/flutter/sync/manage-sync-subscriptions.txt +++ b/source/sdk/flutter/sync/manage-sync-subscriptions.txt @@ -90,8 +90,6 @@ method. When called, the SDK creates the new subscription and adds it to the ``MutableSubscriptionSet``, similar to :ref:`manually creating subscription `. -.. include:: /includes/warning-device-sync-query-size-limit.rst - You can optionally pass a unique subscription name for the query. If you add a subscription with the same name as an existing subscription, the SDK overwrites the existing subscription. diff --git a/source/sdk/java/sync/flexible-sync.txt b/source/sdk/java/sync/flexible-sync.txt index a4f875a77b..ac12c59704 100644 --- a/source/sdk/java/sync/flexible-sync.txt +++ b/source/sdk/java/sync/flexible-sync.txt @@ -138,8 +138,6 @@ Add a Subscription Add a subscription in a subscriptions write block. You append each new subscription to the client's Realm subscriptions. -.. include:: /includes/warning-device-sync-query-size-limit.rst/ - .. tabs-realm-languages:: .. tab:: diff --git a/source/sdk/kotlin/sync/subscribe.txt b/source/sdk/kotlin/sync/subscribe.txt index 422ee7ba8c..df2b2ea716 100644 --- a/source/sdk/kotlin/sync/subscribe.txt +++ b/source/sdk/kotlin/sync/subscribe.txt @@ -178,8 +178,6 @@ This creates an unnamed subscription and adds it to the :ref:`manually add the subscription ` to the subscription set. -.. include:: /includes/warning-device-sync-query-size-limit.rst - Subscribe to a Query with a Name ```````````````````````````````` diff --git a/source/sdk/node/sync/flexible-sync.txt b/source/sdk/node/sync/flexible-sync.txt index 2e849a84a6..b0e223a4d8 100644 --- a/source/sdk/node/sync/flexible-sync.txt +++ b/source/sdk/node/sync/flexible-sync.txt @@ -80,8 +80,6 @@ We recommend that you name your subscriptions. This makes finding and managing your subscriptions easier. Subscription names must be unique. Trying to add a subscription with the same name as an existing subscription throws an error. -.. include:: /includes/warning-device-sync-query-size-limit.rst - To subscribe to a query: #. Query for the objects that you want to read and write. diff --git a/source/sdk/react-native/sync-data/flexible-sync.txt b/source/sdk/react-native/sync-data/flexible-sync.txt index 5bb4464c4d..f5ddac04c9 100644 --- a/source/sdk/react-native/sync-data/flexible-sync.txt +++ b/source/sdk/react-native/sync-data/flexible-sync.txt @@ -98,8 +98,6 @@ your subscriptions easier. Subscription names must be unique. Trying to add a subscription with the same name as an existing subscription overwrites the existing subscription. -.. include:: /includes/warning-device-sync-query-size-limit.rst - To subscribe to a query: #. Query for the objects that you want to read and write. diff --git a/source/sdk/swift/sync.txt b/source/sdk/swift/sync.txt index b8d42e57e9..f931d26d58 100644 --- a/source/sdk/swift/sync.txt +++ b/source/sdk/swift/sync.txt @@ -47,8 +47,6 @@ queries on :ref:`queryable fields `. Flexible Sync works by synchronizing data that matches query subscriptions you maintain in the client application. -.. include:: /includes/warning-device-sync-query-size-limit.rst - A subscription set contains a set of queries. Flexible Sync returns documents matching those queries, where the user has the appropriate :ref:`permissions ` to read and/or From a5b123b4771c6ad66cb7e3cfad6787479b897d9c Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Tue, 6 Aug 2024 14:30:28 -0400 Subject: [PATCH 08/11] removed include file --- source/includes/warning-device-sync-query-size-limit.rst | 5 ----- source/sdk/cpp/sync/sync-subscriptions.txt | 8 ++++++-- source/sdk/dotnet/sync/flexible-sync.txt | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) delete mode 100644 source/includes/warning-device-sync-query-size-limit.rst diff --git a/source/includes/warning-device-sync-query-size-limit.rst b/source/includes/warning-device-sync-query-size-limit.rst deleted file mode 100644 index 4aaff96595..0000000000 --- a/source/includes/warning-device-sync-query-size-limit.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. warning:: Query Size Limit - - The **size limit** for a subscription to a query from your client application is **256 kB** - when using Device Sync. Exceeding this limit in a query will result in a - :ref:`LimitsExceeded Error`. \ No newline at end of file diff --git a/source/sdk/cpp/sync/sync-subscriptions.txt b/source/sdk/cpp/sync/sync-subscriptions.txt index 31b018c8a4..0dcc91df79 100644 --- a/source/sdk/cpp/sync/sync-subscriptions.txt +++ b/source/sdk/cpp/sync/sync-subscriptions.txt @@ -76,13 +76,17 @@ client application can query. In the client application, the :cpp-sdk:`sync_subscription_set ` is a list of zero or more :cpp-sdk:`sync_subscription ` objects that determine what -objects the realm can store. +objects the realm can store. The Realm C++ SDK also has a :cpp-sdk:`mutable_sync_subscription_set ` that enables you to add, change, and remove ``sync_subscription`` objects. -.. include:: /includes/warning-device-sync-query-size-limit.rst +.. warning:: Query Size Limit + + The **size limit** for a subscription to a query from your client application is **256 kB** + when using Device Sync. Exceeding this limit in a query will result in a + :ref:`LimitsExceeded Error`. .. _cpp-verify-subscription-size-find-subscription: diff --git a/source/sdk/dotnet/sync/flexible-sync.txt b/source/sdk/dotnet/sync/flexible-sync.txt index 2d730be03b..3694cd9106 100644 --- a/source/sdk/dotnet/sync/flexible-sync.txt +++ b/source/sdk/dotnet/sync/flexible-sync.txt @@ -87,7 +87,7 @@ Add a Subscription ~~~~~~~~~~~~~~~~~~ You must have at least one subscription before you can read from or write to the realm. You should create one or more initial subscriptions when you -configure Flexible Sync, rather than adding subscriptions after initialization. +configure Flexible Sync, rather than adding subscriptions after initialization. .. _dotnet-initial-subscriptions: From 50bc2f9c2f59cdeecc4a4321fd08dab06033348f Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Tue, 6 Aug 2024 14:41:14 -0400 Subject: [PATCH 09/11] removed include file --- source/includes/flex-sync-limitations.rst | 2 +- source/sdk/cpp/sync/sync-subscriptions.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/flex-sync-limitations.rst b/source/includes/flex-sync-limitations.rst index 0afb2bae4d..e1aae0113b 100644 --- a/source/includes/flex-sync-limitations.rst +++ b/source/includes/flex-sync-limitations.rst @@ -110,5 +110,5 @@ Query Size Limit ~~~~~~~~~~~~~~~~ The **size limit** for a subscription to a query from your client application is **256 kB** -when using Device Sync. Exceeding this limit in a query will result in a +when using Device Sync. Exceeding this limit results in a :ref:`LimitsExceeded Error`. diff --git a/source/sdk/cpp/sync/sync-subscriptions.txt b/source/sdk/cpp/sync/sync-subscriptions.txt index 0dcc91df79..7205b74ba4 100644 --- a/source/sdk/cpp/sync/sync-subscriptions.txt +++ b/source/sdk/cpp/sync/sync-subscriptions.txt @@ -85,7 +85,7 @@ add, change, and remove ``sync_subscription`` objects. .. warning:: Query Size Limit The **size limit** for a subscription to a query from your client application is **256 kB** - when using Device Sync. Exceeding this limit in a query will result in a + when using Device Sync. Exceeding this limit results in a :ref:`LimitsExceeded Error`. .. _cpp-verify-subscription-size-find-subscription: From 684d115d25f260c40a375b41f7979c28b038b4bd Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Tue, 6 Aug 2024 15:17:58 -0400 Subject: [PATCH 10/11] wording change --- source/includes/flex-sync-limitations.rst | 5 ++--- source/sdk/cpp/sync/sync-subscriptions.txt | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/source/includes/flex-sync-limitations.rst b/source/includes/flex-sync-limitations.rst index e1aae0113b..c84a520790 100644 --- a/source/includes/flex-sync-limitations.rst +++ b/source/includes/flex-sync-limitations.rst @@ -109,6 +109,5 @@ or links. For example, ``obj1.field == "foo"``. Query Size Limit ~~~~~~~~~~~~~~~~ -The **size limit** for a subscription to a query from your client application is **256 kB** -when using Device Sync. Exceeding this limit results in a -:ref:`LimitsExceeded Error`. +The **size limit** for any given query subscription in your subscription set is **256 kB**. +Exceeding this limit results in a :ref:`LimitsExceeded Error`. diff --git a/source/sdk/cpp/sync/sync-subscriptions.txt b/source/sdk/cpp/sync/sync-subscriptions.txt index 7205b74ba4..9055f7c510 100644 --- a/source/sdk/cpp/sync/sync-subscriptions.txt +++ b/source/sdk/cpp/sync/sync-subscriptions.txt @@ -84,9 +84,8 @@ add, change, and remove ``sync_subscription`` objects. .. warning:: Query Size Limit - The **size limit** for a subscription to a query from your client application is **256 kB** - when using Device Sync. Exceeding this limit results in a - :ref:`LimitsExceeded Error`. + The **size limit** for any given query subscription in your subscription set is **256 kB**. + Exceeding this limit results in a :ref:`LimitsExceeded Error`. .. _cpp-verify-subscription-size-find-subscription: From 87301664cc93e41a6dabe5cf9e8ff66aa154c8f3 Mon Sep 17 00:00:00 2001 From: osharaf-mdb Date: Tue, 6 Aug 2024 16:41:52 -0400 Subject: [PATCH 11/11] test --- source/includes/flex-sync-limitations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/flex-sync-limitations.rst b/source/includes/flex-sync-limitations.rst index c84a520790..284d78c527 100644 --- a/source/includes/flex-sync-limitations.rst +++ b/source/includes/flex-sync-limitations.rst @@ -110,4 +110,4 @@ Query Size Limit ~~~~~~~~~~~~~~~~ The **size limit** for any given query subscription in your subscription set is **256 kB**. -Exceeding this limit results in a :ref:`LimitsExceeded Error`. +Exceeding this limit results in a :ref:`LimitsExceeded Error`.