Support TypedPropertyPath for queries and update.

Author: christophstrobl

spring-data-r2dbc/src/test/java/org/springframework/data/r2dbc/query/CriteriaUnitTests.java

@@ -22,7 +22,6 @@
 
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.Test;
-
 import org.springframework.data.relational.core.query.Criteria;
 import org.springframework.data.relational.core.sql.SqlIdentifier;
 
@@ -31,6 +30,7 @@
  *
  * @author Mark Paluch
  * @author Mingyuan Wu
+ * @author Christoph Strobl
  */
 class CriteriaUnitTests {
 
@@ -46,6 +46,11 @@ void fromCriteria() {
 		assertThat(criteria.getPrevious()).isEqualTo(Criteria.empty());
 	}
 
+	@Test // GH-2226
+	void whereWithTypedPropertyPathIsEqualToStringColumnName() {
+		assertThat(where(Person::getName).is("o")).isEqualTo(where("name").is("o"));
+	}
+
 	@Test // gh-289
 	void fromCriteriaOptimized() {
 
@@ -95,6 +100,13 @@ void andChainedCriteria() {
 		assertThat(criteria.getValue()).isEqualTo("bar");
 	}
 
+	@Test // gh-2226
+	void andChainedCriteriaWithTypedPropertyPathIsEqualToStringColumnName() {
+
+		assertThat(where(Person::getName).is("o").and(Person::getAge).isNotNull())
+				.isEqualTo(where("name").is("o").and("age").isNotNull());
+	}
+
 	@Test // gh-289
 	void andGroupedCriteria() {
 
@@ -128,6 +140,13 @@ void orChainedCriteria() {
 		assertThat(criteria.getValue()).isEqualTo("bar");
 	}
 
+	@Test // gh-2226
+	void orChainedCriteriaWithTypedPropertyPathIsEqualToStringColumnName() {
+
+		assertThat(where(Person::getName).is("o").or(Person::getAge).isNotNull())
+			.isEqualTo(where("name").is("o").or("age").isNotNull());
+	}
+
 	@Test // gh-289
 	void orGroupedCriteria() {
 
@@ -290,4 +309,18 @@ void shouldBuildIsFalseCriteria() {
 		assertThat(criteria.getColumn()).isEqualTo(SqlIdentifier.unquoted("foo"));
 		assertThat(criteria.getComparator()).isEqualTo(Comparator.IS_FALSE);
 	}
+
+	static class Person {
+
+		private String name;
+		private Integer age;
+
+		public String getName() {
+			return name;
+		}
+
+		public Integer getAge() {
+			return this.age;
+		}
+	}
 }

spring-data-relational/src/main/java/org/springframework/data/relational/core/query/Criteria.java

@@ -26,6 +26,7 @@
 
 import org.jspecify.annotations.Nullable;
 import org.springframework.dao.InvalidDataAccessApiUsageException;
+import org.springframework.data.core.TypedPropertyPath;
 import org.springframework.data.relational.core.sql.IdentifierProcessing;
 import org.springframework.data.relational.core.sql.SqlIdentifier;
 import org.springframework.data.util.Pair;
@@ -54,6 +55,7 @@
  * @author Oliver Drotbohm
  * @author Roman Chigvintsev
  * @author Jens Schauder
+ * @author Christoph Strobl
  * @since 2.0
  */
 public class Criteria implements CriteriaDefinition {
@@ -157,6 +159,17 @@ public static CriteriaStep where(String column) {
 		return new DefaultCriteriaStep(SqlIdentifier.unquoted(column));
 	}
 
+	/**
+	 * Static factory method to create a Criteria using the provided {@code path}.
+	 *
+	 * @param property Must not be {@literal null}.
+	 * @return a new {@link CriteriaStep} object to complete the first {@link Criteria}.
+	 * @since 4.1
+	 */
+	public static <T, P> CriteriaStep where(TypedPropertyPath<T,P> property) {
+		return where(TypedPropertyPath.of(property).toDotPath());
+	}
+
 	/**
 	 * Create a new {@link Criteria} and combine it with {@code AND} using the provided {@code column} name.
 	 *
@@ -177,6 +190,18 @@ protected Criteria createCriteria(Comparator comparator, @Nullable Object value)
 		};
 	}
 
+	/**
+	 * Create a new {@link Criteria} and combine it with {@code AND} using the provided {@code path}.
+	 *
+	 * @param property Must not be {@literal null}.
+	 * @return a new {@link CriteriaStep} object to complete the next {@link Criteria}.
+	 * @since 4.1
+	 */
+	@CheckReturnValue
+	public <T,P> CriteriaStep and(TypedPropertyPath<T,P> property) {
+		return and(TypedPropertyPath.of(property).toDotPath());
+	}
+
 	/**
 	 * Create a new {@link Criteria} and combine it as group with {@code AND} using the provided {@link Criteria} group.
 	 *
@@ -227,6 +252,18 @@ protected Criteria createCriteria(Comparator comparator, @Nullable Object value)
 		};
 	}
 
+	/**
+	 * Create a new {@link Criteria} and combine it with {@code OR} using the provided {@code path}.
+	 *
+	 * @param property Must not be {@literal null}.
+	 * @return a new {@link CriteriaStep} object to complete the next {@link Criteria}.
+	 * @since 4.1
+	 */
+	@CheckReturnValue
+	public <T,P> CriteriaStep or(TypedPropertyPath<T,P> property) {
+		return or(TypedPropertyPath.of(property).toDotPath());
+	}
+
 	/**
 	 * Create a new {@link Criteria} and combine it as group with {@code OR} using the provided {@link Criteria} group.
 	 *

spring-data-relational/src/main/java/org/springframework/data/relational/core/query/Query.java

@@ -22,8 +22,10 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.jspecify.annotations.Nullable;
+import org.springframework.data.core.TypedPropertyPath;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.relational.core.sql.SqlIdentifier;
@@ -35,6 +37,7 @@
  * class are designed to be used in a fluent style creating immutable objects.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  * @since 2.0
  * @see Criteria
  * @see Sort
@@ -114,7 +117,19 @@ public Query columns(Collection<String> columns) {
 
 		Assert.notNull(columns, "Columns must not be null");
 
-		return withColumns(columns.stream().map(SqlIdentifier::unquoted).collect(Collectors.toList()));
+		return withColumns(columns.stream());
+	}
+
+	/**
+	 * Add columns to the query.
+	 *
+	 * @param properties
+	 * @return a new {@link Query} object containing the former settings with {@code columns} applied.
+	 * @since 4.1
+	 */
+	@CheckReturnValue
+	public <T> Query columnsOf(Collection<TypedPropertyPath<T,?>> properties) {
+		return withColumns(properties.stream().map(TypedPropertyPath::of).map(TypedPropertyPath::toDotPath));
 	}
 
 	/**
@@ -132,6 +147,10 @@ public Query columns(SqlIdentifier... columns) {
 		return withColumns(Arrays.asList(columns));
 	}
 
+	private Query withColumns(Stream<String> columns) {
+		return withColumns(columns.map(SqlIdentifier::unquoted).collect(Collectors.toList()));
+	}
+
 	/**
 	 * Add columns to the query.
 	 *

spring-data-relational/src/main/java/org/springframework/data/relational/core/query/Update.java

@@ -21,6 +21,7 @@
 import java.util.StringJoiner;
 
 import org.jspecify.annotations.Nullable;
+import org.springframework.data.core.TypedPropertyPath;
 import org.springframework.data.relational.core.sql.IdentifierProcessing;
 import org.springframework.data.relational.core.sql.SqlIdentifier;
 import org.springframework.lang.CheckReturnValue;
@@ -32,6 +33,7 @@
  *
  * @author Mark Paluch
  * @author Oliver Drotbohm
+ * @author Christoph Strobl
  * @since 2.0
  */
 public class Update {
@@ -65,6 +67,18 @@ public static Update update(String column, @Nullable Object value) {
 		return EMPTY.set(column, value);
 	}
 
+	/**
+	 * Static factory method to create an {@link Update} using the provided path.
+	 *
+	 * @param property must not be {@literal null}.
+	 * @param value can be {@literal null}.
+	 * @return new instance of {@link Update}.
+	 * @since 4.1
+	 */
+	public static <T,P> Update update(TypedPropertyPath<T,P> property, @Nullable Object value) {
+		return update(TypedPropertyPath.of(property).toDotPath(), value);
+	}
+
 	/**
 	 * Update a column by assigning a value.
 	 *
@@ -80,6 +94,19 @@ public Update set(String column, @Nullable Object value) {
 		return addMultiFieldOperation(SqlIdentifier.unquoted(column), value);
 	}
 
+	/**
+	 * Update a path by assigning a value.
+	 *
+	 * @param property must not be {@literal null}.
+	 * @param value can be {@literal null}.
+	 * @return new instance of {@link Update}.
+	 * @since 4.1
+	 */
+	@CheckReturnValue
+	public <T,P> Update set(TypedPropertyPath<T,P> property, @Nullable Object value) {
+		return set(TypedPropertyPath.of(property).toDotPath(), value);
+	}
+
 	/**
 	 * Update a column by assigning a value.
 	 *

spring-data-relational/src/test/java/org/springframework/data/relational/core/query/UpdateUnitTests.java

@@ -23,6 +23,7 @@
  * Unit tests for {@link Update}.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  */
 public class UpdateUnitTests {
 
@@ -31,4 +32,22 @@ public void shouldRenderUpdateToString() {
 
 		assertThat(Update.update("foo", "baz").set("bar", 42)).hasToString("SET foo = 'baz', bar = 42");
 	}
+
+	@Test // GH-2226
+	public void shouldRenderUpdateWithTypedPropertyPathToString() {
+		assertThat(Update.update(Person::getFirstName, "baz").set("bar", 42)).hasToString("SET firstName = 'baz', bar = 42");
+	}
+
+	static class Person {
+		private String firstName;
+		private String lastName;
+
+		public String getFirstName() {
+			return firstName;
+		}
+
+		public String getLastName() {
+			return lastName;
+		}
+	}
 }