Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-41778 query size limit #3355

Merged
merged 11 commits into from
Aug 6, 2024
Merged

DOCSP-41778 query size limit #3355

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ccee05a
added warning to flutter as test
osharaf-mdb Aug 1, 2024
663397c
fixed other SDK pages
osharaf-mdb Aug 1, 2024
d32f026
fixed call out ordering
osharaf-mdb Aug 1, 2024
38335ad
switched around warning placement
osharaf-mdb Aug 2, 2024
3ec628f
removed extras
osharaf-mdb Aug 2, 2024
5748489
temp
osharaf-mdb Aug 3, 2024
d79b356
added warning to Limitations section and removed from some pages
osharaf-mdb Aug 6, 2024
a5b123b
removed include file
osharaf-mdb Aug 6, 2024
50bc2f9
removed include file
osharaf-mdb Aug 6, 2024
684d115
wording change
osharaf-mdb Aug 6, 2024
8730166
test
osharaf-mdb Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/includes/flex-sync-limitations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 results in a
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

:ref:`LimitsExceeded Error<flexible-sync-errors>`.
6 changes: 6 additions & 0 deletions source/sdk/cpp/sync/sync-subscriptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ The Realm C++ SDK also has a :cpp-sdk:`mutable_sync_subscription_set
<structrealm_1_1mutable__sync__subscription__set.html>` that enables you to
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<flexible-sync-errors>`.

.. _cpp-verify-subscription-size-find-subscription:

Verify Number of Subscriptions or Find a Specific Subscription
Expand Down
Loading