graphql.execution.batched

Class BatchedExecutionStrategy

java.lang.Object

graphql.execution.ExecutionStrategy

graphql.execution.batched.BatchedExecutionStrategy

@PublicApi
public class BatchedExecutionStrategy
extends ExecutionStrategy

Execution Strategy that minimizes calls to the data fetcher when used in conjunction with DataFetchers that have DataFetcher.get(DataFetchingEnvironment) methods annotated with Batched. See the javadoc comment on Batched for a more detailed description of batched data fetchers.

The strategy runs a BFS over terms of the query and passes a list of all the relevant sources to the batched data fetcher.

Normal DataFetchers can be used, however they will not see benefits of batching as they expect a single source object at a time.

Field Summary

Fields inherited from class graphql.execution.ExecutionStrategy

dataFetcherExceptionHandler, fieldCollector, valuesResolver

Constructor Summary

Constructors

Constructor and Description
BatchedExecutionStrategy()
BatchedExecutionStrategy(DataFetcherExceptionHandler dataFetcherExceptionHandler)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<ExecutionResult>	execute(ExecutionContext executionContext, ExecutionStrategyParameters parameters) This is the entry point to an execution strategy.

Methods inherited from class graphql.execution.ExecutionStrategy

assertNonNullFieldPrecondition, assertNonNullFieldPrecondition, completeField, completeValue, completeValueForEnum, completeValueForList, completeValueForScalar, fetchField, fieldTypeInfo, getFieldDef, getFieldDef, handleNonNullException, resolveField, resolveTypeForInterface, resolveTypeForUnion

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchedExecutionStrategy

public BatchedExecutionStrategy()

BatchedExecutionStrategy

public BatchedExecutionStrategy(DataFetcherExceptionHandler dataFetcherExceptionHandler)

Method Detail

execute

public java.util.concurrent.CompletableFuture<ExecutionResult> execute(ExecutionContext executionContext,
                                                                       ExecutionStrategyParameters parameters)

Description copied from class: ExecutionStrategy

This is the entry point to an execution strategy. It will be passed the fields to execute and get values for.

Specified by:

execute in class ExecutionStrategy

Parameters:

executionContext - contains the top level execution parameters

parameters - contains the parameters holding the fields to be executed and source object

Returns:

an ExecutionResult