Package org.springframework.graphql.data.query

Class QueryByExampleDataFetcher.ReactiveBuilder<T,R>

java.lang.Object

org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder<T,R>

Type Parameters:

T - domain type

R - result type

Enclosing class:

QueryByExampleDataFetcher<T>

public static class QueryByExampleDataFetcher.ReactiveBuilder<T,R>
extends Object

Builder for a reactive Query by Example-based DataFetcher. Note that builder instances are immutable and return a new instance of the builder when calling configuration methods.

Method Summary

Modifier and Type	Method	Description
QueryByExampleDataFetcher.ReactiveBuilder<T,R>	cursorStrategy(CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy)	Configure strategy for decoding a cursor from a paginated request.
QueryByExampleDataFetcher.ReactiveBuilder<T,R>	defaultScrollSubrange(int defaultCount, Function<Boolean,org.springframework.data.domain.ScrollPosition> defaultPosition)	Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.
QueryByExampleDataFetcher.ReactiveBuilder<T,R>	defaultScrollSubrange(ScrollSubrange defaultSubrange)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of defaultScrollSubrange(int, Function)
DataFetcher<reactor.core.publisher.Flux<R>>	many()	Build a DataFetcher to fetch many object instances.
<P> QueryByExampleDataFetcher.ReactiveBuilder<T,P>	projectAs(Class<P> projectionType)	Project results returned from the ReactiveQueryByExampleExecutor into the target projectionType.
DataFetcher<reactor.core.publisher.Mono<Iterable<R>>>	scrollable()	Build a DataFetcher that scrolls and returns Window.
DataFetcher<reactor.core.publisher.Mono<R>>	single()	Build a DataFetcher to fetch single object instances.
QueryByExampleDataFetcher.ReactiveBuilder<T,R>	sortBy(org.springframework.data.domain.Sort sort)	Apply a Sort order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

projectAs

public <P>
QueryByExampleDataFetcher.ReactiveBuilder<T,P> projectAs(Class<P> projectionType)

Project results returned from the ReactiveQueryByExampleExecutor into the target projectionType. Projection types can be either interfaces with property getters to expose or regular classes outside the entity type hierarchy for DTO projections.

Parameters:

projectionType - projection type

Returns:

a new QueryByExampleDataFetcher.ReactiveBuilder instance with all previously configured options and projectionType applied

cursorStrategy

public QueryByExampleDataFetcher.ReactiveBuilder<T,R> cursorStrategy(@Nullable
 CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy)

Configure strategy for decoding a cursor from a paginated request.

By default, this is ScrollPositionCursorStrategy with CursorEncoder.base64() encoding.

Parameters:

cursorStrategy - the strategy to use

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and Sort applied

Since:

1.2.0

defaultScrollSubrange

public QueryByExampleDataFetcher.ReactiveBuilder<T,R> defaultScrollSubrange(int defaultCount,
 Function<Boolean,org.springframework.data.domain.ScrollPosition> defaultPosition)

Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.

For offset scrolling, use ScrollPosition.offset() to scroll from the beginning. Currently, it is not possible to go back from the end.

For keyset scrolling, use ScrollPosition.keyset() to scroll from the beginning, or KeysetScrollPosition.reverse() the same to go back from the end.

By default a count of 20 and ScrollPosition.offset() are used.

Since:

1.2.5

defaultScrollSubrange

@Deprecated(since="1.2.5",
            forRemoval=true)
public QueryByExampleDataFetcher.ReactiveBuilder<T,R> defaultScrollSubrange(@Nullable
 ScrollSubrange defaultSubrange)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of defaultScrollSubrange(int, Function)

Configure a ScrollSubrange to use when a paginated request does not specify a cursor and/or a count of items.

By default, this is ScrollPosition.offset() with a count of 20.

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and Sort applied

sortBy

public QueryByExampleDataFetcher.ReactiveBuilder<T,R> sortBy(org.springframework.data.domain.Sort sort)

Apply a Sort order.

Parameters:

sort - the default sort order

Returns:

a new QueryByExampleDataFetcher.ReactiveBuilder instance with all previously configured options and Sort applied

single

public DataFetcher<reactor.core.publisher.Mono<R>> single()

Build a DataFetcher to fetch single object instances.

many

public DataFetcher<reactor.core.publisher.Flux<R>> many()

Build a DataFetcher to fetch many object instances.

scrollable

public DataFetcher<reactor.core.publisher.Mono<Iterable<R>>> scrollable()

Build a DataFetcher that scrolls and returns Window.

Since:

1.2.0