Explore returning Search Results.

Closes: #3868

Author: mp911de

pom.xml

@@ -38,6 +38,7 @@
 		<jsqlparser>5.0</jsqlparser>
 		<mysql-connector-java>9.1.0</mysql-connector-java>
 		<postgresql>42.7.4</postgresql>
+        <oracle>23.7.0.25.01</oracle>
 		<springdata.commons>4.0.0-SNAPSHOT</springdata.commons>
 		<vavr>0.10.3</vavr>
 
@@ -56,6 +57,14 @@
 	<profiles>
 		<profile>
 			<id>jmh</id>
+			<dependencies>
+				<dependency>
+					<groupId>com.github.mp911de.microbenchmark-runner</groupId>
+					<artifactId>microbenchmark-runner-junit5</artifactId>
+					<version>0.5.0.RELEASE</version>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
 			<repositories>
 				<repository>
 					<id>jitpack</id>
@@ -112,6 +121,19 @@
 									</includes>
 								</configuration>
 							</execution>
+							<execution>
+								<id>oracle-test</id>
+								<phase>test</phase>
+								<goals>
+									<goal>test</goal>
+								</goals>
+								<configuration>
+									<includes>
+										<include>**/Oracle*IntegrationTests.java
+										</include>
+									</includes>
+								</configuration>
+							</execution>
 						</executions>
 					</plugin>
 				</plugins>

spring-data-jpa/pom.xml

@@ -88,6 +88,12 @@
 			<optional>true</optional>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+
 		<dependency>
 			<groupId>org.junit.platform</groupId>
 			<artifactId>junit-platform-launcher</artifactId>
@@ -161,6 +167,28 @@
 			<scope>test</scope>
 		</dependency>
 
+		<!-- Oracle testing support -->
+
+		<dependency>
+			<groupId>com.oracle.database.jdbc</groupId>
+			<artifactId>ojdbc17</artifactId>
+			<version>${oracle}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>com.oracle.database.jdbc</groupId>
+			<artifactId>ucp17</artifactId>
+			<version>${oracle}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.testcontainers</groupId>
+			<artifactId>oracle-free</artifactId>
+			<scope>test</scope>
+		</dependency>
+
 		<dependency>
 			<groupId>io.vavr</groupId>
 			<artifactId>vavr</artifactId>
@@ -183,6 +211,13 @@
 			</exclusions>
 		</dependency>
 
+		<dependency>
+			<groupId>${hibernate.groupId}.orm</groupId>
+			<artifactId>hibernate-vector</artifactId>
+			<version>${hibernate}</version>
+			<optional>true</optional>
+		</dependency>
+
 		<dependency>
 			<groupId>${hibernate.groupId}.orm</groupId>
 			<artifactId>hibernate-jpamodelgen</artifactId>
@@ -318,6 +353,7 @@
 								<exclude>**/EclipseLink*</exclude>
 								<exclude>**/MySql*</exclude>
 								<exclude>**/Postgres*</exclude>
+								<exclude>**/Oracle*</exclude>
 							</excludes>
 							<argLine>
 								-Xmx4G

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/aot/QueriesFactory.java

