feat(firestore): global option to turn on implicit orderby#2337
Open
feat(firestore): global option to turn on implicit orderby#2337
Conversation
product-auto-label
bot
added
size: m
wu-hui
force-pushed
the
feat-implicit-orderby
branch
from
a855d28 to
84bc5f2
Compare
MarkDuckworth
approved these changes
Mar 11, 2026
Contributor
MarkDuckworth
left a comment
MarkDuckworth
left a comment
There was a problem hiding this comment.
LGTM. The JavaDoc comment on the setting could use a little cleanup for readabiliy, but looks good
| /** | ||
| * Sets whether to always use implicit order bys (e.g., for inequality queries). | ||
| * | ||
| * <p>By default, the SDK only sends explicit order bys and relies on the backend to append |
Contributor
There was a problem hiding this comment.
Unclear if you need the <p> tag
| * | ||
| * <p>By default, the SDK only sends explicit order bys and relies on the backend to append | ||
| * implicit order bys (unless cursors are involved). However, enterprise edition does not | ||
| * enforce implicit order bys because it does not back all queries with an index. This option |
Contributor
There was a problem hiding this comment.
You might want to add something like: "In standard edition databases, all queries were backed with an index, so implicit order bys are applied to every query."
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces a new global option
alwaysUseImplicitOrderByinFirestoreOptionsto control whether implicit order bys (e.g. for inequality queries) are sent to the backend. By default, it isfalse(meaning the SDK only sends explicit order bys). Enterprise users can opt-in to always send them by setting this new option totrueto mimic Standard tier behavior.Related modifications:
alwaysUseImplicitOrderBytoFirestoreOptions.Query.javahandles this serialization flag to send implicit orders for fields with inequalities.Watch.javawas updated to always send implicit orders for streaming, regardless of the flag.