graphql

Class GraphQL

java.lang.Object

graphql.GraphQL

@PublicApi
public class GraphQL
extends java.lang.Object

This class is where all graphql-java query execution begins. It combines the objects that are needed to make a successful graphql query, with the most important being the schema and the execution strategy Building this object is very cheap and can be done on each execution if necessary. Building the schema is often not as cheap, especially if its parsed from graphql IDL schema format via SchemaParser. The data for a query is returned via ExecutionResult.getData() and any errors encountered as placed in ExecutionResult.getErrors().

Runtime Exceptions

Runtime exceptions can be thrown by the graphql engine if certain situations are encountered. These are not errors in execution but rather totally unacceptable conditions in which to execute a graphql query.

• CoercingSerializeException - is thrown when a value cannot be serialised by a Scalar type, for example a String value being coerced as an Int.
• UnresolvedTypeException - is thrown if a TypeResolver fails to provide a concrete object type given a interface or union type.
• InvalidSchemaException - is thrown if the schema is not valid when built via GraphQLSchema.Builder.build()
• GraphQLException - is thrown as a general purpose runtime exception, for example if the code cant access a named field when examining a POJO.
• AssertException - is thrown as a low level code assertion exception for truly unexpected code conditions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQL.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFERRED_RESULTS When @defer directives are used, this is the extension key name used to contain the Publisher of deferred results

Constructor Summary

Constructors

Constructor and Description
GraphQL(GraphQLSchema graphQLSchema) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

Method Summary

Modifier and Type	Method and Description
ExecutionResult	execute(ExecutionInput.Builder executionInputBuilder) Executes the graphql query using the provided input object builder
ExecutionResult	execute(ExecutionInput executionInput) Executes the graphql query using the provided input object
ExecutionResult	execute(java.lang.String query) Executes the specified graphql query/mutation/subscription
ExecutionResult	execute(java.lang.String query, java.lang.Object context) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.Object context, java.util.Map<java.lang.String,java.lang.Object> variables) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.String operationName, java.lang.Object context) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.String operationName, java.lang.Object context, java.util.Map<java.lang.String,java.lang.Object> variables) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction) Executes the graphql query using calling the builder function and giving it a new builder.
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(ExecutionInput.Builder executionInputBuilder) Executes the graphql query using the provided input object builder
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(ExecutionInput executionInput) Executes the graphql query using the provided input object
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction) Executes the graphql query using the provided input object builder
static GraphQL.Builder	newGraphQL(GraphQLSchema graphQLSchema) Helps you build a GraphQL object ready to execute queries
GraphQL	transform(java.util.function.Consumer<GraphQL.Builder> builderConsumer) This helps you transform the current GraphQL object into another one by starting a builder with all the current values and allows you to transform it how you want.

Methods inherited from class java.lang.Object

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

Field Detail

DEFERRED_RESULTS

public static final java.lang.String DEFERRED_RESULTS

When @defer directives are used, this is the extension key name used to contain the Publisher of deferred results

See Also:

Constant Field Values

Constructor Detail

GraphQL

@Deprecated
public GraphQL(GraphQLSchema graphQLSchema)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

GraphQL

@Deprecated
public GraphQL(GraphQLSchema graphQLSchema,
                           ExecutionStrategy queryStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

GraphQL

@Deprecated
public GraphQL(GraphQLSchema graphQLSchema,
                           ExecutionStrategy queryStrategy,
                           ExecutionStrategy mutationStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

mutationStrategy - the mutation execution strategy to use

GraphQL

@Deprecated
public GraphQL(GraphQLSchema graphQLSchema,
                           ExecutionStrategy queryStrategy,
                           ExecutionStrategy mutationStrategy,
                           ExecutionStrategy subscriptionStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

mutationStrategy - the mutation execution strategy to use

subscriptionStrategy - the subscription execution strategy to use

Method Detail

newGraphQL

public static GraphQL.Builder newGraphQL(GraphQLSchema graphQLSchema)

Helps you build a GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

Returns:

a builder of GraphQL objects

transform

public GraphQL transform(java.util.function.Consumer<GraphQL.Builder> builderConsumer)

This helps you transform the current GraphQL object into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new GraphQL object based on calling build on that builder

execute

public ExecutionResult execute(java.lang.String query)

Executes the specified graphql query/mutation/subscription

Parameters:

query - the query/mutation/subscription

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.Object context)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

context - custom object provided to each DataFetcher

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.String operationName,
                                           java.lang.Object context)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

operationName - the name of the operation to execute

context - custom object provided to each DataFetcher

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.Object context,
                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

context - custom object provided to each DataFetcher

variables - variable values uses as argument

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.String operationName,
                                           java.lang.Object context,
                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

operationName - name of the operation to execute

context - custom object provided to each DataFetcher

variables - variable values uses as argument

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(ExecutionInput.Builder executionInputBuilder)

Executes the graphql query using the provided input object builder

Parameters:

executionInputBuilder - ExecutionInput.Builder

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction)

Executes the graphql query using calling the builder function and giving it a new builder.

This allows a lambda style like :

 
    ExecutionResult result = graphql.execute(input -> input.query("{hello}").root(startingObj).context(contextObj));
 
 

Parameters:

builderFunction - a function that is given a ExecutionInput.Builder

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(ExecutionInput executionInput)

Executes the graphql query using the provided input object

Parameters:

executionInput - ExecutionInput

Returns:

an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(ExecutionInput.Builder executionInputBuilder)

Executes the graphql query using the provided input object builder

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

Parameters:

executionInputBuilder - ExecutionInput.Builder

Returns:

a promise to an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction)

Executes the graphql query using the provided input object builder

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

This allows a lambda style like :

 
    ExecutionResult result = graphql.execute(input -> input.query("{hello}").root(startingObj).context(contextObj));
 
 

Parameters:

builderFunction - a function that is given a ExecutionInput.Builder

Returns:

a promise to an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(ExecutionInput executionInput)

Executes the graphql query using the provided input object

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

Parameters:

executionInput - ExecutionInput

Returns:

a promise to an ExecutionResult which can include errors