This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Data Relational 3.3.4!spring-doc.cn

This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Data Relational 3.3.4!spring-doc.cn

Supported Query Return Types

The following table lists the return types generally supported by Spring Data repositories. However, consult the store-specific documentation for the exact list of supported return types, because some types listed here might not be supported in a particular store.spring-doc.cn

Geospatial types (such as GeoResult, GeoResults, and GeoPage) are available only for data stores that support geospatial queries. Some store modules may define their own result wrapper types.
Table 1. Query return types
Return type Description

voidspring-doc.cn

Denotes no return value.spring-doc.cn

Primitivesspring-doc.cn

Java primitives.spring-doc.cn

Wrapper typesspring-doc.cn

Java wrapper types.spring-doc.cn

Tspring-doc.cn

A unique entity. Expects the query method to return one result at most. If no result is found, null is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Iterator<T>spring-doc.cn

An Iterator.spring-doc.cn

Collection<T>spring-doc.cn

A Collection.spring-doc.cn

List<T>spring-doc.cn

A List.spring-doc.cn

Optional<T>spring-doc.cn

A Java 8 or Guava Optional. Expects the query method to return one result at most. If no result is found, Optional.empty() or Optional.absent() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Option<T>spring-doc.cn

Either a Scala or Vavr Option type. Semantically the same behavior as Java 8’s Optional, described earlier.spring-doc.cn

Stream<T>spring-doc.cn

A Java 8 Stream.spring-doc.cn

Streamable<T>spring-doc.cn

A convenience extension of Iterable that directly exposes methods to stream, map and filter results, concatenate them etc.spring-doc.cn

Types that implement Streamable and take a Streamable constructor or factory method argumentspring-doc.cn

Types that expose a constructor or ….of(…)/….valueOf(…) factory method taking a Streamable as argument. See Returning Custom Streamable Wrapper Types for details.spring-doc.cn

Vavr Seq, List, Map, Setspring-doc.cn

Vavr collection types. See Support for Vavr Collections for details.spring-doc.cn

Future<T>spring-doc.cn

A Future. Expects a method to be annotated with @Async and requires Spring’s asynchronous method execution capability to be enabled.spring-doc.cn

CompletableFuture<T>spring-doc.cn

A Java 8 CompletableFuture. Expects a method to be annotated with @Async and requires Spring’s asynchronous method execution capability to be enabled.spring-doc.cn

Slice<T>spring-doc.cn

A sized chunk of data with an indication of whether there is more data available. Requires a Pageable method parameter.spring-doc.cn

Page<T>spring-doc.cn

A Slice with additional information, such as the total number of results. Requires a Pageable method parameter.spring-doc.cn

Window<T>spring-doc.cn

A Window of results obtained from a scroll query. Provides ScrollPosition to issue the next scroll query. Requires a ScrollPosition method parameter.spring-doc.cn

GeoResult<T>spring-doc.cn

A result entry with additional information, such as the distance to a reference location.spring-doc.cn

GeoResults<T>spring-doc.cn

A list of GeoResult<T> with additional information, such as the average distance to a reference location.spring-doc.cn

GeoPage<T>spring-doc.cn

A Page with GeoResult<T>, such as the average distance to a reference location.spring-doc.cn

Mono<T>spring-doc.cn

A Project Reactor Mono emitting zero or one element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Flux<T>spring-doc.cn

A Project Reactor Flux emitting zero, one, or many elements using reactive repositories. Queries returning Flux can emit also an infinite number of elements.spring-doc.cn

Single<T>spring-doc.cn

A RxJava Single emitting a single element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Maybe<T>spring-doc.cn

A RxJava Maybe emitting zero or one element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Flowable<T>spring-doc.cn

A RxJava Flowable emitting zero, one, or many elements using reactive repositories. Queries returning Flowable can emit also an infinite number of elements.spring-doc.cn
Geospatial types (such as GeoResult, GeoResults, and GeoPage) are available only for data stores that support geospatial queries. Some store modules may define their own result wrapper types.
Table 1. Query return types
Return type Description

voidspring-doc.cn

Denotes no return value.spring-doc.cn

Primitivesspring-doc.cn

Java primitives.spring-doc.cn

Wrapper typesspring-doc.cn

Java wrapper types.spring-doc.cn

Tspring-doc.cn

A unique entity. Expects the query method to return one result at most. If no result is found, null is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Iterator<T>spring-doc.cn

An Iterator.spring-doc.cn

Collection<T>spring-doc.cn

A Collection.spring-doc.cn

List<T>spring-doc.cn

A List.spring-doc.cn

Optional<T>spring-doc.cn

A Java 8 or Guava Optional. Expects the query method to return one result at most. If no result is found, Optional.empty() or Optional.absent() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Option<T>spring-doc.cn

Either a Scala or Vavr Option type. Semantically the same behavior as Java 8’s Optional, described earlier.spring-doc.cn

Stream<T>spring-doc.cn

A Java 8 Stream.spring-doc.cn

Streamable<T>spring-doc.cn

A convenience extension of Iterable that directly exposes methods to stream, map and filter results, concatenate them etc.spring-doc.cn

Types that implement Streamable and take a Streamable constructor or factory method argumentspring-doc.cn

Types that expose a constructor or ….of(…)/….valueOf(…) factory method taking a Streamable as argument. See Returning Custom Streamable Wrapper Types for details.spring-doc.cn

Vavr Seq, List, Map, Setspring-doc.cn

Vavr collection types. See Support for Vavr Collections for details.spring-doc.cn

Future<T>spring-doc.cn

A Future. Expects a method to be annotated with @Async and requires Spring’s asynchronous method execution capability to be enabled.spring-doc.cn

CompletableFuture<T>spring-doc.cn

A Java 8 CompletableFuture. Expects a method to be annotated with @Async and requires Spring’s asynchronous method execution capability to be enabled.spring-doc.cn

Slice<T>spring-doc.cn

A sized chunk of data with an indication of whether there is more data available. Requires a Pageable method parameter.spring-doc.cn

Page<T>spring-doc.cn

A Slice with additional information, such as the total number of results. Requires a Pageable method parameter.spring-doc.cn

Window<T>spring-doc.cn

A Window of results obtained from a scroll query. Provides ScrollPosition to issue the next scroll query. Requires a ScrollPosition method parameter.spring-doc.cn

GeoResult<T>spring-doc.cn

A result entry with additional information, such as the distance to a reference location.spring-doc.cn

GeoResults<T>spring-doc.cn

A list of GeoResult<T> with additional information, such as the average distance to a reference location.spring-doc.cn

GeoPage<T>spring-doc.cn

A Page with GeoResult<T>, such as the average distance to a reference location.spring-doc.cn

Mono<T>spring-doc.cn

A Project Reactor Mono emitting zero or one element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Flux<T>spring-doc.cn

A Project Reactor Flux emitting zero, one, or many elements using reactive repositories. Queries returning Flux can emit also an infinite number of elements.spring-doc.cn

Single<T>spring-doc.cn

A RxJava Single emitting a single element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Maybe<T>spring-doc.cn

A RxJava Maybe emitting zero or one element using reactive repositories. Expects the query method to return one result at most. If no result is found, Mono.empty() is returned. More than one result triggers an IncorrectResultSizeDataAccessException.spring-doc.cn

Flowable<T>spring-doc.cn

A RxJava Flowable emitting zero, one, or many elements using reactive repositories. Queries returning Flowable can emit also an infinite number of elements.spring-doc.cn