Language.GraphQL.Type.Schema

This module provides a representation of a GraphQL Schema in addition to functions for defining and manipulating schemas.

Documentation

schema

Arguments

:: forall m. ObjectType m

Query type.

-> Maybe (ObjectType m)

Mutation type.

-> Maybe (ObjectType m)

Subscription type.

-> Directives

Directive definitions.

-> Schema m

Schema.

Schema constructor.

Note: When the schema is constructed, by default only the types that are reachable by traversing the root types are included, other types must be explicitly referenced using schemaWithTypes instead.

schemaWithTypes

Arguments

:: forall m. Maybe Text

Schema description

-> ObjectType m

Query type.

-> Maybe (ObjectType m)

Mutation type.

-> Maybe (ObjectType m)

Subscription type.

-> [Type m]

Additional types.

-> Directives

Directive definitions.

-> Schema m

Schema.

Constructs a complete schema, including user-defined types not referenced in the schema directly (for example interface implementations).

data Schema m

A Schema is created by supplying the root types of each type of operation, query and mutation (optional). A schema definition is then supplied to the validator and executor.

type Directives = HashMap Name Directive

Directive definitions.

data Directive

Directive definition.

Constructors

Directive (Maybe Text) [DirectiveLocation] Arguments

data Type m

These are all of the possible kinds of types.

Constructors

ScalarType ScalarType

EnumType EnumType

ObjectType (ObjectType m)

InputObjectType InputObjectType

InterfaceType (InterfaceType m)

UnionType (UnionType m)

Instances

Eq (Type m)

Defined in Language.GraphQL.Type.Internal

Methods

(==) :: Type m -> Type m -> Bool

(/=) :: Type m -> Type m -> Bool

description :: forall m. Schema m -> Maybe Text

Schema description.

query :: forall m. Schema m -> ObjectType m

Schema query type.

mutation :: forall m. Schema m -> Maybe (ObjectType m)

Schema mutation type.

subscription :: forall m. Schema m -> Maybe (ObjectType m)

Schema subscription type.

directives :: forall m. Schema m -> Directives

Schema directive definitions.

types :: forall m. Schema m -> HashMap Name (Type m)

Types referenced by the schema.

implementations :: forall m. Schema m -> HashMap Name [Type m]

Interface implementations.