apollo-ast/com.apollographql.apollo.ast/Schema

Schema

A wrapper around a schema GQLDocument that ensures the GQLDocument is valid and caches some extra information. In particular, Schema:

always contain builtin definitions (SDL can omit them)
always has a schema definition for easier lookup of root operation types
has all type system extensions merged
has some helper functions to retrieve a type by name and/or possible types
caches keyFields for easier lookup during codegen
remembers directivesMapping to keep track of renamed definitions
remembers directivesToStrip to keep track of client-only directives

Parameters

definitions

a list of validated and merged definitions

keyFields

a Map containing the key fields for each type

directivesMapping

a Map from the foreign schema name to the final name in the schema. Ignored directives are absent from the map. Example: "@kotlin_labs_nonnull" -> "@nonnull"

directivesToStrip

directives to strip because they are coming from a foreign schema Example: "kotlin_labs_nonnull"

Types

Companion

object Companion

Properties

directiveDefinitions

val directiveDefinitions: Map<String, GQLDirectiveDefinition>

errorAware

val errorAware: Boolean

generateDataBuilders

val generateDataBuilders: Boolean

mutationTypeDefinition

val mutationTypeDefinition: GQLTypeDefinition?

queryTypeDefinition

val queryTypeDefinition: GQLTypeDefinition

schemaDefinition

val schemaDefinition: GQLSchemaDefinition?

subscriptionTypeDefinition

val subscriptionTypeDefinition: GQLTypeDefinition?

typeDefinitions

val typeDefinitions: Map<String, GQLTypeDefinition>

Functions

implementedTypes

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

List all types (types, interfaces, unions) implemented by a given type (including itself)

isTypeASubTypeOf

fun isTypeASubTypeOf(type: String, superType: String): Boolean

isTypeASuperTypeOf

fun isTypeASuperTypeOf(type: String, subType: String): Boolean

keyFields

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

Get the key fields for an object, interface or union type.

originalDirectiveName

fun originalDirectiveName(name: String): String?

possibleTypes

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

returns all possible types:

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

rootTypeNameFor

fun rootTypeNameFor(operationType: String): String

rootTypeNameOrNullFor

fun rootTypeNameOrNullFor(operationType: String): String?

shouldStrip

fun shouldStrip(name: String): Boolean

return whether the given directive should be removed from operation documents before being sent to the server

superTypes

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

List all direct super types (interfaces, unions) implemented by a given object or interface type

toGQLDocument

fun toGQLDocument(): GQLDocument

toMap

fun toMap(): Map<String, Any>

Returns the Schema as a Map that can be easily serialized to Json

typeDefinition

fun typeDefinition(name: String): GQLTypeDefinition