Skip to content

Commit a8b0d46

Browse files
gregturnmp911de
gregturn
authored and
mp911de
committed
Add support for JPA 3.2 additions to JPQL.
See: #3136 Original Pull Request: #3695
1 parent a7fc491 commit a8b0d46

File tree

4 files changed

+171
-31
lines changed

4 files changed

+171
-31
lines changed

‎spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Jpql.g4‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,13 @@ ql_statement
4343
;
4444

4545
select_statement
46-
: select_clause from_clause (where_clause)? (groupby_clause)? (having_clause)? (orderby_clause)?
46+
: select_clause from_clause (where_clause)? (groupby_clause)? (having_clause)? (orderby_clause)? (setOperator_with_select_statement)*
47+
;
48+
49+
setOperator_with_select_statement
50+
: INTERSECT select_statement
51+
| UNION select_statement
52+
| EXCEPT select_statement
4753
;
4854

4955
update_statement
@@ -434,6 +440,7 @@ string_expression
434440
| aggregate_expression
435441
| case_expression
436442
| function_invocation
443+
| string_expression op='||' string_expression
437444
| '(' subquery ')'
438445
;
439446

@@ -878,6 +885,7 @@ ELSE : E L S E;
878885
EMPTY : E M P T Y;
879886
ENTRY : E N T R Y;
880887
ESCAPE : E S C A P E;
888+
EXCEPT : E X C E P T;
881889
EXISTS : E X I S T S;
882890
EXP : E X P;
883891
EXTRACT : E X T R A C T;
@@ -892,6 +900,7 @@ HAVING : H A V I N G;
892900
IN : I N;
893901
INDEX : I N D E X;
894902
INNER : I N N E R;
903+
INTERSECT : I N T E R S E C T;
895904
IS : I S;
896905
JOIN : J O I N;
897906
KEY : K E Y;
@@ -936,6 +945,7 @@ TREAT : T R E A T;
936945
TRIM : T R I M;
937946
TRUE : T R U E;
938947
TYPE : T Y P E;
948+
UNION : U N I O N;
939949
UPDATE : U P D A T E;
940950
UPPER : U P P E R;
941951
VALUE : V A L U E;

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpqlQueryRenderer.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,29 @@ public QueryTokenStream visitSelect_statement(JpqlParser.Select_statementContext
7979
builder.appendExpression(visit(ctx.orderby_clause()));
8080
}
8181

82+
ctx.setOperator_with_select_statement().forEach(setOperatorWithSelectStatementContext -> {
83+
tokens.addAll(visit(setOperatorWithSelectStatementContext));
84+
});
85+
86+
return tokens;
87+
}
88+
89+
@Override
90+
public List<JpaQueryParsingToken> visitSetOperator_with_select_statement(
91+
JpqlParser.SetOperator_with_select_statementContext ctx) {
92+
93+
List<JpaQueryParsingToken> tokens = new ArrayList<>();
94+
95+
if (ctx.INTERSECT() != null) {
96+
tokens.add(new JpaQueryParsingToken(ctx.INTERSECT()));
97+
} else if (ctx.UNION() != null) {
98+
tokens.add(new JpaQueryParsingToken(ctx.UNION()));
99+
} else if (ctx.EXCEPT() != null) {
100+
tokens.add(new JpaQueryParsingToken(ctx.EXCEPT()));
101+
}
102+
103+
tokens.addAll(visit(ctx.select_statement()));
104+
82105
return builder;
83106
}
84107

