From e87a06a713fbdf0d2d9d486d897a1bc984a59e7b Mon Sep 17 00:00:00 2001 From: Rob Bygrave Date: Mon, 21 Nov 2022 17:00:55 +1300 Subject: [PATCH] #2894 - Lack of setNullParameter() functionality on io.ebean.DtoQuery interface --- .../src/main/java/io/ebean/DtoQuery.java | 10 ++++++ .../java/io/ebeaninternal/api/SpiQuery.java | 5 +++ .../server/querydefn/DefaultDtoQuery.java | 20 +++++++++++ .../server/querydefn/DefaultOrmQuery.java | 33 ++++++++----------- .../io/ebean/xtest/base/DtoQueryTest.java | 33 +++++++++++++++++++ 5 files changed, 81 insertions(+), 20 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/DtoQuery.java b/ebean-api/src/main/java/io/ebean/DtoQuery.java index 7de6c2694..c5e2ee421 100644 --- a/ebean-api/src/main/java/io/ebean/DtoQuery.java +++ b/ebean-api/src/main/java/io/ebean/DtoQuery.java @@ -129,6 +129,11 @@ public interface DtoQuery extends CancelableQuery { */ DtoQuery setParameter(String name, Object value); + /** + * Bind the named parameter to SQL NULL. + */ + DtoQuery setNullParameter(String name, int jdbcType); + /** * Bind the named multi-value array parameter which we would use with Postgres ANY. *

@@ -141,6 +146,11 @@ public interface DtoQuery extends CancelableQuery { */ DtoQuery setParameter(int position, Object value); + /** + * Set a positioned parameter to SQL NULL. + */ + DtoQuery setNullParameter(int position, int jdbcType); + /** * Set the index of the first row of the results to return. */ diff --git a/ebean-core/src/main/java/io/ebeaninternal/api/SpiQuery.java b/ebean-core/src/main/java/io/ebeaninternal/api/SpiQuery.java index bbe36c9b9..e10b86315 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/api/SpiQuery.java +++ b/ebean-core/src/main/java/io/ebeaninternal/api/SpiQuery.java @@ -759,6 +759,11 @@ public interface SpiQuery extends Query, SpiQueryFetch, TxnProfileEventCod */ BindParams getBindParams(); + /** + * Return the bind parameters ensuring it is initialised. + */ + BindParams initBindParams(); + /** * Replace the query detail. This is used by the AutoTune feature to as a * fast way to set the query properties and joins. diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultDtoQuery.java b/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultDtoQuery.java index fc82d72ca..b9f7c5178 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultDtoQuery.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultDtoQuery.java @@ -129,6 +129,26 @@ public final class DefaultDtoQuery extends AbstractQuery implements SpiDtoQue return Optional.ofNullable(findOne()); } + @Override + public DtoQuery setNullParameter(String name, int jdbcType) { + if (ormQuery != null) { + ormQuery.initBindParams().setNullParameter(name, jdbcType); + } else { + bindParams.setNullParameter(name, jdbcType); + } + return this; + } + + @Override + public DtoQuery setNullParameter(int position, int jdbcType) { + if (ormQuery != null) { + ormQuery.initBindParams().setNullParameter(position, jdbcType); + } else { + bindParams.setNullParameter(position, jdbcType); + } + return this; + } + @Override public DtoQuery setParameter(int position, Object value) { if (ormQuery != null) { diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java b/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java index 5c5ff7f14..5e952761d 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java @@ -1544,19 +1544,13 @@ public class DefaultOrmQuery extends AbstractQuery implements SpiQuery { @Override public final Query setParameter(Object value) { - if (bindParams == null) { - bindParams = new BindParams(); - } - bindParams.setNextParameter(value); + initBindParams().setNextParameter(value); return this; } @Override public final Query setParameters(Object... values) { - if (bindParams == null) { - bindParams = new BindParams(); - } - bindParams.setNextParameters(values); + initBindParams().setNextParameters(values); return this; } @@ -1567,10 +1561,7 @@ public class DefaultOrmQuery extends AbstractQuery implements SpiQuery { */ @Override public final Query setParameter(int position, Object value) { - if (bindParams == null) { - bindParams = new BindParams(); - } - bindParams.setParameter(position, value); + initBindParams().setParameter(position, value); return this; } @@ -1586,10 +1577,7 @@ public class DefaultOrmQuery extends AbstractQuery implements SpiQuery { return this; } } - if (bindParams == null) { - bindParams = new BindParams(); - } - bindParams.setParameter(name, value); + initBindParams().setParameter(name, value); return this; } @@ -1598,10 +1586,7 @@ public class DefaultOrmQuery extends AbstractQuery implements SpiQuery { if (namedParams != null) { throw new IllegalStateException("setArrayParameter() not supported when EQL parsed query"); } - if (bindParams == null) { - bindParams = new BindParams(); - } - bindParams.setArrayParameter(name, values); + initBindParams().setArrayParameter(name, values); } @Override @@ -1789,6 +1774,14 @@ public class DefaultOrmQuery extends AbstractQuery implements SpiQuery { return bindParams; } + @Override + public BindParams initBindParams() { + if (bindParams == null) { + bindParams = new BindParams(); + } + return bindParams; + } + @Override public final Query where(Expression expression) { where().add(expression); diff --git a/ebean-test/src/test/java/io/ebean/xtest/base/DtoQueryTest.java b/ebean-test/src/test/java/io/ebean/xtest/base/DtoQueryTest.java index fc4c3615e..2494e0c37 100644 --- a/ebean-test/src/test/java/io/ebean/xtest/base/DtoQueryTest.java +++ b/ebean-test/src/test/java/io/ebean/xtest/base/DtoQueryTest.java @@ -18,6 +18,7 @@ import org.tests.model.basic.Customer; import org.tests.model.basic.EBasicLog; import org.tests.model.basic.ResetBasicData; +import java.sql.Types; import java.util.Arrays; import java.util.List; import java.util.Optional; @@ -366,6 +367,38 @@ class DtoQueryTest extends BaseTestCase { assertThat(list).isNotEmpty(); } + @ForPlatform(Platform.H2) + @Test + void dto3_setNullByPosition() { + ResetBasicData.reset(); + + List robs = server().findDto(DCust3.class, "select id, name, nvl(cast(? as int), 42) as totalOrders from o_customer where name like ?") + .setNullParameter(1, Types.INTEGER) + .setParameter(2, "Rob") + .setMaxRows(10) + .findList(); + + log.info(robs.toString()); + assertThat(robs).isNotEmpty(); + assertThat(robs.get(0).getTotalOrders()).isEqualTo(42); + } + + @ForPlatform(Platform.H2) + @Test + void dto3_setNullByName() { + ResetBasicData.reset(); + + List robs = server().findDto(DCust3.class, "select id, name, nvl(cast(:foo as int), 42) as totalOrders from o_customer where name like :bar") + .setNullParameter("foo", Types.INTEGER) + .setParameter("bar", "Rob") + .setMaxRows(10) + .findList(); + + log.info(robs.toString()); + assertThat(robs).isNotEmpty(); + assertThat(robs.get(0).getTotalOrders()).isEqualTo(42); + } + @Test void dto3_findList_constructorMatch() { ResetBasicData.reset();