gsp-graphql-core
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
gsp-graphql-core/edu.gemini.grackle

edu.gemini.grackle

package edu.gemini.grackle

Members list

Concise view

Type members

Classlikes

object Ast

Attributes

Source:
ast.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Ast.type
object CommentedText

Attributes

Source:
parser.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class ComposedMapping[F[_]](implicit val M: Monad[F]) extends Mapping[F]

Attributes

Source:
mapping.scala
Graph
Supertypes
class Mapping[F]
class Object
trait Matchable
class Any
trait Cursor

Indicates a position within an abstract data model during the interpretation of a GraphQL query.

Indicates a position within an abstract data model during the interpretation of a GraphQL query.

Attributes

Companion:
object
Source:
cursor.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Cursor

Attributes

Companion:
trait
Source:
cursor.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cursor.type
case class Directive(name: String, description: Option[String], locations: List[DirectiveLocation], args: List[InputValue])

The Directive type represents a Directive that a server supports.

The Directive type represents a Directive that a server supports.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class EnumType(name: String, description: Option[String], enumValues: List[EnumValue]) extends Type with NamedType

Enums are special scalars that can only have a defined set of values.

Enums are special scalars that can only have a defined set of values.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
case class EnumValue(name: String, description: Option[String], isDeprecated: Boolean, deprecationReason: Option[String])

The EnumValue type represents one of possible values of an enum.

The EnumValue type represents one of possible values of an enum.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Field(name: String, description: Option[String], args: List[InputValue], tpe: Type, isDeprecated: Boolean, deprecationReason: Option[String])

The Field type represents each field in an Object or Interface type.

The Field type represents each field in an Object or Interface type.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLParser

Attributes

Source:
parser.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class InputObjectType(name: String, description: Option[String], inputFields: List[InputValue]) extends Type with NamedType

Input objects are composite types used as inputs into queries defined as a list of named input values.

Input objects are composite types used as inputs into queries defined as a list of named input values.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
case class InputValue(name: String, description: Option[String], tpe: Type, defaultValue: Option[Value])

Attributes

defaultValue

a String encoding (using the GraphQL language) of the default value used by this input value in the condition a value is not provided at runtime.

Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class InterfaceType(name: String, description: Option[String], fields: List[Field], interfaces: List[NamedType]) extends Type with TypeWithFields

Interfaces are an abstract type where there are common fields declared. Any type that implements an interface must define all the fields with names and types exactly matching.

Interfaces are an abstract type where there are common fields declared. Any type that implements an interface must define all the fields with names and types exactly matching.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
object JsonExtractor

Attributes

Source:
jsonextractors.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ListType(ofType: Type) extends Type

Lists represent sequences of values in GraphQL. A List type is a type modifier: it wraps another type instance in the ofType field, which defines the type of each item in the list.

Lists represent sequences of values in GraphQL. A List type is a type modifier: it wraps another type instance in the ofType field, which defines the type of each item in the list.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
object Literals

Attributes

Source:
parser.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class Mapping[F[_]] extends QueryExecutor[F, Json]

Attributes

Source:
mapping.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ValueMapping[F]
trait MappingValidator

Attributes

Companion:
object
Source:
mappingvalidator.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object MappingValidator

Attributes

Companion:
trait
Source:
mappingvalidator.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait NamedType extends Type

A type with a schema-defined name.

A type with a schema-defined name.

This includes object types, inferface types and enums.

Attributes

Source:
schema.scala
Graph
Supertypes
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class EnumType
class TypeRef
class UnionType
case class NullableType(ofType: Type) extends Type

A Non‐null type is a type modifier: it wraps another type instance in the ofType field. Non‐null types do not allow null as a response, and indicate required inputs for arguments and input object fields.

A Non‐null type is a type modifier: it wraps another type instance in the ofType field. Non‐null types do not allow null as a response, and indicate required inputs for arguments and input object fields.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ObjectType(name: String, description: Option[String], fields: List[Field], interfaces: List[NamedType]) extends Type with TypeWithFields

Object types represent concrete instantiations of sets of fields.

Object types represent concrete instantiations of sets of fields.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Operation(query: Query, rootTpe: NamedType)

Attributes

Source:
operation.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Path(rootTpe: Type, path: List[String])

A path starting from some root type.

A path starting from some root type.

Attributes

Companion:
object
Source:
predicate.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Path

Attributes

Companion:
class
Source:
predicate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Path.type
sealed trait PathTerm

Attributes

Companion:
object
Source:
predicate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ListPath[A]
class UniquePath[A]
object PathTerm

Attributes

Companion:
trait
Source:
predicate.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Predicate extends Term[Boolean]

Attributes

Companion:
object
Source:
predicate.scala
Graph
Supertypes
trait Term[Boolean]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class And
class Contains[T]
class Eql[T]
object False.type
class Gt[T]
class GtEql[T]
class In[T]
class IsNull[T]
class Lt[T]
class LtEql[T]
class Matches
class NEql[T]
class Not
class Or
object True.type
object Predicate

Attributes

Companion:
trait
Source:
predicate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final case class Problem(message: String, locations: List[(Int, Int)], path: List[String])

A problem, to be reported back to the user.

A problem, to be reported back to the user.