@@ -799,6 +822,25 @@ public QueryTokenStream visitOrderby_item(JpqlParser.Orderby_itemContext ctx) {
799822
if (ctx.nullsPrecedence() != null) {
800823
builder.append(visit(ctx.nullsPrecedence()));
801824
}
825+
if (ctx.nullsPrecedence() != null) {
826+
tokens.addAll(visit(ctx.nullsPrecedence()));
827+
}
828+
829+
return tokens;
830+
}
831+
832+
@Override
833+
public List<JpaQueryParsingToken> visitNullsPrecedence(JpqlParser.NullsPrecedenceContext ctx) {
834+
835+
List<JpaQueryParsingToken> tokens = new ArrayList<>();
836+
837+
tokens.add(new JpaQueryParsingToken(ctx.NULLS()));
838+
839+
if (ctx.FIRST() != null) {
840+
tokens.add(new JpaQueryParsingToken(ctx.FIRST()));
841+
} else if (ctx.LAST() != null) {
842+
tokens.add(new JpaQueryParsingToken(ctx.LAST()));
843+
}
802844

803845
return builder;
804846
}
@@ -1441,6 +1483,11 @@ public QueryTokenStream visitString_expression(JpqlParser.String_expressionConte
14411483
builder.append(visit(ctx.case_expression()));
14421484
} else if (ctx.function_invocation() != null) {
14431485
builder.append(visit(ctx.function_invocation()));
1486+
} else if (ctx.op != null) {
1487+
1488+
tokens.addAll(visit(ctx.string_expression(0)));
1489+
tokens.add(new JpaQueryParsingToken(ctx.op));
1490+
tokens.addAll(visit(ctx.string_expression(1)));
14441491
} else if (ctx.subquery() != null) {
14451492

14461493
builder.append(TOKEN_OPEN_PAREN);

‎spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java‎

Lines changed: 60 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1639,42 +1639,36 @@ void hqlQueries() {
16391639
@Test // GH-2962
16401640
void orderByWithNullsFirstOrLastShouldWork() {
16411641

1642-
assertThatNoException().isThrownBy(() -> {
1643-
parseWithoutChanges("""
1644-
select a,
1645-
case
1646-
when a.geaendertAm is null then a.erstelltAm
1647-
else a.geaendertAm end as mutationAm
1648-
from Element a
1649-
where a.erstelltDurch = :variable
1650-
order by mutationAm desc nulls first
1651-
""");
1652-
});
1653-
1654-
assertThatNoException().isThrownBy(() -> {
1655-
parseWithoutChanges("""
1656-
select a,
1657-
case
1658-
when a.geaendertAm is null then a.erstelltAm
1659-
else a.geaendertAm end as mutationAm
1660-
from Element a
1661-
where a.erstelltDurch = :variable
1662-
order by mutationAm desc nulls last
1642+
assertQuery("""
1643+
select a,
1644+
case
1645+
when a.geaendertAm is null then a.erstelltAm
1646+
else a.geaendertAm end as mutationAm
1647+
from Element a
1648+
where a.erstelltDurch = :variable
1649+
order by mutationAm desc nulls first
1650+
""");
1651+
1652+
assertQuery("""
1653+
select a,
1654+
case
1655+
when a.geaendertAm is null then a.erstelltAm
1656+
else a.geaendertAm end as mutationAm
1657+
from Element a
1658+
where a.erstelltDurch = :variable
1659+
order by mutationAm desc nulls last
16631660
""");
1664-
});
16651661
}
16661662

16671663
@Test // GH-2964
16681664
void roundFunctionShouldWorkLikeAnyOtherFunction() {
16691665

1670-
assertThatNoException().isThrownBy(() -> {
1671-
parseWithoutChanges("""
1672-
select round(count(ri) * 100 / max(ri.receipt.positions), 0) as perc
1673-
from StockOrderItem oi
1674-
right join StockReceiptItem ri
1675-
on ri.article = oi.article
1676-
""");
1677-
});
1666+
assertQuery("""
1667+
select round(count(ri)*100/max(ri.receipt.positions), 0) as perc
1668+
from StockOrderItem oi
1669+
right join StockReceiptItem ri
1670+
on ri.article = oi.article
1671+
""");
16781672
}
16791673

16801674
@Test // GH-3711
@@ -1854,6 +1848,42 @@ void powerShouldBeLegalInAQuery() {
18541848
assertQuery("select e.power.id from MyEntity e");
18551849
}
18561850

1851+
@Test // GH-3136
1852+
void doublePipeShouldBeValidAsAStringConcatOperator() {
1853+
1854+
assertQuery("""
1855+
select e.name || ' ' || e.title
1856+
from Employee e
1857+
""");
1858+
}
1859+
1860+
@Test // GH-3136
1861+
void additionalStringOperationsShouldWork() {
1862+
1863+
assertQuery("""
1864+
select
1865+
replace(e.name, 'Baggins', 'Proudfeet'),
1866+
left(e.role, 4),
1867+
right(e.home, 5),
1868+
cast(e.distance_from_home, int)
1869+
from Employee e
1870+
""");
1871+
}
1872+
1873+
@Test // GH-3136
1874+
void combinedSelectStatementsShouldWork() {
1875+
1876+
assertQuery("""
1877+
select e from Employee e where e.last_name = 'Baggins'
1878+
intersect
1879+
select e from Employee e where e.first_name = 'Samwise'
1880+
union
1881+
select e from Employee e where e.home = 'The Shire'
1882+
except
1883+
select e from Employee e where e.home = 'Isengard'
1884+
""");
1885+
}
1886+
18571887
@Test // GH-3219
18581888
void extractFunctionShouldSupportAdditionalExtensions() {
18591889

‎spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1004,6 +1004,59 @@ void powerShouldBeLegalInAQuery() {
10041004
assertQuery("select e.power.id from MyEntity e");
10051005
}
10061006

1007+
@Test // GH-3136
1008+
void doublePipeShouldBeValidAsAStringConcatOperator() {
1009+
1010+
assertQuery("""
1011+
select e.name || ' ' || e.title
1012+
from Employee e
1013+
""");
1014+
}
1015+
1016+
@Test // GH-3136
1017+
void combinedSelectStatementsShouldWork() {
1018+
1019+
assertQuery("""
1020+
select e from Employee e where e.last_name = 'Baggins'
1021+
intersect
1022+
select e from Employee e where e.first_name = 'Samwise'
1023+
union
1024+
select e from Employee e where e.home = 'The Shire'
1025+
except
1026+
select e from Employee e where e.home = 'Isengard'
1027+
""");
1028+
}
1029+
1030+
@Disabled
1031+
@Test // GH-3136
1032+
void additionalStringOperationsShouldWork() {
1033+
1034+
assertQuery("""
1035+
select
1036+
replace(e.name, 'Baggins', 'Proudfeet'),
1037+
left(e.role, 4),
1038+
right(e.home, 5),
1039+
cast(e.distance_from_home, int)
1040+
from Employee e
1041+
""");
1042+
}
1043+
1044+
@Test // GH-3136
1045+
void orderByWithNullsFirstOrLastShouldWork() {
1046+
1047+
assertQuery("""
1048+
select a
1049+
from Element a
1050+
order by mutationAm desc nulls first
1051+
""");
1052+
1053+
assertQuery("""
1054+
select a
1055+
from Element a
1056+
order by mutationAm desc nulls last
1057+
""");
1058+
}
1059+
10071060
@ParameterizedTest // GH-3342
10081061
@ValueSource(strings = { "select 1 as value from User u", "select -1 as value from User u",
10091062
"select +1 as value from User u", "select +1 * -100 as value from User u",

0 commit comments

Comments
 (0)