graphql.schema

Interface DataFetchingEnvironment

All Known Implementing Classes:

DataFetchingEnvironmentImpl

@PublicApi
public interface DataFetchingEnvironment

A DataFetchingEnvironment instance of passed to a DataFetcher as a execution context and its the place where you can find out information to help you resolve a data value given a graphql field input

Method Summary

Modifier and Type	Method and Description
boolean	containsArgument(java.lang.String name) Returns true of the named argument is present
<T> T	getArgument(java.lang.String name) Returns the named argument
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
<T> T	getContext() Returns a context argument that is set up when the GraphQL.execute(java.lang.String) method is invoked.
<K,V> org.dataloader.DataLoader<K,V>	getDataLoader(java.lang.String dataLoaderName) This allows you to retrieve a named dataloader from the underlying DataLoaderRegistry
ExecutionContext	getExecutionContext()
ExecutionId	getExecutionId()
ExecutionStepInfo	getExecutionStepInfo()
Field	getField()
GraphQLFieldDefinition	getFieldDefinition()
java.util.List<Field>	getFields() It can happen that a query has overlapping fields which are are querying the same data.
GraphQLOutputType	getFieldType()
java.util.Map<java.lang.String,FragmentDefinition>	getFragmentsByName()
GraphQLSchema	getGraphQLSchema()
GraphQLType	getParentType()
<T> T	getRoot() This is the source object for the root query.
DataFetchingFieldSelectionSet	getSelectionSet()
<T> T	getSource() This is the value of the current object to be queried.

Method Detail

getSource

<T> T getSource()

This is the value of the current object to be queried. Or to put it differently: it is the value of the parent field.

For the root query, it is equal to {getRoot()

Type Parameters:

T - you decide what type it is

Returns:

can be null for the root query, otherwise it is never null

getArguments

java.util.Map<java.lang.String,java.lang.Object> getArguments()

Returns:

the arguments that have been passed in via the graphql query

containsArgument

boolean containsArgument(java.lang.String name)

Returns true of the named argument is present

Parameters:

name - the name of the argument

Returns:

true of the named argument is present

getArgument

<T> T getArgument(java.lang.String name)

Returns the named argument

Type Parameters:

T - you decide what type it is

Parameters:

name - the name of the argument

Returns:

the named argument or null if its not [present

getContext

<T> T getContext()

Returns a context argument that is set up when the GraphQL.execute(java.lang.String) method is invoked.

This is a info object which is provided to all DataFetcher, but never used by graphql-java itself.

Type Parameters:

T - you decide what type it is

Returns:

can be null

getRoot

<T> T getRoot()

This is the source object for the root query.

Type Parameters:

T - you decide what type it is

Returns:

can be null

getFieldDefinition

GraphQLFieldDefinition getFieldDefinition()

Returns:

the definition of the current field

getFields

java.util.List<Field> getFields()

It can happen that a query has overlapping fields which are are querying the same data. If this is the case they get merged together and fetched only once, but this method returns all of the Fields from the query. Most of the time you probably want to use getField(). Example query with more than one Field returned:

 

      query Foo {
          bar
          ...BarFragment
      }

      fragment BarFragment on Query {
          bar
      }
 
 

Returns:

the list of fields currently queried

getField

Field getField()

Returns:

returns the field which is currently queried. See also getFields()

getFieldType

GraphQLOutputType getFieldType()

Returns:

graphql type of the current field

getExecutionStepInfo

ExecutionStepInfo getExecutionStepInfo()

Returns:

the field ExecutionStepInfo for the current data fetch operation

getParentType

GraphQLType getParentType()

Returns:

the type of the parent of the current field

getGraphQLSchema

GraphQLSchema getGraphQLSchema()

Returns:

the underlying graphql schema

getFragmentsByName

java.util.Map<java.lang.String,FragmentDefinition> getFragmentsByName()

Returns:

the FragmentDefinition map for the current data fetch operation

getExecutionId

ExecutionId getExecutionId()

Returns:

the ExecutionId for the current data fetch operation

getSelectionSet

DataFetchingFieldSelectionSet getSelectionSet()

Returns:

the DataFetchingFieldSelectionSet for the current data fetch operation

getExecutionContext

ExecutionContext getExecutionContext()

Returns:

the current ExecutionContext. It gives access to the overall schema and other things related to the overall execution of the current request.

getDataLoader

<K,V> org.dataloader.DataLoader<K,V> getDataLoader(java.lang.String dataLoaderName)

This allows you to retrieve a named dataloader from the underlying DataLoaderRegistry

Type Parameters:

K - the key type

V - the value type

Parameters:

dataLoaderName - the name of the data loader to fetch

Returns:

the named data loader or null

See Also:

ExecutionContext.getDataLoaderRegistry(), DataLoaderRegistry.getDataLoader(String)