fix unclear spec doc for the OrderBy keyword #577
Merged
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
njr-11
added
bug
otaviojava
reviewed
Mar 22, 2024
| @@ -934,7 +934,7 @@ The parsing of query method names follows a specific format: | |||
| - The method name consists of the subject, the predicate, and optionally the order clause. | |||
| - The subject begins with the action (such as `find` or `delete`) and is optionally followed by an expression (for example, `First10`), followed by any number of other characters, followed by `By`. | |||
| - The predicate defines the query's condition or filtering criteria, where multiple conditions are delimited by `And` or `Or`. For example, `PriceLessThanAndNameLike`. | |||
| - The order clause, which is optional, begins with `OrderBy` and consists of an ordered collection of entity attributes by which to sort results, delimited by `Asc` or `Desc` to specify the sort direction of the preceding attribute. | |||
| - The order clause, which is optional, begins with `OrderBy` and is followed by one or more ordered pairings consisting of entity attribute name and direction of sorting (`Asc` or `Desc`). For example, `OrderByPriceDescIdAsc`. Ordering of results is performed by sorting the first entity attribute according to its respective direction, where results that sort to the same position are subsequently sorted by the second entity attribute according to its respective direction, and so forth. | |||
There was a problem hiding this comment.
But, when we don't put Asc it is asc implicitly.
It also happens in SQL, and we share the same behavior in NoSQL:
SELECT * FROM Products ORDER BY Price;It would be great if you reproduce it here as well.
There was a problem hiding this comment.
That's a good point. The BNF does allow an optimization where the direction can be omitted on the final property and we need to define the meaning of that in the spec. I added commit 487098a to address this.
njr-11
force-pushed
the
fix-unclear-doc-of-orderby-keyword
branch
from
b5cce71 to
487098a
Compare
otaviojava
approved these changes
Mar 22, 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.
This aims to at least partially fix unclear specification language identified in #576 around the OrderBy keyword.