Spring/spring-data-relational
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Allow passing of tuples to repository query methods.

Browse Source 
Closes #1323
Original pull request: #1838
This commit is contained in:
Jens Schauder
2024-07-17 16:00:10 +02:00
committed by Mark Paluch
parent 23d91d62bb
commit 8241aa1222
3 changed files with 92 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQuery.java
View File

@@ -17,7 +17,9 @@ package org.springframework.data.jdbc.repository.query;
import static org.springframework.data.jdbc.repository.query.JdbcQueryExecution.*;
import java.lang.reflect.Array;
import java.lang.reflect.Constructor;
import java.sql.JDBCType;
import java.sql.SQLType;
import java.util.ArrayList;
import java.util.Collection;
@@ -45,6 +47,7 @@ import org.springframework.data.repository.query.SpelEvaluator;
import org.springframework.data.repository.query.SpelQueryContext;
import org.springframework.data.util.Lazy;
import org.springframework.data.util.TypeInformation;
import org.springframework.data.util.TypeUtils;
import org.springframework.jdbc.core.ResultSetExtractor;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
@@ -204,23 +207,47 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
TypeInformation<?> typeInformation = parameter.getTypeInformation();
JdbcValue jdbcValue;
if (typeInformation.isCollectionLike() && value instanceof Collection<?>) {
if (typeInformation.isCollectionLike() //
&& value instanceof Collection<?> collectionValue//
) {
if ( typeInformation.getActualType().getType().isArray() ){
List<Object> mapped = new ArrayList<>();
SQLType jdbcType = null;
TypeInformation<?> arrayElementType = typeInformation.getActualType().getActualType();
TypeInformation<?> actualType = typeInformation.getRequiredActualType();
for (Object o : (Iterable<?>) value) {
JdbcValue elementJdbcValue = converter.writeJdbcValue(o, actualType, parameter.getActualSqlType());
if (jdbcType == null) {
jdbcType = elementJdbcValue.getJdbcType();
List<Object[]> mapped = new ArrayList<>();
for (Object array : collectionValue) {
int length = Array.getLength(array);
Object[] mappedArray = new Object[length];
for (int i = 0; i < length; i++) {
Object element = Array.get(array, i);
JdbcValue elementJdbcValue = converter.writeJdbcValue(element, arrayElementType, parameter.getActualSqlType());
mappedArray[i] = elementJdbcValue.getValue();
}
mapped.add(mappedArray);
}
jdbcValue = JdbcValue.of(mapped, JDBCType.OTHER);
} else {
List<Object> mapped = new ArrayList<>();
SQLType jdbcType = null;
TypeInformation<?> actualType = typeInformation.getRequiredActualType();
for (Object o : collectionValue) {
JdbcValue elementJdbcValue = converter.writeJdbcValue(o, actualType, parameter.getActualSqlType());
if (jdbcType == null) {
jdbcType = elementJdbcValue.getJdbcType();
}
mapped.add(elementJdbcValue.getValue());
}
mapped.add(elementJdbcValue.getValue());
jdbcValue = JdbcValue.of(mapped, jdbcType);
}
jdbcValue = JdbcValue.of(mapped, jdbcType);
} else {
SQLType sqlType = parameter.getSqlType();
jdbcValue = converter.writeJdbcValue(value, typeInformation, sqlType);
}

24
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/JdbcRepositoryIntegrationTests.java
View File

@@ -117,9 +117,13 @@ public class JdbcRepositoryIntegrationTests {
@Autowired WithDelimitedColumnRepository withDelimitedColumnRepository;
private static DummyEntity createDummyEntity() {
return createDummyEntity("Entity Name");
}
private static DummyEntity createDummyEntity(String entityName) {
DummyEntity entity = new DummyEntity();
entity.setName("Entity Name");
entity.setName(entityName);
return entity;
}
@@ -1334,6 +1338,21 @@ public class JdbcRepositoryIntegrationTests {
assertThat(inDatabase.get().getIdentifier()).isEqualTo("UR-123");
}
@Test // GH-1323
void queryWithTupleIn() {
DummyEntity one = repository.save(createDummyEntity("one"));
DummyEntity two = repository.save(createDummyEntity( "two"));
DummyEntity three = repository.save(createDummyEntity( "three"));
List<Object[]> tuples = List.of(
new Object[]{two.idProp, "two"}, // matches "two"
new Object[]{three.idProp, "two"} // matches nothing
);
repository.findByListInTuple(tuples);
}
private Root createRoot(String namePrefix) {
return new Root(null, namePrefix,
@@ -1461,6 +1480,9 @@ public class JdbcRepositoryIntegrationTests {
Optional<DummyDto> findDtoByIdProp(Long idProp);
Optional<DummyAllArgsDto> findAllArgsDtoByIdProp(Long idProp);
@Query("SELECT * FROM DUMMY_ENTITY WHERE (ID_PROP, NAME) IN (:tuples)")
List<DummyEntity> findByListInTuple(List<Object[]> tuples);
}
interface RootRepository extends ListCrudRepository<Root, Long> {

31
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQueryUnitTests.java
View File

@@ -22,6 +22,7 @@ import java.lang.reflect.Method;
import java.sql.JDBCType;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
@@ -325,6 +326,33 @@ class StringBasedJdbcQueryUnitTests {
assertThat(sqlParameterSource.getValue("value")).isEqualTo("one");
}
@Test // GH-1323
void queryByListOfTuples() {
String[][] tuples = {new String[]{"Albert", "Einstein"}, new String[]{"Richard", "Feynman"}};
SqlParameterSource parameterSource = forMethod("findByListOfTuples", List.class) //
.withArguments(Arrays.asList(tuples))
.extractParameterSource();
assertThat(parameterSource.getValue("tuples"))
.asInstanceOf(LIST)
.containsExactly(tuples);
}
@Test // GH-1323
void queryByListOfConvertableTuples() {
SqlParameterSource parameterSource = forMethod("findByListOfTuples", List.class) //
.withCustomConverters(DirectionToIntegerConverter.INSTANCE) //
.withArguments(Arrays.asList(new Object[]{Direction.LEFT, "Einstein"}, new Object[]{Direction.RIGHT, "Feynman"}))
.extractParameterSource();
assertThat(parameterSource.getValue("tuples"))
.asInstanceOf(LIST)
.containsExactly(new Object[][]{new Object[]{-1, "Einstein"}, new Object[]{1, "Feynman"}});
}
QueryFixture forMethod(String name, Class... paramTypes) {
return new QueryFixture(createMethod(name, paramTypes));
}
@@ -450,6 +478,9 @@ class StringBasedJdbcQueryUnitTests {
@Query("SELECT * FROM person WHERE lastname = $1")
Object unsupportedLimitQuery(@Param("lastname") String lastname, Limit limit);
@Query("select count(1) from person where (firstname, lastname) in (:tuples)")
Object findByListOfTuples(@Param("tuples") List<Object[]> tuples);
}
@Test // GH-619