Attributes

Companion:
object
Source:
problem.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Problem

Attributes

Companion:
class
Source:
problem.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Problem.type
sealed trait Query

GraphQL query Algebra

GraphQL query Algebra

Attributes

Companion:
object
Source:
query.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Component[F]
class Count
class Defer
object Empty.type
class Filter
class Group
class Limit
class Narrow
class Offset
class OrderBy
class Rename
class Select
class Skip
object Skipped.type
class Unique
class Wrap
object Query

Attributes

Companion:
trait
Source:
query.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Query.type
class QueryCompiler(schema: Schema, phases: List[Phase])

GraphQL query compiler.

GraphQL query compiler.

A QueryCompiler parses GraphQL queries to query algebra terms, then applies a collection of transformation phases in sequence, yielding a query algebra term which can be directly interpreted.

Attributes

Companion:
object
Source:
compiler.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object QueryCompiler

Attributes

Companion:
class
Source:
compiler.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait QueryExecutor[F[_], T]

Attributes

Source:
mapping.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Mapping[F]
class ValueMapping[F]
Self type
class QueryInterpreter[F[_]](mapping: Mapping[F])

Attributes

Companion:
object
Source:
queryinterpreter.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object QueryInterpreter

Attributes

Companion:
class
Source:
queryinterpreter.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object QueryMinimizer

Attributes

Source:
compiler.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object QueryParser

GraphQL query parser

GraphQL query parser

Attributes

Source:
compiler.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object Result

Attributes

Source:
package.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Result.type
case class ScalarType(name: String, description: Option[String]) extends Type with NamedType

Represents scalar types such as Int, String, and Boolean. Scalars cannot have fields.

Represents scalar types such as Int, String, and Boolean. Scalars cannot have fields.

Attributes

See also:
Companion:
object
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
object ScalarType

Attributes

Companion:
class
Source:
schema.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Schema

Representation of a GraphQL 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
object Schema

Attributes

Companion:
trait
Source:
schema.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Schema.type
object SchemaParser

GraphQL schema parser

GraphQL schema parser

Attributes

Source:
schema.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object SchemaRenderer

Attributes

Source:
schema.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait Term[T] extends Product with Serializable

A reified function over a Cursor.

A reified function over a Cursor.

Query interpreters will typically need to introspect predicates (eg. in the doobie module we need to be able to construct where clauses from predicates over fields/attributes), so these cannot be arbitrary functions Cursor => Boolean.

Attributes

Companion:
object
Source:
predicate.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class ListPath[A]
class UniquePath[A]
trait Predicate
class And
class Contains[T]
class Eql[T]
object False.type
class Gt[T]
class GtEql[T]
class In[T]
class IsNull[T]
class Lt[T]
class LtEql[T]
class Matches
class NEql[T]
class Not
class Or
object True.type
class AndB
class Const[T]
class NotB
class OrB
class XorB
object Term extends TermLow

Attributes

Companion:
trait
Source:
predicate.scala
Graph
Supertypes
trait TermLow
class Object
trait Matchable
class Any
Self type
Term.type
trait TermLow

Attributes

Source:
predicate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Term.type
sealed trait Type extends Product

A GraphQL type definition.

A GraphQL type definition.

Attributes

Source:
schema.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class EnumType
class ListType
trait NamedType
class TypeRef
class UnionType
case class TypeRef(schema: Schema, name: String) extends NamedType

A by name reference to a type defined in schema.

A by name reference to a type defined in schema.

Attributes

Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait TypeWithFields extends NamedType

A type with fields.

A type with fields.

This includes object types and inferface types.

Attributes

Source:
schema.scala
Graph
Supertypes
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
case class UnionType(name: String, description: Option[String], members: List[NamedType]) extends Type with NamedType

Unions are an abstract type where no common fields are declared. The possible types of a union are explicitly listed out in elements. Types can be made parts of unions without modification of that type.

Unions are an abstract type where no common fields are declared. The possible types of a union are explicitly listed out in elements. Types can be made parts of unions without modification of that type.

Attributes

See also:
Source:
schema.scala
Graph
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait UntypedOperation

Attributes

Companion:
object
Source:
operation.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object UntypedOperation

Attributes

Companion:
trait
Source:
operation.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Value

Attributes

Companion:
object
Source:
schema.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AbsentValue.type
class IDValue
class IntValue
class ListValue
object NullValue.type
object Value

Attributes

Companion:
trait
Source:
schema.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Value.type
abstract class ValueMapping[F[_]](implicit val M: Monad[F]) extends Mapping[F] with ValueMappingLike[F]

Attributes

Source:
valuemapping.scala
Graph
Supertypes
class Mapping[F]
class Object
trait Matchable
class Any
trait ValueMappingLike[F[_]] extends Mapping[F]

Attributes

Source:
valuemapping.scala
Graph
Supertypes
class Mapping[F]
class Object
trait Matchable
class Any
Known subtypes
class ValueMapping[F]
object syntax

Attributes

Source:
syntax.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
syntax.type

Types

type Result[+T] = IorNec[Problem, T]

A result value.

A result value.

A result of type T, a non-empty collection of errors encoded as Json, or both.

Attributes

Source:
package.scala
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL