Skip to content

Commit 3c909ae

Browse files
authored
DOCSP-41778 query size limit (#3355)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-41778 - [C++/Sync Data/Manage Sync Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/cpp/sync/sync-subscriptions/#manage-your-subscriptions) - [Flutter/Sync Device Data/Manage Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/flutter/sync/manage-sync-subscriptions/#query-size-limit) - [Java/Sync Data/Mange Flexible Sync Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/java/sync/flexible-sync/#query-size-limit) - [Kotlin/Sync Device Data/Manage Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/kotlin/sync/subscribe/#query-size-limit) - [.NET/Sync Data/Manage Flexible Sync Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/dotnet/sync/flexible-sync/#query-size-limit) - [Node.js//Sync Data/Manage Flexible Sync Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/node/sync/flexible-sync/#query-size-limit) - [Swift//Sync Data/Manage Flexible Sync Subscriptions](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-41778-query-size-limit/sdk/node/sync/flexible-sync/#query-size-limit) ### Reminder Checklist Before merging your PR, make sure to check a few things. - [ ] Did you tag pages appropriately? - genre - programming_language - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [ ] Create a Jira ticket for related docs-realm work, if any ### Release Notes <!-- Present tense, full sentences, end in period Follow ToC strictly - **Define Data Access Permissions** - Data Access Role Examples: Update CRUD Permissions example screenshots and copyable JSON --> - C++ SDK - Sync Data/Manage Sync Subscriptions: Add a warning about the query size limit when using Device Sync. - Throughout the SDK Docs: Update the "Flexible Sync RQL Requirements and Limitations" section to include the query size limit when using Device Sync. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-app-services/blob/master/REVIEWING.md)
1 parent be7913a commit 3c909ae

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

source/includes/flex-sync-limitations.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,9 @@ Embedded or Linked Objects
105105

106106
Flexible Sync does not support querying on properties in Embedded Objects
107107
or links. For example, ``obj1.field == "foo"``.
108+
109+
Query Size Limit
110+
~~~~~~~~~~~~~~~~
111+
112+
The **size limit** for any given query subscription in your subscription set is **256 kB**.
113+
Exceeding this limit results in a :ref:`LimitsExceeded Error<flexible-sync-errors>`.

source/sdk/cpp/sync/sync-subscriptions.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ The Realm C++ SDK also has a :cpp-sdk:`mutable_sync_subscription_set
8282
<structrealm_1_1mutable__sync__subscription__set.html>` that enables you to
8383
add, change, and remove ``sync_subscription`` objects.
8484

85+
.. warning:: Query Size Limit
86+
87+
The **size limit** for any given query subscription in your subscription set is **256 kB**.
88+
Exceeding this limit results in a :ref:`LimitsExceeded Error<flexible-sync-errors>`.
89+
8590
.. _cpp-verify-subscription-size-find-subscription:
8691

8792
Verify Number of Subscriptions or Find a Specific Subscription

0 commit comments

Comments
 (0)