This release of QueryDSL targets Java 8 minimally and comes with various improvements to make QueryDSL ready for the modern Java ecosystem.
This version also removes joda-time:joda-time
, com.google.guava:guava
and com.google.code.findbugs:jsr305
as required runtime dependencies for using QueryDSL.
QueryDSL 5.0 is the long awaited major release after the QueryDSL project was left mostly unmaintained for over two years. With this release the team worked hard on resolving the most pressing issues that have been requested repeatedly for a long time.
A huge thanks goes out to all contributors that made this release possible in their free time:
- @mp911de, for working on the MongoDB Document API;
- @daniel-shuy, for working on decoupling
querydsl-sql
fromjoda-time:joda-time
; - @heesuk-ahn, for working on improved Hibernate support and count query generation in
JPASQLQuery
; - @harshtuna, for working on NullsLast ordering in
querydsl-collections
; - @kherrala, @ridoo and @NikitaKochkurov for working on the JTS and GeoLatte upgrade for
querydsl-spatial
; - @ridoo, for working on Spatial support in
HibernateDomainExporter
andJPADomainExporter
; - @lpandzic, for working on codegen support for Java 15 records and general improvements;
- @F43nd1r, for working on Kotlin Code generation, Java 11 support, general improvements and Continuous Integration;
- @jwgmeligmeyling, @Shredder121, @johnktims, @idosal and @robertandrewbain.
- #2672 - Various performance and code improvements possible by targeting Java 8 source level.
- #2672 - Added
Fetchable#stream()
which returns aStream<T>
. Make sure that the returned stream is always closed to free up resources, for example using try-with-resources. It does not suffice to rely on a terminating operation on the stream for this (i.e.forEach
,collect
). - #2324 - Removal of Guava as dependency. Almost no required transitive dependencies to get started with QueryDSL. And no more conflicts with Guava versions required by your other tools or own application.
- #2025 -
joda-time:joda-time
is no longer a required dependency forquerydsl-sql
. By default, the Java 8 date/time API is used for date/time operations. Thejoda-time:joda-time
types will still be registered automatically if they are on the classpath. - #2215 - MongoDB 4 support through the Document API
- #2697 - Allow
com.querydsl.core.alias.Alias.*
to be used on a JRE by relying on ECJ as compiler - #2479 - Swap out JSR305 for Jetbrains Annotations. Because the Jetbrains Annotations, contrary to the JSR305 annotations, use a Class retention level, Jetbrains Annotations does not have to be available at runtime and is not a transitive dependency.
- #658 - Added
JPAExpressions#treat
which can be used to generate JPA 2.1 Treated path expressions. - #2666 - More descriptive error message when using unsupported query features in JPA.
- #2106 - Support NullsLast ordering in
querydsl-collections
. - #2404 - Upgrade of JTS / Geolatte in
querydsl-spatial
- #2320 - Make Spatial support available to
HibernateDomainExporter
andJPADomainExporter
. - #2612 - Support jakarta.* packages for new Jakarta EE releases (available through the
jakarta
classifiers for Maven) - #1376 - Return typed expression from
nullif
andcoalesce
methods. - #1828 - Kotlin Codegen support
- #2798 - Java Record support
- #2579 - Count query generation in
JPASQLQuery
- #2671 - Fixed a concurrency issue in
Alias.*
.Alias.*
is now Thread safe. - #2053 - Work around issues with
AbstractJPAQuery#fetchResults
andAbstractJPAQuery#fetchCount
in a query with a having clause by using an in-memory calculation. - #2504 - Work around issues with
AbstractJPAQuery#fetchResults
andAbstractJPAQuery#fetchCount
in a query with multiple group by expressions by using an in-memory calculation. - #2663 - Fix issues with the JPA implementation of
InsertClause
. - #2706 - Fix a memory leak in
TemplateFactory
. - #2467 - Prevent
ExtendedBeanSerializer
from generatingtoString
method twice - #2326 - Use JPA indexed parameters instead of HQL's legacy positional parameters
- #2816 - Generated JPA query with incorrect argument binding indexes
- #1413 - Incorrect parameter values with Hibernate custom types
- #1429 - Reusing of constants in JPQL generation causes issues with hibernate query caching
- Java 8 minimal requirement. If you still rely on Java <7, please use the latest 4.x.x version.
JavaSE6SQLExceptionWrapper
and other parts regarding pre-Java 7 exception handling are removed.- Removed bridge method that were in place for backwards compatibility of legacy API's. This may lead to some breaking API changes.
- Removed Guava as a dependency. If your application relies on Guava, make sure to add it as a direct dependency for your project and not rely on QueryDSL shipping it transitively.
- In order for Guava to be removed Mysema Codegen had to be rereleased as QueryDSL Codegen Utils.
Therefore, the classes in this module moved to a different package:
com.mysema.codegen
is nowcom.querydsl.codegen.utils
. This for example affectscom.mysema.codegen.model.SimpleType
. Although many applications won't touch the codgen internal classes, custom APT extensions might be affected by this. - Due to the removal of Guava, any method that received an
ImmutableList
as parameter, now accepts anyList
instead. Normal code should handle this signature just fine. However, make sure to check any reflective uses of these parameters. - The
querydsl.variableNameFunctionClass
property for theDefaultConfiguration
should now be provided as ajava.util.function.Function
instead of acom.google.common.base.Function
. CodeWriter#beginStaticMethod
now takes ajava.util.function.Function
instead of acom.google.common.base.Function
.AbstractLuceneQuery
now takes ajava.util.function.Function
instead of acom.google.common.base.Function
.AbstractMongodbQuery
now takes ajava.util.function.Function
instead of acom.google.common.base.Function
.com.querydsl.codegen.NamingFunction
,EvaluatorFunction
,DefaultVariableFunction
now extendjava.util.function.Function
instead ofcom.google.common.base.Function
.- Any constructor that received a
javax.inject.Provider
, now takes ajava.util.function.Supplier
instead. In most cases you can replace the argument withprovider::get
. - This release targets Hibernate 5.2 in the Hibernate integration. If you need Hibernate 4 dialect specific workarounds, use the
HQLTemplates
instead of theHibernate5Templates
. - Removal of various deprecated methods.
joda-time:joda-time
is now an optional dependency. If your application relies onjoda-time:joda-time
make sure to specify it as a direct dependency rather than relying on QueryDSL to include it transitively.com.google.code.findbugs:jsr305
is no longer a dependency. If your application currently relies on QueryDSL shipping JSR305 transitively, you should add JSR305 as a direct dependency to your project.- MDC keys now use an underscore instead of a dot as separator:
querydsl.query
now isquerydsl_query
andquerydsl.parameters
isquerydsl_parameters
. - Removal of
PolyHedralSurface
inquerydsl-spatial
andquerydsl-sql-spatial
due to the upgrade ofgeolatte-geom
. com.querydsl.apt.Extension
moved tocom.querydsl.codegen
and now resides in thequerydsl-codegen
module.com.querydsl.apt.SpatialSupport
moved tocom.querydsl.spatial.apt.SpatialSupport
and now resides in thequerydsl-spatial
module.com.querydsl.sql.codegen.SpatialSupport
moved tocom.querydsl.sql.spatial.SpatialSupport
and now resides in thequerydsl-sql-spatial
module.SQLServerGeometryReader
inquerydsl-sql-spatial
is removed in favour oforg.geolatte.geom.codec.db.sqlserver.*
.PGgeometryConverter
inquerydsl-sql-spatial
is removed in favour oforg.geolatte.geom.codec.Wkt
.JGeometryConverter
inquerydsl-sql-spatial
is removed in favour oforg.geolatte.geom.codec.db.oracle.*
.- Removal of
HibernateDomainExporter
inquerysql-jpa-codegen
.HibernateDomainExporter
only supported Hibernate 4, which QueryDSL no longer actively supports. Instead, use theJPADomainExporter
with Hibernate. ComparableExpression#coalesce
(and subtypes) no longer return a mutableCoalesce
expression, but instead return a typed expression. If you need the Coalesce builder, usenew Coalesce<T>().add(expression)
instead.getConstantToNamedLabel
,getConstantToNumberedLabel
andgetConstantToAllLabels
that were temporarily introduced toSerializerBase
andJPQLSerializer
in QueryDSL 4.3.0 to eventually replacegetConstantToLabel
are now removed in favor ofgetConstants
.
AbstractJPAQuery#fetchResults
andAbstractJPAQuery#fetchCount
are now deprecated for queries that have multiple group by expressions or a having clause, because these scenarios cannot be supported by pure JPA and are instead computed in-memory. If the total count of results is not necessary, we recommend to always useAbstractJPAQuery#fetch
instead. If you want a reliable way of computing the result count for a paginated result for even the most complicated queries, we recommend using the Blaze-Persistence QueryDSL integration.BlazeJPAQuery
properly implements bothfetchResults
andfetchCount
and even comes with apage
method.getConstantToLabel
which was deprecated in QueryDSL 4.3.0 is no longer deprecated.
cglib:cglib
to 3.3.0 for Java 8+ supportorg.eclipse.jdt.core.compiler:ecj
to 4.6.1 for Java 8+ supportjoda-time:joda-time
to 2.10.10 for better interoperability with other frameworks that use more recent versions than QueryDSL.joda-time:joda-time
is also no longer a required dependency and as such is no longer provided transitively to your application. If your application relies onjoda-time:joda-time
being available, make sure to add the dependency to your project.org.geolatte:geolatte-geom
to 1.8.1 for better interopability with Hibernate Spatial.querydsl-spatial
is still backwards compatible with older versions of Geolatte, however,querydsl-sql-spatial
is not and requires 1.4.0 or newer.com.vividsolutions:jts
toorg.locationtech:jts
for better interopability with Hibernate Spatial.com.vividsolutions:jts
is still supported forquerydsl-spatial
if an older version oforg.geolatte:geolatte-geom
is provided.- DataNucleus 5.2.x for Java 8+ support
- JDO now uses
org.datanucleus:javax.jdo
instead ofjavax.jdo:jdo-api
- JDO now uses
com.google.guava:guava
is no longer a dependency of QueryDSL and as such is no longer provided transitively to your application. If your application relies oncom.google.guava:guava
being available, make sure to add the dependency to your project.com.google.code.findbugs:jsr305
is no longer a dependency of QueryDSL and as such is no longer provided transitively to your application. If your application relies oncom.google.code.findbugs:jsr305
being available, make sure to add the dependency to your project.