Sangria
API
Generated with
Sangria/sangria/sangria.schema

sangria.schema

package sangria.schema

Types that describe a GraphQL schema.

In order to serve GraphQL, one needs to define a GraphQL schema built upon these types.

Attributes

Members list

Type members

Classlikes

sealed trait AbstractType extends Type, Named

Attributes

Supertypes
trait Named
trait Type
class Object
trait Matchable
class Any
Show all
Known subtypes
class InterfaceType[Ctx, Val]
class UnionType[Ctx]
trait Action[+Ctx, +Val]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait LeafAction[Ctx, Val]
trait StandardLeafAction[Ctx, Val]
class DeferredFutureValue[Ctx, Val]
class DeferredValue[Ctx, Val]
class FutureValue[Ctx, Val]
class MappedSequenceLeafAction[Ctx, Val, NewVal]
class PartialFutureValue[Ctx, Val]
class PartialValue[Ctx, Val]
class SequenceLeafAction[Ctx, Val]
class TryValue[Ctx, Val]
class Value[Ctx, Val]
class MappedUpdateCtx[Ctx, Val, NewVal]
trait ReduceAction[Ctx, Val]
class UpdateCtx[Ctx, Val]
Show all
object Action extends LowPrioActions

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Action.type
case class AdditionalDirectives[Ctx](additionalDirectives: Seq[Directive]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class AdditionalTypes[Ctx](additionalTypes: List[MaterializedType]) extends AstSchemaResolver[Ctx]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object AdditionalTypes

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class AnyFieldResolver[Ctx](resolve: PartialFunction[MatOrigin, Context[Ctx, _] => Action[Ctx, Any]]) extends AstSchemaResolver[Ctx]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object AnyFieldResolver

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Args(raw: Map[String, Any], argsWithDefault: Set[String], optionalArgs: Set[String], undefinedArgs: Set[String], defaultInfo: Cache[String, Any])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Args

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Args.type
case class Argument[T](name: String, argumentType: InputType[_], description: Option[String], defaultValue: Option[(, ToInput[_, _])], fromInput: FromInput[_], deprecationReason: Option[String], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends InputValue[T], Named, HasAstInfo, HasDeprecation

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait Named
trait InputValue[T]
class Object
trait Matchable
class Any
Show all
object Argument

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Argument.type
trait ArgumentType[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ArgumentType extends ArgumentTypeLowPrio

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ArgumentTypeLowPrio extends ArgumentTypeLowestPrio

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ArgumentType.type
trait ArgumentTypeLowestPrio

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ArgumentType.type
case class AstDirectiveContext[Ctx](directive: Directive, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], ctx: Context[Ctx, _], lastValue: Option[Action[Ctx, Any]], args: Args) extends WithArguments

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AstDirectiveInputTypeContext[Ctx](origin: MatOrigin, directive: Directive, schemaDefinition: Option[Type & Named], astDefinition: Option[TypeSystemDefinition], astField: Option[FieldDefinition], definition: InputValueDefinition, materializer: AstSchemaMaterializer[Ctx], args: Args) extends WithArguments, WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class AstDirectiveOutputTypeContext[Ctx](origin: MatOrigin, directive: Directive, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], materializer: AstSchemaMaterializer[Ctx], args: Args) extends WithArguments, WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class AstDirectiveScalarContext(directive: Directive, definition: ScalarTypeDefinition, args: Args) extends WithArguments

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AstInputTypeContext[Ctx](origin: MatOrigin, schemaDefinition: Option[Type & Named], astDefinition: Option[TypeSystemDefinition], astField: Option[FieldDefinition], definition: InputValueDefinition, materializer: AstSchemaMaterializer[Ctx]) extends WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
object AstNodeTransformer

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class AstOutputTypeContext[Ctx](origin: MatOrigin, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], materializer: AstSchemaMaterializer[Ctx]) extends WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
trait AstSchemaBuilder[Ctx]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AstSchemaBuilder

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait AstSchemaGenericResolver[T]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AstSchemaMaterializer[Ctx]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object AstSchemaMaterializer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait AstSchemaResolver[Ctx]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AdditionalTypes[Ctx]
class AnyFieldResolver[Ctx]
class ConflictResolver[Ctx]
class DirectiveResolver[Ctx]
class DynamicDirectiveResolver[Ctx, T]
class FieldResolver[Ctx]
class InputTypeResolver[Ctx]
class InstanceCheck[Ctx]
class OutputTypeResolver[Ctx]
class ScalarResolver[Ctx]
Show all
abstract class BaseMatOrigin(val description: String) extends MatOrigin

