Package graphql.schema.idl

Class SchemaGenerator

java.lang.Object

graphql.schema.idl.SchemaGenerator

@PublicApi
public class SchemaGenerator
extends java.lang.Object

This can generate a working runtime schema from a type registry and runtime wiring

The generator uses the RuntimeWiring to insert code that runs behind the schema elements such as DataFetchers, TypeResolvers and scalar Coercing.

The order of DataFetcher resolution is as follows:

1. If the WiringFactory provides the DataFetcherFactory for a field in its parent type then that is used
2. If the WiringFactory provides the DataFetcher for a field in its parent type then that is used
3. If the RuntimeWiring provides the DataFetcher for a field in its parent type, then that is used
4. If the RuntimeWiring provides a default DataFetcher for a fields parent type, then that is used
5. If the WiringFactory provides a default DataFetcherFactory for any element then that is used
6. If the GraphQLCodeRegistry.Builder.getDefaultDataFetcherFactory() provides a DataFetcherFactory for a value then that is used
7. Finally a PropertyDataFetcher is used as a last resort for the field

The order of TypeResolver resolution is as follows:

1. If the WiringFactory provides a TypeResolver then that is used
2. If the TypeRuntimeWiring provides a TypeResolver then that is used

The order of GraphQLScalarType resolution is as follows:

1. If the WiringFactory provides a GraphQLScalarType then that is used
2. Otherwise RuntimeWiring.getScalars() is used

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaGenerator.Options	These options control how the schema generation works

Constructor Summary

Constructors

Constructor	Description
SchemaGenerator()

Method Summary

Modifier and Type	Method	Description
static GraphQLSchema	createdMockedSchema(java.lang.String sdl)	Created a schema from the SDL that is has a mocked runtime.
GraphQLSchema	makeExecutableSchema(SchemaGenerator.Options options, TypeDefinitionRegistry typeRegistry, RuntimeWiring wiring)	This will take a TypeDefinitionRegistry and a RuntimeWiring and put them together to create a executable schema controlled by the provided options.
GraphQLSchema	makeExecutableSchema(TypeDefinitionRegistry typeRegistry, RuntimeWiring wiring)	This will take a TypeDefinitionRegistry and a RuntimeWiring and put them together to create a executable schema

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaGenerator

public SchemaGenerator()

Method Detail

createdMockedSchema

public static GraphQLSchema createdMockedSchema(java.lang.String sdl)

Created a schema from the SDL that is has a mocked runtime.

Parameters:

sdl - the SDL to be mocked

Returns:

a schema with a mocked runtime

See Also:

RuntimeWiring.MOCKED_WIRING

makeExecutableSchema

public GraphQLSchema makeExecutableSchema(TypeDefinitionRegistry typeRegistry,
                                          RuntimeWiring wiring)
                                   throws SchemaProblem

This will take a TypeDefinitionRegistry and a RuntimeWiring and put them together to create a executable schema

Parameters:

typeRegistry - this can be obtained via SchemaParser.parse(String)

wiring - this can be built using RuntimeWiring.newRuntimeWiring()

Returns:

an executable schema

Throws:

SchemaProblem - if there are problems in assembling a schema such as missing type resolvers or no operations defined

makeExecutableSchema

public GraphQLSchema makeExecutableSchema(SchemaGenerator.Options options,
                                          TypeDefinitionRegistry typeRegistry,
                                          RuntimeWiring wiring)
                                   throws SchemaProblem

This will take a TypeDefinitionRegistry and a RuntimeWiring and put them together to create a executable schema controlled by the provided options.

Parameters:

options - the controlling options

typeRegistry - this can be obtained via SchemaParser.parse(String)

wiring - this can be built using RuntimeWiring.newRuntimeWiring()

Returns:

an executable schema

Throws:

SchemaProblem - if there are problems in assembling a schema such as missing type resolvers or no operations defined