Schema

class Schema(definitions: List<GQLDefinition>)

A wrapper around a schema GQLDocument that:

always contain builtin types contrary to introspection that will not contain directives and SDL that will not contain any builtin definitions
always has a schema definition
has type extensions merged
has some helper functions to retrieve a type by name and/or possible types

Parameters

definitions

a list of validated and merged definitions

Constructors

Schema

fun Schema(definitions: List<GQLDefinition>)

a list of validated and merged definitions

Types

Companion

object Companion

Functions

hasTypeWithTypePolicy

fun hasTypeWithTypePolicy(): Boolean

Returns whether the typePolicy directive is present on at least one object in the schema

implementedTypes

fun implementedTypes(name: String): Set<String>

keyFields

fun keyFields(name: String): Set<String>

Returns the key fields for the given typeIf this type has one or multiple @TYPE_POLICY annotation(s), they are used, else it recurses in implemented interfaces until it finds some.

possibleTypes

fun possibleTypes(typeDefinition: GQLTypeDefinition): Set<String>

fun possibleTypes(name: String): Set<String>

toGQLDocument

fun toGQLDocument(): GQLDocument

typeDefinition

fun typeDefinition(name: String): GQLTypeDefinition