graphql.execution.instrumentation.dataloader

Class DataLoaderDispatcherInstrumentation

java.lang.Object

graphql.execution.instrumentation.NoOpInstrumentation

graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentation

All Implemented Interfaces:

Instrumentation

public class DataLoaderDispatcherInstrumentation
extends NoOpInstrumentation

This graphql Instrumentation will dispatch all the contained DataLoaders when each level of the graphql query is executed. This allows you to use DataLoaders in your DataFetchers to optimal loading of data.

See Also:

DataLoader, DataLoaderRegistry

Nested Class Summary

Nested classes/interfaces inherited from class graphql.execution.instrumentation.NoOpInstrumentation

NoOpInstrumentation.NoOpInstrumentationContext<T>

Field Summary

Fields inherited from class graphql.execution.instrumentation.NoOpInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
DataLoaderDispatcherInstrumentation(org.dataloader.DataLoaderRegistry dataLoaderRegistry) You pass in a registry of N data loaders which will be dispatched as each level of the query executes.
DataLoaderDispatcherInstrumentation(org.dataloader.DataLoaderRegistry dataLoaderRegistry, DataLoaderDispatcherInstrumentationOptions options) You pass in a registry of N data loaders which will be dispatched as each level of the query executes.

Method Summary

Modifier and Type	Method and Description
InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>	beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters) This is called just before the complete field list is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<ExecutionResult>	beginDataFetch(InstrumentationDataFetchParameters parameters) This is called just before the data fetching stage is started, waits for all data to be completed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>	beginDataFetchDispatch(InstrumentationDataFetchParameters parameters) This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion.
InstrumentationContext<java.util.Map<java.lang.String,java.util.List<Field>>>	beginFields(InstrumentationExecutionStrategyParameters parameters) This is called just before a selection set of fields is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationState	createState() This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state
DataFetcher<?>	instrumentDataFetcher(DataFetcher<?> dataFetcher, InstrumentationFieldFetchParameters parameters) This is called to instrument a DataFetcher just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches.
java.util.concurrent.CompletableFuture<ExecutionResult>	instrumentExecutionResult(ExecutionResult executionResult, InstrumentationExecutionParameters parameters) This is called to allow instrumentation to instrument the execution result in some way

Methods inherited from class graphql.execution.instrumentation.NoOpInstrumentation

beginCompleteField, beginExecution, beginExecutionStrategy, beginField, beginFieldFetch, beginParse, beginValidation, instrumentExecutionContext, instrumentSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.execution.instrumentation.Instrumentation

instrumentExecutionInput

Constructor Detail

DataLoaderDispatcherInstrumentation

public DataLoaderDispatcherInstrumentation(org.dataloader.DataLoaderRegistry dataLoaderRegistry)

You pass in a registry of N data loaders which will be dispatched as each level of the query executes.

Parameters:

dataLoaderRegistry - the registry of data loaders that will be dispatched

DataLoaderDispatcherInstrumentation

public DataLoaderDispatcherInstrumentation(org.dataloader.DataLoaderRegistry dataLoaderRegistry,
                                           DataLoaderDispatcherInstrumentationOptions options)

You pass in a registry of N data loaders which will be dispatched as each level of the query executes.

Parameters:

dataLoaderRegistry - the registry of data loaders that will be dispatched

options - the options to control the behaviour

Method Detail

createState

public InstrumentationState createState()

Description copied from interface: Instrumentation

This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state

Specified by:

createState in interface Instrumentation

Overrides:

createState in class NoOpInstrumentation

Returns:

a state object that is passed to each method

instrumentDataFetcher

public DataFetcher<?> instrumentDataFetcher(DataFetcher<?> dataFetcher,
                                            InstrumentationFieldFetchParameters parameters)

Description copied from interface: Instrumentation

This is called to instrument a DataFetcher just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches. Note the same data fetcher instance maybe presented to you many times and that data fetcher implementations widely vary.

Specified by:

instrumentDataFetcher in interface Instrumentation

Overrides:

instrumentDataFetcher in class NoOpInstrumentation

Parameters:

dataFetcher - the data fetcher about to be used

parameters - the parameters describing the field to be fetched

Returns:

a non null instrumented DataFetcher, the default is to return to the same object

beginDataFetchDispatch

public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginDataFetchDispatch(InstrumentationDataFetchParameters parameters)

Description copied from interface: Instrumentation

This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion. This is different to Instrumentation.beginDataFetch(graphql.execution.instrumentation.parameters.InstrumentationDataFetchParameters) in that this step does not wait for the values to be completed, only dispatched for completion.

Specified by:

beginDataFetchDispatch in interface Instrumentation

Overrides:

beginDataFetchDispatch in class NoOpInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginDataFetch

public InstrumentationContext<ExecutionResult> beginDataFetch(InstrumentationDataFetchParameters parameters)

Description copied from interface: Instrumentation

This is called just before the data fetching stage is started, waits for all data to be completed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

Specified by:

beginDataFetch in interface Instrumentation

Overrides:

beginDataFetch in class NoOpInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginFields

public InstrumentationContext<java.util.Map<java.lang.String,java.util.List<Field>>> beginFields(InstrumentationExecutionStrategyParameters parameters)

Description copied from interface: Instrumentation

This is called just before a selection set of fields is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

Specified by:

beginFields in interface Instrumentation

Overrides:

beginFields in class NoOpInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginCompleteFieldList

public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters)

Description copied from interface: Instrumentation

This is called just before the complete field list is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

Specified by:

beginCompleteFieldList in interface Instrumentation

Overrides:

beginCompleteFieldList in class NoOpInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

instrumentExecutionResult

public java.util.concurrent.CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
                                                                                         InstrumentationExecutionParameters parameters)

Description copied from interface: Instrumentation

This is called to allow instrumentation to instrument the execution result in some way

Specified by:

instrumentExecutionResult in interface Instrumentation

Overrides:

instrumentExecutionResult in class NoOpInstrumentation

Parameters:

executionResult - CompletableFuture of the result to instrument

parameters - the parameters to this step

Returns:

a new execution result completable future