Skip to content

Allow passing of tuples to methods #1838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Allow passing of tuples to methods #1838

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6fea424
1323-in-with-tuple - Prepare branch
schauder Jul 17, 2024
6389d0f
Allow passing of tuples to methods.
schauder Jul 17, 2024
87deefb
Convert array elements.
schauder Jul 18, 2024
c9eaa51
Polishing.
mp911de Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-relational-parent</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>
<packaging>pom</packaging>

<name>Spring Data Relational Parent</name>
Expand Down
2 changes: 1 addition & 1 deletion spring-data-jdbc-distribution/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-relational-parent</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
4 changes: 2 additions & 2 deletions spring-data-jdbc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<modelVersion>4.0.0</modelVersion>

<artifactId>spring-data-jdbc</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>

<name>Spring Data JDBC</name>
<description>Spring Data module for JDBC repositories.</description>
Expand All @@ -15,7 +15,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-relational-parent</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>
</parent>

<properties>
Expand Down
49 changes: 38 additions & 11 deletions ...bc/src/main/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@

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;
Expand Down Expand Up @@ -45,6 +47,7 @@
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;
Expand Down Expand Up @@ -204,23 +207,47 @@ private void convertAndAddParameter(MapSqlParameterSource parameters, Parameter
TypeInformation<?> typeInformation = parameter.getTypeInformation();

JdbcValue jdbcValue;
if (typeInformation.isCollectionLike() && value instanceof Collection<?>) {
if (typeInformation.isCollectionLike() //
Copy link
Member

@mp911de mp911de Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make our concepts more explicit. Binding a single value is fine. Binding a List should become more explicit what we're up to. Binding a list of elements would result in parameter expansion while binding a list of arrays results in tuple expansion.

I suggest that we refactor the code a bit into a form that we extract methods and prepare the target types (i.e. actual type) so that we have a more explicit flow.

Let me know what you think.

Copy link
Contributor Author

@schauder schauder Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with that.
Are you thinking refactoring in the strict sense, i.e. we keep the behaviour as it is with this PR?

&& 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);

mapped.add(elementJdbcValue.getValue());
}
} 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();
}

jdbcValue = JdbcValue.of(mapped, jdbcType);
mapped.add(elementJdbcValue.getValue());
}

jdbcValue = JdbcValue.of(mapped, jdbcType);
}
} else {

SQLType sqlType = parameter.getSqlType();
jdbcValue = converter.writeJdbcValue(value, typeInformation, sqlType);
}
Expand Down
24 changes: 23 additions & 1 deletion ...rc/test/java/org/springframework/data/jdbc/repository/JdbcRepositoryIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down Expand Up @@ -1334,6 +1338,21 @@ void withDelimitedColumnTest() {
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,
Expand Down Expand Up @@ -1461,6 +1480,9 @@ interface DummyEntityRepository extends CrudRepository<DummyEntity, Long>, Query
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> {
Expand Down
31 changes: 31 additions & 0 deletions ...st/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQueryUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
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;
Expand Down Expand Up @@ -325,6 +326,33 @@ void appliesConverterToIterable() {
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));
}
Expand Down Expand Up @@ -450,6 +478,9 @@ interface MyRepository extends Repository<Object, Long> {

@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
Expand Down
4 changes: 2 additions & 2 deletions spring-data-r2dbc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<modelVersion>4.0.0</modelVersion>

<artifactId>spring-data-r2dbc</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>

<name>Spring Data R2DBC</name>
<description>Spring Data module for R2DBC</description>
Expand All @@ -15,7 +15,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-relational-parent</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>
</parent>

<properties>
Expand Down
4 changes: 2 additions & 2 deletions spring-data-relational/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<modelVersion>4.0.0</modelVersion>

<artifactId>spring-data-relational</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>

<name>Spring Data Relational</name>
<description>Spring Data Relational support</description>

<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-relational-parent</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.0-1323-in-with-tuple-SNAPSHOT</version>
</parent>

<properties>
Expand Down