Attributes

Supertypes
trait MatOrigin
class Object
trait Matchable
class Any
Known subtypes
class ExistingSchemaOrigin[Ctx, Val]
class SDLOrigin
object StandaloneOrigin.type
case class BuiltMaterializedTypeInst(origin: MatOrigin, tpe: Type & Named) extends MaterializedType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ComplexityDirectiveContext[Ctx](directive: Directive, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, args: Args)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ComplexityDynamicDirectiveContext[Ctx, In](directive: Directive, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, args: In)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait CompositeType[T] extends Type, Named, OutputType[T]

Attributes

Supertypes
trait OutputType[T]
trait Named
trait Type
class Object
trait Matchable
class Any
Show all
Known subtypes
trait ObjectLikeType[Ctx, Val]
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
class UnionType[Ctx]
case class ConflictResolver[Ctx](resolve: (MatOrigin, Vector[MaterializedType]) => MaterializedType) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object ContainerMembersValidator extends SchemaElementValidator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class Context[Ctx, Val](value: Val, ctx: Ctx, args: Args, schema: Schema[Ctx, Val], field: Field[Ctx, Val], parentType: ObjectType[Ctx, Any], marshaller: ResultMarshaller, query: Document, sourceMapper: Option[SourceMapper], deprecationTracker: Option[DeprecationTracker], astFields: Vector[Field], path: ExecutionPath, deferredResolverState: Any, middlewareAttachments: Vector[MiddlewareAttachment]) extends WithArguments, WithInputTypeRendering[Ctx]

The context of a field during schema resolution.

The context of a field during schema resolution.

When a GraphQL request is executed by a Sangria server, each field in the request is resolved to determine the data that should be returned. An instance of this class provides the context for a particular field's resolution.

Type parameters

Ctx

Type of the context object that was passed to Sangria's execution method.

Val

Type of the object to which the field belongs.

Value parameters

ctx

The context object that was passed to Sangria's execution method.

value

The object to which the field belongs.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class DefaultAstSchemaBuilder[Ctx] extends AstSchemaBuilder[Ctx]

Attributes

