DOCSP-41778 query size limit

[osharaf-mdb]

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-41778

• C++/Sync Data/Manage Sync Subscriptions
• Flutter/Sync Device Data/Manage Subscriptions
• Java/Sync Data/Mange Flexible Sync Subscriptions
• Kotlin/Sync Device Data/Manage Subscriptions
• .NET/Sync Data/Manage Flexible Sync Subscriptions
• Node.js//Sync Data/Manage Flexible Sync Subscriptions
• Swift//Sync Data/Manage Flexible Sync Subscriptions

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
• Describe your PR's changes in the Release Notes section
• Create a Jira ticket for related docs-realm work, if any

Release Notes

• 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

[netlify]

❌ Deploy Preview for device-sdk failed. Why did it fail? →

Name	Link
🔨 Latest commit	8730166
🔍 Latest deploy log	https://app.netlify.com/sites/device-sdk/deploys/66b2933e8456940008403434

[github-actions]

Readability for Commit Hash: cb7ee5a

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

• source/sdk/cpp/sync/sync-subscriptions: Grade Level: 7.1, Reading Ease: 66.94

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score	Difficulty
90-100	Very Easy
80-89	Easy
70-79	Fairly Easy
60-69	Medium
50-59	Fairly Hard
30-49	Hard
0-29	Very Hard

For help improving readability, try Hemingway App.

[dacharyc]

Nice work on adding this to the right page for each SDK! But I think we need to refine where we put it on the pages, and also maybe verify some additional details with engineering so we can communicate the limit effectively in the SDK client context.

[dacharyc]

Same issue here as in the Flutter page - the "Subscribe to Queries" and "Manually Manage Subscriptions" sections represent two different APIs, so we would either need to include this warning in both places or move it to the "Flexible Sync RQL Requirements and Limitations" section.

Same thing applies to the remaining pages here - Node, React Native, and Swift.

[dacharyc]

Thanks for clarifying that detail with engineering! I think we could do a little more tweaking of the wording to remove some unnecessary wordiness and be clearer about the distinction of an individual query size vs. the size of the subscription set.

[dacharyc]

This still reads a little confusing to me. If I have correctly understood that the size limit is per query in the subscription set, not the total subscription set, we might want to reword a little just for clarity:

We don't need to say "when using Device Sync" because we're on the subscription query page where it's understood (hopefully!) that we're talking about Sync subscriptions. And we don't need to say "from your client application" because we're in the SDK client docs.

We should also update the wording on the C++ page once we're happy with this one.

Suggested change

	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
	The **size limit** for any given query in your subscription set is
	**256 kB**. Exceeding this limit results in a

[dacharyc]

LGTM! ✅

[docs-builder-bot]

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

• job log: 3c909ae24c52c276e1ef95e3a2eae7243d4ce84a