@@ -224,7 +224,8 @@ private AotQuery createQuery(PartTree partTree, ReturnedType returnedType, JpaPa
 
 		ParameterMetadataProvider metadataProvider = new ParameterMetadataProvider(parameters, EscapeCharacter.DEFAULT,
 				templates);
-		JpaQueryCreator queryCreator = new JpaQueryCreator(partTree, returnedType, metadataProvider, templates, metamodel);
+		JpaQueryCreator queryCreator = new JpaQueryCreator(partTree, false, returnedType, metadataProvider, templates,
+				metamodel);
 
 		return StringAotQuery.jpqlQuery(queryCreator.createQuery(), metadataProvider.getBindings(),
 				partTree.getResultLimit(), partTree.isDelete(), partTree.isExistsProjection());

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/AbstractJpaQuery.java

@@ -101,7 +101,7 @@ public AbstractJpaQuery(JpaQueryMethod method, EntityManager em) {
 				return new StreamExecution();
 			} else if (method.isProcedureQuery()) {
 				return new ProcedureExecution(method.isCollectionQuery());
-			} else if (method.isCollectionQuery()) {
+			} else if (method.isCollectionQuery() || method.isSearchQuery()) {
 				return new CollectionExecution();
 			} else if (method.isSliceQuery()) {
 				return new SlicedExecution();
@@ -149,17 +149,18 @@ protected JpaMetamodel getMetamodel() {
 
 	@Override
 	public @Nullable Object execute(Object[] parameters) {
-		return doExecute(getExecution(), parameters);
+
+		JpaParametersParameterAccessor accessor = obtainParameterAccessor(parameters);
+		return doExecute(getExecution(accessor), accessor);
 	}
 
 	/**
 	 * @param execution
 	 * @param values
 	 * @return
 	 */
-	private @Nullable Object doExecute(JpaQueryExecution execution, Object[] values) {
+	private @Nullable Object doExecute(JpaQueryExecution execution, JpaParametersParameterAccessor accessor) {
 
-		JpaParametersParameterAccessor accessor = obtainParameterAccessor(values);
 		Object result = execution.execute(this, accessor);
 
 		ResultProcessor withDynamicProjection = method.getResultProcessor().withDynamicProjection(accessor);
@@ -176,10 +177,17 @@ private JpaParametersParameterAccessor obtainParameterAccessor(Object[] values)
 		return new JpaParametersParameterAccessor(method.getParameters(), values);
 	}
 
-	protected JpaQueryExecution getExecution() {
+	protected JpaQueryExecution getExecution(JpaParametersParameterAccessor accessor) {
 
 		JpaQueryExecution execution = this.execution.getNullable();
 
+		if (method.isSearchQuery()) {
+
+			ReturnedType returnedType = method.getResultProcessor().withDynamicProjection(accessor).getReturnedType();
+			return new JpaQueryExecution.SearchResultExecution(execution == null ? new SingleEntityExecution() : execution,
+					returnedType, accessor.getScoringFunction(), accessor.normalizeSimilarity());
+		}
+
 		if (execution != null) {
 			return execution;
 		}

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaCountQueryCreator.java

@@ -48,7 +48,7 @@ public class JpaCountQueryCreator extends JpaQueryCreator {
 	public JpaCountQueryCreator(PartTree tree, ReturnedType returnedType, ParameterMetadataProvider provider,
 			JpqlQueryTemplates templates, EntityManager em) {
 
-		super(tree, returnedType, provider, templates, em);
+		super(tree, returnedType, provider, templates, em.getMetamodel());
 
 		this.distinct = tree.isDistinct();
 		this.returnedType = returnedType;

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaKeysetScrollQueryCreator.java

@@ -23,6 +23,8 @@
 import java.util.List;
 import java.util.Map;
 
+import java.util.concurrent.atomic.AtomicInteger;
+
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.data.domain.KeysetScrollPosition;
@@ -49,7 +51,7 @@ public JpaKeysetScrollQueryCreator(PartTree tree, ReturnedType type, ParameterMe
 			JpqlQueryTemplates templates, JpaEntityInformation<?, ?> entityInformation, KeysetScrollPosition scrollPosition,
 			EntityManager em) {
 
-		super(tree, type, provider, templates, em);
+		super(tree, type, provider, templates, em.getMetamodel());
 
 		this.entityInformation = entityInformation;
 		this.scrollPosition = scrollPosition;

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaParametersParameterAccessor.java

@@ -15,8 +15,16 @@
  */
 package org.springframework.data.jpa.repository.query;
 
+import java.util.function.Function;
+import java.util.function.Predicate;
+import java.util.function.Supplier;
+
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.data.domain.Range;
+import org.springframework.data.domain.Score;
+import org.springframework.data.domain.ScoringFunction;
+import org.springframework.data.domain.Similarity;
 import org.springframework.data.jpa.repository.query.JpaParameters.JpaParameter;
 import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.Parameters;
@@ -68,4 +76,54 @@ protected Object potentiallyUnwrap(Object parameterValue) {
 		return parameterValue;
 	}
 
+	/**
+	 * Returns the {@link ScoringFunction}.
+	 *
+	 * @return
+	 */
+	public ScoringFunction getScoringFunction() {
+		return doWithScore(Score::getFunction, Score.class::isInstance, ScoringFunction::unspecified);
+	}
+
+	/**
+	 * Returns whether to normalize similarities (i.e. translate the database-specific score into {@link Similarity}).
+	 *
+	 * @return
+	 */
+	public boolean normalizeSimilarity() {
+		return doWithScore(it -> true, Similarity.class::isInstance, () -> false);
+	}
+
+	/**
+	 * Returns the {@link ScoringFunction}.
+	 *
+	 * @return
+	 */
+	public <T> T doWithScore(Function<Score, T> function, Predicate<Score> scoreFilter, Supplier<T> defaultValue) {
+
+		Score score = getScore();
+		if (score != null && scoreFilter.test(score)) {
+			return function.apply(score);
+		}
+
+		JpaParameters parameters = getParameters();
+		if (parameters.hasScoreRangeParameter()) {
+
+			Range<Score> range = getScoreRange();
+
+			if (range != null && range.getLowerBound().isBounded()
+					&& scoreFilter.test(range.getLowerBound().getValue().get())) {
+				return function.apply(range.getUpperBound().getValue().get());
+			}
+
+			if (range != null && range.getUpperBound().isBounded()
+					&& scoreFilter.test(range.getUpperBound().getValue().get())) {
+				return function.apply(range.getUpperBound().getValue().get());
+			}
+
+		}
+
+		return defaultValue.get();
+	}
+
 }