Supertypes
trait AstSchemaBuilder[Ctx]
class Object
trait Matchable
class Any
Known subtypes
class DefaultIntrospectionSchemaBuilder[Ctx] extends IntrospectionSchemaBuilder[Ctx]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object DefaultIntrospectionSchemaBuilder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class DefaultValueParser[T](schema: Schema[_, _], parser: InputParser[T], toInput: ToInput[T, _])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DefaultValueParser

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object DefaultValueRenderer

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object DefaultValuesValidationRule extends SchemaValidationRule

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class DeferredFutureValue[Ctx, Val](value: Future[Deferred[Val]]) extends StandardLeafAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
case class DeferredValue[Ctx, Val](value: Deferred[Val]) extends StandardLeafAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
case class Directive(name: String, description: Option[String], arguments: List[Argument[_]], locations: Set[Value], repeatable: Boolean, shouldInclude: DirectiveContext => Boolean) extends HasArguments, Named

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Named
trait HasArguments
class Object
trait Matchable
class Any
Show all
case class DirectiveContext(selection: WithDirectives, directive: Directive, args: Args) extends WithArguments

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DirectiveFieldProvider[Ctx](directive: Directive, resolve: DirectiveFieldProviderContext[Ctx] => List[MaterializedField[Ctx, _]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class DirectiveFieldProviderContext[Ctx](origin: MatOrigin, directive: Directive, typeDefinition: TypeDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], materializer: AstSchemaMaterializer[Ctx], args: Args) extends WithArguments, WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class DirectiveInputTypeResolver[Ctx](directive: Directive, resolve: AstDirectiveInputTypeContext[Ctx] => InputType[Any]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object DirectiveLocation extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
case class DirectiveOutputTypeResolver[Ctx](directive: Directive, resolve: AstDirectiveOutputTypeContext[Ctx] => OutputType[Any]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class DirectiveResolver[Ctx](directive: Directive, resolve: AstDirectiveContext[Ctx] => Action[Ctx, Any], complexity: Option[ComplexityDirectiveContext[Ctx] => (Ctx, Args, Double) => Double]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class DirectiveScalarResolver[Ctx](directive: Directive, resolve: AstDirectiveScalarContext => ScalarType[_]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class DynamicDirectiveContext[Ctx, In](directive: Directive, typeDefinition: Either[TypeDefinition, ObjectLikeType[Ctx, _]], fieldDefinition: FieldDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], ctx: Context[Ctx, _], lastValue: Option[Action[Ctx, Any]], args: In)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DynamicDirectiveFieldProvider[Ctx, A](directiveName: String, resolve: DynamicDirectiveFieldProviderContext[Ctx, A] => List[MaterializedField[Ctx, _]])(implicit marshaller: ResultMarshallerForType[A]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class DynamicDirectiveFieldProviderContext[Ctx, A](origin: MatOrigin, directive: Directive, typeDefinition: TypeDefinition, extensions: Vector[ObjectLikeTypeExtensionDefinition], materializer: AstSchemaMaterializer[Ctx], args: A) extends WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class DynamicDirectiveResolver[Ctx, T](directiveName: String, resolve: DynamicDirectiveContext[Ctx, T] => Action[Ctx, Any], complexity: Option[ComplexityDynamicDirectiveContext[Ctx, T] => (Ctx, Args, Double) => Double])(implicit marshaller: ResultMarshallerForType[T]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class EnumType[T](name: String, description: Option[String], values: List[EnumValue[T]], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends InputType[T @@ CoercedScalaResult], OutputType[T], LeafType, NullableType, UnmodifiedType, Named, HasAstInfo

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NullableType
trait LeafType
trait HasAstInfo
trait Named
trait OutputType[T]
trait InputType[T @@ CoercedScalaResult]
trait Type
class Object
trait Matchable
class Any
Show all
case class EnumValue[+T](name: String, description: Option[String], value: T, deprecationReason: Option[String], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends Named, HasDeprecation, HasAstInfo

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait Named
class Object
trait Matchable
class Any
Show all
object EnumValueReservedNameValidator extends SchemaElementValidator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ExistingEnumContext[Ctx](origin: MatOrigin, extensions: Vector[EnumTypeExtensionDefinition], existing: EnumType[Any], materializer: AstSchemaMaterializer[Ctx]) extends WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class ExistingEnumResolver[Ctx](resolve: PartialFunction[ExistingEnumContext[Ctx], EnumType[Any]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class ExistingFieldResolver[Ctx](resolve: PartialFunction[(MatOrigin, Option[ObjectLikeType[Ctx, _]], Field[Ctx, _]), Context[Ctx, _] => Action[Ctx, Any]]) extends AstSchemaResolver[Ctx]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object ExistingFieldResolver

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ExistingInstanceCheck[Ctx](fn: ExistingInstanceCheckContext[Ctx] => (Any, Class[_]) => Boolean) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class ExistingInstanceCheckContext[Ctx](origin: MatOrigin, tpe: ObjectType[Ctx, _], extensions: List[ObjectTypeExtensionDefinition])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ExistingScalarContext[Ctx](origin: MatOrigin, extensions: Vector[ScalarTypeExtensionDefinition], existing: ScalarType[Any], materializer: AstSchemaMaterializer[Ctx]) extends WithTypeLookup[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypeLookup[Ctx]
class Object
trait Matchable
class Any
Show all
case class ExistingScalarResolver[Ctx](resolve: PartialFunction[ExistingScalarContext[Ctx], ScalarType[Any]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class ExistingSchemaOrigin[Ctx, Val](schema: Schema[Ctx, Val]) extends BaseMatOrigin

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait MatOrigin
class Object
trait Matchable
class Any
Show all
case class Field[Ctx, Val](name: String, fieldType: OutputType[_], description: Option[String], arguments: List[Argument[_]], resolve: Context[Ctx, Val] => Action[Ctx, _], deprecationReason: Option[String], tags: List[FieldTag], complexity: Option[(Ctx, Args, Double) => Double], manualPossibleTypes: () => List[ObjectType[_, _]], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends Named, HasArguments, HasDeprecation, HasAstInfo

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

resolve

A function that maps the context of this field definition to an action that retrieves the field's data.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait HasArguments
trait Named
class Object
trait Matchable
class Any
Show all
object Field

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Field.type
case class FieldResolver[Ctx](resolve: PartialFunction[(Either[TypeDefinition, ObjectLikeType[Ctx, _]], FieldDefinition), Context[Ctx, _] => Action[Ctx, Any]], complexity: PartialFunction[(Either[TypeDefinition, ObjectLikeType[Ctx, _]], FieldDefinition), (Ctx, Args, Double) => Double]) extends AstSchemaResolver[Ctx]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object FieldResolver

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
class FullSchemaTraversalValidationRule(validators: SchemaElementValidator*) extends SchemaValidationRule

Attributes

Supertypes
class Object
trait Matchable
class Any
case class FutureValue[Ctx, Val](value: Future[Val]) extends StandardLeafAction[Ctx, Val], ReduceAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ReduceAction[Ctx, Val]
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
case class GenericDirectiveContext(directive: Directive, astNode: AstNode, args: Args) extends WithArguments

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GenericDirectiveResolver[T](directive: Directive, locations: Set[Value], resolve: GenericDirectiveContext => Option[T]) extends AstSchemaGenericResolver[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GenericDynamicDirectiveContext[A](directive: Directive, astNode: AstNode, args: A)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GenericDynamicDirectiveResolver[T, A](directiveName: String, locations: Set[Value], resolve: GenericDynamicDirectiveContext[A] => Option[T])(implicit marshaller: ResultMarshallerForType[A]) extends AstSchemaGenericResolver[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait HasArguments

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Directive
class Field[Ctx, Val]
sealed trait HasAstInfo

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Argument[T]
class EnumType[T]
class EnumValue[T]
class Field[Ctx, Val]
class InputField[T]
class InputObjectType[T]
trait LeafType
class ScalarAlias[T, ST]
class ScalarType[T]
trait ObjectLikeType[Ctx, Val]
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
class Schema[Ctx, Val]
class UnionType[Ctx]
Show all
sealed trait HasDeprecation

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Argument[T]
class EnumValue[T]
class Field[Ctx, Val]
class InputField[T]
sealed trait HasDescription

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Named
trait AbstractType
class InterfaceType[Ctx, Val]
class UnionType[Ctx]
class Argument[T]
trait CompositeType[T]
trait ObjectLikeType[Ctx, Val]
class ObjectType[Ctx, Val]
class Directive
class EnumType[T]
class EnumValue[T]
class Field[Ctx, Val]
class InputField[T]
class InputObjectType[T]
trait LeafType
class ScalarAlias[T, ST]
class ScalarType[T]
class Schema[Ctx, Val]
Show all
case class InputField[T](name: String, fieldType: InputType[T], description: Option[String], defaultValue: Option[(, ToInput[_, _])], deprecationReason: Option[String], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends InputValue[T], Named, HasAstInfo, HasDeprecation

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait Named
trait InputValue[T]
class Object
trait Matchable
class Any
Show all
object InputField

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
InputField.type
case class InputMaterializationException(message: String) extends Exception

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait InputObjectDefaultResult[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object InputObjectDefaultResult extends InputObjectDefaultResultLowPrio

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait InputObjectDefaultResultLowPrio

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class InputObjectType[T](name: String, description: Option[String], fieldsFn: () => List[InputField[_]], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends InputType[T @@ InputObjectResult], NullableType, UnmodifiedType, Named, HasAstInfo

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait Named
trait NullableType
trait InputType[T @@ InputObjectResult]
trait Type
class Object
trait Matchable
class Any
Show all
object InputObjectType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object InputObjectTypeRecursionValidator extends SchemaElementValidator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait InputType[+T] extends Type

Attributes

Supertypes
trait Type
class Object
trait Matchable
class Any
Known subtypes
class EnumType[T]
class InputObjectType[T]
class ListInputType[T]
class OptionInputType[T]
class ScalarAlias[T, ST]
class ScalarType[T]
Show all
case class InputTypeResolver[Ctx](resolve: PartialFunction[AstInputTypeContext[Ctx], InputType[Any]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
trait InputValue[T]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Argument[T]
class InputField[T]
case class InstanceCheck[Ctx](fn: InstanceCheckContext[Ctx] => (Any, Class[_]) => Boolean) extends AstSchemaResolver[Ctx]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
object InstanceCheck

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class InstanceCheckContext[Ctx](origin: MatOrigin, definition: ObjectTypeDefinition, extensions: List[ObjectTypeExtensionDefinition])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InterfaceImplementationValidationRule extends SchemaValidationRule

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class InterfaceType[Ctx, Val](name: String, description: Option[String], fieldsFn: () => List[Field[Ctx, Val]], interfaces: List[InterfaceType[Ctx, _]], manualPossibleTypes: () => List[ObjectType[_, _]], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends ObjectLikeType[Ctx, Val], AbstractType

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AbstractType
trait ObjectLikeType[Ctx, Val]
trait HasAstInfo
trait NullableType
trait CompositeType[Val]
trait Named
trait OutputType[Val]
trait Type
class Object
trait Matchable
class Any
Show all
object InterfaceType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object IntrospectionNamesValidator extends SchemaElementValidator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait IntrospectionSchemaBuilder[Ctx]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IntrospectionSchemaBuilder

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class IntrospectionSchemaMaterializer[Ctx, T](introspectionResult: T, builder: IntrospectionSchemaBuilder[Ctx])(implicit evidence$1: InputUnmarshaller[T])

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object IntrospectionSchemaMaterializer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait LeafAction[+Ctx, +Val] extends Action[Ctx, Val]

Attributes

Companion
object
Supertypes
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Known subtypes
trait StandardLeafAction[Ctx, Val]
class DeferredFutureValue[Ctx, Val]
class DeferredValue[Ctx, Val]
class FutureValue[Ctx, Val]
class MappedSequenceLeafAction[Ctx, Val, NewVal]
class PartialFutureValue[Ctx, Val]
class PartialValue[Ctx, Val]
class SequenceLeafAction[Ctx, Val]
class TryValue[Ctx, Val]
class Value[Ctx, Val]
Show all
object LeafAction

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
LeafAction.type
sealed trait LeafType extends Type, Named, HasAstInfo

Attributes

Supertypes
trait HasAstInfo
trait Named
trait Type
class Object
trait Matchable
class Any
Show all
Known subtypes
class EnumType[T]
class ScalarAlias[T, ST]
class ScalarType[T]
case class ListInputType[T](ofType: InputType[T]) extends InputType[Seq[T]], NullableType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NullableType
trait InputType[Seq[T]]
trait Type
class Object
trait Matchable
class Any
Show all
case class ListType[T](ofType: OutputType[T]) extends OutputType[Iterable[T]], NullableType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NullableType
trait OutputType[Iterable[T]]
trait Type
class Object
trait Matchable
class Any
Show all
trait LowPrioActions extends LowestPrioActions

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Action.type
trait LowestPrioActions

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Action.type
sealed trait MappedAbstractType[T] extends Type, AbstractType

Attributes

Supertypes
trait AbstractType
trait Named
trait Type
class Object
trait Matchable
class Any
Show all
class MappedSequenceLeafAction[Ctx, Val, NewVal](val action: SequenceLeafAction[Ctx, Val], val mapFn: Seq[Val] => NewVal) extends StandardLeafAction[Ctx, NewVal]

Attributes

Supertypes
trait StandardLeafAction[Ctx, NewVal]
trait LeafAction[Ctx, NewVal]
trait Action[Ctx, NewVal]
class Object
trait Matchable
class Any
Show all
class MappedUpdateCtx[Ctx, Val, NewVal](val action: LeafAction[Ctx, Val], val nextCtx: Val => Ctx, val mapFn: Val => NewVal) extends Action[Ctx, NewVal]

Attributes

Supertypes
trait Action[Ctx, NewVal]
class Object
trait Matchable
class Any
case class MappingDeferred[A, +B](deferred: Deferred[A], mapFn: A => (B, Vector[Throwable])) extends Deferred[B]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Deferred[B]
class Object
trait Matchable
class Any
Show all
trait MatOrigin

Provide info on where the definitions came from. E.g. SDL, existing schema, etc

Provide info on where the definitions came from. E.g. SDL, existing schema, etc

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ExistingSchemaOrigin[Ctx, Val]
class SDLOrigin
object StandaloneOrigin.type
sealed trait MaterializedField[Ctx, +Val]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MaterializedFieldInst[Ctx, Val]
object MaterializedField

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MaterializedFieldAst[Ctx](origin: MatOrigin, field: FieldDefinition) extends MaterializedField[Ctx, Any]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait MaterializedField[Ctx, Any]
class Object
trait Matchable
class Any
Show all
case class MaterializedFieldInst[Ctx, Val](origin: MatOrigin, field: Field[Ctx, Val]) extends MaterializedField[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait MaterializedField[Ctx, Val]
class Object
trait Matchable
class Any
Show all
sealed trait MaterializedType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object MaterializedType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MaterializedTypeAst(origin: MatOrigin, tpe: TypeDefinition) extends MaterializedType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MaterializedTypeInst(origin: MatOrigin, tpe: Type & Named) extends MaterializedType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Named extends HasDescription

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AbstractType
class InterfaceType[Ctx, Val]
class UnionType[Ctx]
class Argument[T]
trait CompositeType[T]
trait ObjectLikeType[Ctx, Val]
class ObjectType[Ctx, Val]
class Directive
class EnumType[T]
class EnumValue[T]
class Field[Ctx, Val]
class InputField[T]
class InputObjectType[T]
trait LeafType
class ScalarAlias[T, ST]
class ScalarType[T]
Show all
object Named

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Named.type
sealed trait NullableType

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class EnumType[T]
class InputObjectType[T]
class ListInputType[T]
class ListType[T]
trait ObjectLikeType[Ctx, Val]
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
class ScalarAlias[T, ST]
class ScalarType[T]
class UnionType[Ctx]
Show all
sealed trait ObjectLikeType[Ctx, Val] extends OutputType[Val], CompositeType[Val], NullableType, UnmodifiedType, Named, HasAstInfo

Attributes

Supertypes
trait HasAstInfo
trait NullableType
trait CompositeType[Val]
trait Named
trait OutputType[Val]
trait Type
class Object
trait Matchable
class Any
Show all
Known subtypes
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
case class ObjectType[Ctx, Val](name: String, description: Option[String], fieldsFn: () => List[Field[Ctx, Val]], interfaces: List[InterfaceType[Ctx, _]], instanceCheck: (Any, Class[_], ObjectType[Ctx, Val]) => Boolean, astDirectives: Vector[Directive], astNodes: Vector[AstNode])(implicit evidence$1: ClassTag[Val]) extends ObjectLikeType[Ctx, Val]

GraphQL schema object description.

GraphQL schema object description.

Describes a type of object in a GraphQL schema that is presented by a Sangria server. Objects of the type contain fields and can be viewed as simply a container of fields—internal nodes in the tree of data that a GraphQL request returns. The data store operations take place at the level of the fields that are leaf nodes in that tree.

Constructing the internal nodes of a schema consists mostly of constructing instances of this class.

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ObjectLikeType[Ctx, Val]
trait HasAstInfo
trait NullableType
trait CompositeType[Val]
trait Named
trait OutputType[Val]
trait Type
class Object
trait Matchable
class Any
Show all
object ObjectType

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ObjectType.type
case class OptionInputType[T](ofType: InputType[T]) extends InputType[Option[T]]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait InputType[Option[T]]
trait Type
class Object
trait Matchable
class Any
Show all
case class OptionType[T](ofType: OutputType[T]) extends OutputType[Option[T]]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OutputType[Option[T]]
trait Type
class Object
trait Matchable
class Any
Show all
sealed trait OutputType[+T] extends Type

Attributes

Supertypes
trait Type
class Object
trait Matchable
class Any
Known subtypes
trait CompositeType[T]
trait ObjectLikeType[Ctx, Val]
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
class UnionType[Ctx]
class EnumType[T]
class ListType[T]
class OptionType[T]
class ScalarAlias[T, ST]
class ScalarType[T]
Show all
case class OutputTypeResolver[Ctx](resolve: PartialFunction[AstOutputTypeContext[Ctx], OutputType[Any]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class PartialFutureValue[Ctx, Val](value: Future[PartialValue[Ctx, Val]]) extends StandardLeafAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
case class PartialValue[Ctx, Val](value: Val, errors: Vector[Throwable]) extends StandardLeafAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
case class PossibleInterface[Ctx, Concrete](interfaceType: InterfaceType[Ctx, _])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PossibleInterface extends PossibleInterfaceLowPrioImplicits

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
trait PossibleInterfaceLowPrioImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PossibleInterface.type
case class PossibleObject[Ctx, Abstract](objectType: ObjectType[Ctx, _])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PossibleObject

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait PossibleType[AbstrType, ConcreteType]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PossibleType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class ProjectedName(name: String, children: Vector[ProjectedName], args: Args)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object ProjectionExclude extends FieldTag

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait FieldTag
class Object
trait Matchable
class Any
Show all
Self type
case class ProjectionName(name: String) extends FieldTag

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FieldTag
class Object
trait Matchable
class Any
Show all
trait Projector[Ctx, Val, Res] extends Context[Ctx, Val] => Action[Ctx, Res]

Attributes

Companion
object
Supertypes
trait Context[Ctx, Val] => Action[Ctx, Res]
class Object
trait Matchable
class Any
object Projector

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Projector.type
sealed trait ReduceAction[+Ctx, +Val] extends Action[Ctx, Val]

Attributes

Companion
object
Supertypes
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Known subtypes
class FutureValue[Ctx, Val]
class TryValue[Ctx, Val]
class Value[Ctx, Val]
object ReduceAction

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class ResolvedDirectiveValidationRule(knownUniqueDirectives: Set[String]) extends SchemaValidationRule

Validates uniqueness of directives on types and the schema definition.

Validates uniqueness of directives on types and the schema definition.

It is not fully covered by UniqueDirectivesPerLocation since it onl looks at one AST node at a time, so it does not cover type + type extension scenario.

Attributes

Supertypes
class Object
trait Matchable
class Any
class ResolverBasedAstSchemaBuilder[Ctx](val resolvers: Seq[AstSchemaResolver[Ctx]]) extends DefaultAstSchemaBuilder[Ctx]

Attributes

Companion
object
Supertypes
trait AstSchemaBuilder[Ctx]
class Object
trait Matchable
class Any
object ResolverBasedAstSchemaBuilder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class SDLOrigin(document: Document) extends BaseMatOrigin

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait MatOrigin
class Object
trait Matchable
class Any
Show all
case class ScalarAlias[T, ST](aliasFor: ScalarType[ST], toScalar: T => ST, fromScalar: ST => Either[Violation, T]) extends InputType[T @@ CoercedScalaResult], OutputType[T], LeafType, NullableType, UnmodifiedType, Named

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NullableType
trait LeafType
trait HasAstInfo
trait Named
trait OutputType[T]
trait InputType[T @@ CoercedScalaResult]
trait Type
class Object
trait Matchable
class Any
Show all
case class ScalarResolver[Ctx](resolve: PartialFunction[ScalarTypeDefinition, ScalarType[_]]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case class ScalarType[T](name: String, description: Option[String], coerceUserInput: Any => Either[Violation, T], coerceOutput: (T, Set[MarshallerCapability]) => Any, coerceInput: Value => Either[Violation, T], complexity: Double, scalarInfo: Set[ScalarValueInfo], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends InputType[T @@ CoercedScalaResult], OutputType[T], LeafType, NullableType, UnmodifiedType, Named

Defines a GraphQL scalar value type.

Defines a GraphQL scalar value type.

coerceOutput is allowed to return following scala values:

  • String
  • Boolean
  • Int
  • Long
  • Float
  • Double
  • scala.BigInt
  • scala.BigDecimal
  • sangria.ast.Value (it would be converted to raw scala value before given to a marshalling API)

It may also return other values as well as long as underlying marshalling library supports them.

You can provide additional meta-information to marshalling API with scalarInfo.

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NullableType
trait LeafType
trait HasAstInfo
trait Named
trait OutputType[T]
trait InputType[T @@ CoercedScalaResult]
trait Type
class Object
trait Matchable
class Any
Show all
case class Schema[Ctx, Val](query: ObjectType[Ctx, Val], mutation: Option[ObjectType[Ctx, Val]], subscription: Option[ObjectType[Ctx, Val]], additionalTypes: List[Type & Named], description: Option[String], directives: List[Directive], validationRules: List[SchemaValidationRule], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends HasAstInfo, HasDescription

GraphQL schema description.

GraphQL schema description.

Describes the schema that is presented by a Sangria server. An instance of this type needs to be presented to Sangria's execution method, so that it knows what to execute in response to a GraphQL request that conforms to this schema.

The types contained in the schema have associated actions that Sangria's execution uses to convert a parsed GraphQL request to its data store operations.

Type parameters

Ctx

Type of a context object that will be passed to each Sangria execution of a GraphQL query against this schema.

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

query

The query

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
class Object
trait Matchable
class Any
Show all
object Schema

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Schema.type
sealed trait SchemaChange

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class FieldAdded
class FieldRemoved
class TypeAdded
class TypeRemoved
Show all
object SchemaChange

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object SchemaComparator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait SchemaElementValidator

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ValidNamesValidator.type
object SchemaElementValidator

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class SchemaMaterializationException(message: String, cause: Throwable) extends Exception

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class SchemaValidationException(violations: Vector[Violation], eh: ExceptionHandler) extends ExecutionError, WithViolations, QueryAnalysisError

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait SchemaValidationRule

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SchemaValidationRule

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class SequenceLeafAction[Ctx, Val](value: Seq[LeafAction[Ctx, Val]]) extends StandardLeafAction[Ctx, Seq[Val]]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StandardLeafAction[Ctx, Seq[Val]]
trait LeafAction[Ctx, Seq[Val]]
trait Action[Ctx, Seq[Val]]
class Object
trait Matchable
class Any
Show all
case class SimpleEnumValueResolver[Ctx](resolve: PartialFunction[(Either[EnumTypeDefinition, EnumType[_]], EnumValueDefinition), String]) extends AstSchemaResolver[Ctx]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AstSchemaResolver[Ctx]
class Object
trait Matchable
class Any
Show all
case object StandaloneOrigin extends BaseMatOrigin

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait MatOrigin
class Object
trait Matchable
class Any
Show all
Self type
sealed trait StandardLeafAction[+Ctx, +Val] extends LeafAction[Ctx, Val]

Attributes

Supertypes
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Known subtypes
class DeferredFutureValue[Ctx, Val]
class DeferredValue[Ctx, Val]
class FutureValue[Ctx, Val]
class MappedSequenceLeafAction[Ctx, Val, NewVal]
class PartialFutureValue[Ctx, Val]
class PartialValue[Ctx, Val]
class SequenceLeafAction[Ctx, Val]
class TryValue[Ctx, Val]
class Value[Ctx, Val]
Show all
object SubscriptionFieldsValidationRule extends SchemaValidationRule

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class TryValue[Ctx, Val](value: Try[Val]) extends StandardLeafAction[Ctx, Val], ReduceAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ReduceAction[Ctx, Val]
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
sealed trait Type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AbstractType
class InterfaceType[Ctx, Val]
class UnionType[Ctx]
trait CompositeType[T]
trait ObjectLikeType[Ctx, Val]
class ObjectType[Ctx, Val]
trait InputType[T]
class EnumType[T]
class InputObjectType[T]
class ListInputType[T]
class OptionInputType[T]
class ScalarAlias[T, ST]
class ScalarType[T]
trait LeafType
trait OutputType[T]
class ListType[T]
class OptionType[T]
Show all
case class UnionType[Ctx](name: String, description: Option[String], typesFn: () => List[ObjectType[Ctx, _]], astDirectives: Vector[Directive], astNodes: Vector[AstNode]) extends OutputType[Any], CompositeType[Any], AbstractType, NullableType, UnmodifiedType, HasAstInfo

Value parameters

description

A description of this schema element that can be presented to clients of the GraphQL service.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAstInfo
trait NullableType
trait AbstractType
trait CompositeType[Any]
trait Named
trait OutputType[Any]
trait Type
class Object
trait Matchable
class Any
Show all
object UnionType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
UnionType.type
sealed trait UnmodifiedType

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class EnumType[T]
class InputObjectType[T]
trait ObjectLikeType[Ctx, Val]
class InterfaceType[Ctx, Val]
class ObjectType[Ctx, Val]
class ScalarAlias[T, ST]
class ScalarType[T]
class UnionType[Ctx]
Show all
class UpdateCtx[Ctx, Val](val action: LeafAction[Ctx, Val], val nextCtx: Val => Ctx) extends Action[Ctx, Val]

Attributes

Companion
object
Supertypes
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
object UpdateCtx

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
UpdateCtx.type
object ValidNamesValidator extends SchemaElementValidator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait ValidOutType[-Res, +Out]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ValidOutType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class Value[Ctx, Val](value: Val) extends StandardLeafAction[Ctx, Val], ReduceAction[Ctx, Val]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ReduceAction[Ctx, Val]
trait StandardLeafAction[Ctx, Val]
trait LeafAction[Ctx, Val]
trait Action[Ctx, Val]
class Object
trait Matchable
class Any
Show all
trait WithArguments

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AstDirectiveContext[Ctx]
class Context[Ctx, Val]
Show all
trait WithInputTypeRendering[Ctx]

Type parameters

Ctx

Type of the context object that was passed to Sangria's execution method.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Context[Ctx, Val]
trait WithTypeLookup[Ctx]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AstInputTypeContext[Ctx]
class ExistingEnumContext[Ctx]
Show all
trait WithoutInputTypeTags[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object WithoutInputTypeTags extends WithoutInputTypeTagsLowPrio

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait WithoutInputTypeTagsLowPrio

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object WithoutInputTypeTags.type

Value members

Concrete methods

def fields[Ctx, Val](fields: Field[Ctx, Val]*): List[Field[Ctx, Val]]
def interfaces[Ctx, Concrete](interfaces: PossibleInterface[Ctx, Concrete]*): List[PossibleInterface[Ctx, Concrete]]
def possibleTypes[Ctx, Abstract](objectTypes: PossibleObject[Ctx, Abstract]*): List[PossibleObject[Ctx, Abstract]]
def valueOutput[T](value: T, capabilities: Set[MarshallerCapability]): T

Concrete fields

Implicits

Implicits

implicit val BigIntType: ScalarType[BigInt]
implicit val BooleanType: ScalarType[Boolean]
implicit val FloatType: ScalarType[Double]
implicit val IntType: ScalarType[Int]
implicit val LongType: ScalarType[Long]
implicit val StringType: ScalarType[String]
Generated with