grackle-core
0.18.0
API
Generated with
grackle-core/grackle/Schema

Schema

grackle.Schema
See theSchema companion object
trait Schema

Representation of a GraphQL schema

A Schema is a collection of type and directive declarations.

Attributes

Companion
object
Source
schema.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def baseTypes: List[NamedType]

The types defined by this Schema prior to any extensions.

The types defined by this Schema prior to any extensions.

Attributes

Source
schema.scala
def directives: List[DirectiveDef]

The directives defined by this Schema.

The directives defined by this Schema.

Attributes

Source
schema.scala
def pos: SourcePos

Attributes

Source
schema.scala
def schemaExtensions: List[SchemaExtension]

The schema extensions defined by this Schema

The schema extensions defined by this Schema

Attributes

Source
schema.scala
def typeExtensions: List[TypeExtension]

The type extensions defined by this Schema

The type extensions defined by this Schema

Attributes

Source
schema.scala

Concrete methods

def baseSchemaType: NamedType

Attributes

Source
schema.scala
def defaultSchemaType: NamedType

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
def definition(name: String): Option[NamedType]

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
def exhaustive(tp: Type, branches: List[Type]): Boolean

Are the supplied alternatives exhaustive for tp

Are the supplied alternatives exhaustive for tp

Attributes

Source
schema.scala
def isRootType(tpe: Type): Boolean

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
def mutationType: Option[NamedType]

The type of mutations defined by this Schema

The type of mutations defined by this Schema

Attributes

Source
schema.scala
def queryType: NamedType

The type of queries defined by this Schema

The type of queries defined by this Schema

Attributes

Source
schema.scala
def ref(tpnme: String): TypeRef

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.

Attributes

Source
schema.scala
def ref(tp: Type): Option[TypeRef]

Attributes

Source
schema.scala
def subscriptionType: Option[NamedType]

The type of subscriptions defined by this Schema

The type of subscriptions defined by this Schema

Attributes

Source
schema.scala
override def toString: String

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

Concrete fields

lazy val schemaType: NamedType

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
lazy val types: List[NamedType]

The types defined by this Schema with any extensions applied.

The types defined by this Schema with any extensions applied.

Attributes

Source
schema.scala
Generated with