Representation of a GraphQL schema
A Schema is a collection of type and directive declarations.
Attributes
- Companion
- object
- Source
- schema.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
The types defined by this Schema prior to any extensions.
The directives defined by this Schema.
Attributes
- Source
- schema.scala
The schema extensions defined by this Schema
The type extensions defined by this Schema
Concrete methods
Attributes
- Source
- schema.scala
The default type of a GraphQL schema
The default type of a GraphQL schema
Unless a type named "Schema" is explicitly defined as part of this Schema a definition of the form,
type Schema { query: Query! mutation: Mutation subscription: Subscription }
is used.
Attributes
- Source
- schema.scala
Look up by name a type defined in this Schema.
Look up by name a type defined in this Schema.
Yields the type, if defined, None otherwise.
Attributes
- Source
- schema.scala
Are the supplied alternatives exhaustive for tp
Yields the ObjectType implementations of the given InterfaceType.
True if the supplied type is one of the Query, Mutation or Subscription root types, false otherwise
True if the supplied type is one of the Query, Mutation or Subscription root types, false otherwise
Attributes
- Source
- schema.scala
The type of mutations defined by this Schema
The type of queries defined by this Schema
A reference by name to a type defined by this Schema.
A reference by name to a type defined by this Schema.
This method should be used to obtain the references to types required for the definitions of mappings and the bodies of select elaborators because TypeRefs can be meaningfully compared for equality using ==.
Attributes
- Throws
-
java.lang.IllegalArgumentException if the type is not defined in this schema
- Source
- schema.scala
The type of subscriptions defined by this Schema
Returns all subtypes of tpe
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
- Source
- schema.scala
A reference by name to a type defined by this Schema.
A reference by name to a type defined by this Schema.
TypeRefs refer to types defined in this schema by name and hence can be used as part of mutually recursive type definitions.
Note that this method should be used with caution as it does not check that the type is defined in this schema.
Attributes
- Source
- schema.scala
A reference to a type defined by this Schema.
A reference to a type defined by this Schema.
The primary use of this method is to obtain a TypeRef corresponding to a type defined in this schema for use in builtin equality comparisons with other TypeRefs.
Note that this method should be used with caution as it does not check that the type is defined in this schema.
Attributes
- Source
- schema.scala
Concrete fields
The schema type.
The schema type.
Either the explicitly defined type named "Schema" or the default schema type if not defined.
Attributes
- Source
- schema.scala
The types defined by this Schema with any extensions applied.