graphql.execution.instrumentation.dataloader

Class DataLoaderDispatcherInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentation

All Implemented Interfaces:

Instrumentation

public class DataLoaderDispatcherInstrumentation
extends SimpleInstrumentation

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.

A DataLoaderDispatcherInstrumentation will be automatically added to the GraphQL instrumentation list if one is not present.

See Also:

DataLoader, DataLoaderRegistry

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimpleInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
DataLoaderDispatcherInstrumentation() Creates a DataLoaderDispatcherInstrumentation with the default options
DataLoaderDispatcherInstrumentation(DataLoaderDispatcherInstrumentationOptions options) Creates a DataLoaderDispatcherInstrumentation with the specified options

Method Summary

Modifier and Type	Method and Description
DeferredFieldInstrumentationContext	beginDeferredField(InstrumentationDeferredFieldParameters parameters) This is called just before a deferred field is resolved into a value.
InstrumentationContext<ExecutionResult>	beginExecuteOperation(InstrumentationExecuteOperationParameters parameters) This is called just before the execution of the query operation is started.
ExecutionStrategyInstrumentationContext	beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters) This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends down over the query.
InstrumentationContext<java.lang.Object>	beginFieldFetch(InstrumentationFieldFetchParameters parameters) This is called just before a field DataFetcher is invoked.
InstrumentationState	createState(InstrumentationCreateStateParameters parameters) 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.SimpleInstrumentation

beginExecution, beginField, beginFieldComplete, beginFieldListComplete, beginParse, beginValidation, createState, 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()

Creates a DataLoaderDispatcherInstrumentation with the default options

DataLoaderDispatcherInstrumentation

public DataLoaderDispatcherInstrumentation(DataLoaderDispatcherInstrumentationOptions options)

Creates a DataLoaderDispatcherInstrumentation with the specified options

Parameters:

options - the options to control the behaviour

Method Detail

createState

public InstrumentationState createState(InstrumentationCreateStateParameters parameters)

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

Parameters:

parameters - the parameters to this step

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 SimpleInstrumentation

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

beginExecuteOperation

public InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters)

Description copied from interface: Instrumentation

This is called just before the execution of the query operation is started.

Specified by:

beginExecuteOperation in interface Instrumentation

Overrides:

beginExecuteOperation in class SimpleInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

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

beginExecutionStrategy

public ExecutionStrategyInstrumentationContext beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)

Description copied from interface: Instrumentation

This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends down over the query.

Specified by:

beginExecutionStrategy in interface Instrumentation

Overrides:

beginExecutionStrategy in class SimpleInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

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

beginDeferredField

public DeferredFieldInstrumentationContext beginDeferredField(InstrumentationDeferredFieldParameters parameters)

Description copied from interface: Instrumentation

This is called just before a deferred field is resolved into a value.

Specified by:

beginDeferredField in interface Instrumentation

Overrides:

beginDeferredField in class SimpleInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

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

beginFieldFetch

public InstrumentationContext<java.lang.Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters)

Description copied from interface: Instrumentation

This is called just before a field DataFetcher is invoked.

Specified by:

beginFieldFetch in interface Instrumentation

Overrides:

beginFieldFetch in class SimpleInstrumentation

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 SimpleInstrumentation

Parameters:

executionResult - CompletableFuture of the result to instrument

parameters - the parameters to this step

Returns:

a new execution result completable future