feat!: EXPOSED-497 Allow OFFSET without LIMIT in query #2226
Conversation
This file contains 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
All dialects except SQLite and MySQL/MariaDB allow OFFSET clause to be used at the end of a query without an associated LIMIT clause. This is currently not possible to accomplish without creating a custom query or providing a very large number, as a limit must be provided to get an offset. This splits SizedIterable.limit() into 2 respective functions, introducing a breaking change for the interface. It also creates a new FunctionProvider.queryLimitAndOffset() to replace the original, so that a nullable limit can be passed.
- Add default values to new interface members so implementations don't break - Remove default argument from old limit() to not conflict with new limit() - Update breaking changes document
e5l
approved these changes
Sep 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Summary of the change:
This makes it possible to generate SELECT query with OFFSET clause that does not require a LIMIT clause.
Detailed description:
The ability to add OFFSET clause is only available through
SizedIterable.limit(), forcing some value to also be passed for a LIMIT clause even though most databases support the former without the latter. UsingInt.MAX_VALUEmay not always be sufficient.It is now possible to append either a LIMIT or an OFFSET clause or both, using DSL or DAO, by chaining
SizedIterable.limit().offset()as needed.SizedIterable.limit(n, offset)is deprecated and default argument for parameter is removed to avoid conflict with below.SizedIterableinterface has 2 new methods:limit(count)andoffset(start). They both have default implementations so that any custom implementations of the interface do not break. Only a warning will be raised that there is an override of a deprecated member. This allows time to migrate before deprecation level is bumped and brings a full breaking change.SizedIterablehave had the deprecations propagated and new members implemented.FunctionProvider.queryLimit()is also deprecated andqueryLimitAndOffset()is added to accept a nullablesizeparameter in the eventlimit()isn't called.Type of Change
Please mark the relevant options with an "X":
Updates/remove existing public API methods:
Affected databases:
Checklist
Related Issues
EXPOSED-497