grackle-core
0.16.0
API
Generated with
grackle-core/grackle

grackle

package grackle

Members list

Type members

Classlikes

object Ast

Attributes

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

Attributes

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

Attributes

Source
mapping.scala
Supertypes
class Mapping[F]
class Object
trait Matchable
class Any
case class Context(rootTpe: Type, path: List[String], resultPath: List[String], typePath: List[Type])

Context represents a position in the output tree in terms of, 1) the path through the schema to the position 2) the path through the schema with query aliases applied 3) the type of the element at the position

Context represents a position in the output tree in terms of, 1) the path through the schema to the position 2) the path through the schema with query aliases applied 3) the type of the element at the position

Attributes

Companion
object
Source
cursor.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Context

Attributes

Companion
class
Source
cursor.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Context.type
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class LeafCursor
class RootCursor
class EmptyCursor
class ProxyCursor
class NullCursor
class ValueCursor
Show all
object Cursor

Attributes

Companion
trait
Source
cursor.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Cursor.type
case class Directive(name: String, args: List[Binding])

Attributes

Companion
object
Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Directive

Attributes

Companion
class
Source
schema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Directive.type
case class DirectiveDef(name: String, description: Option[String], args: List[InputValue], isRepeatable: Boolean, locations: List[DirectiveLocation])

The Directive type represents a Directive that a server supports.

The Directive type represents a Directive that a server supports.

Attributes

See also

https://facebook.github.io/graphql/draft/#sec-The-Directive-Type

Companion
object
Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DirectiveDef

Attributes

Companion
class
Source
schema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object DocumentLiteral extends Literally[Document]

Attributes

Source
syntax3.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class EnumExtension(baseType: String, enumValues: List[EnumValueDefinition], directives: List[Directive]) extends TypeExtension

Enum extensions allow additional values to be added to a pre-existing enum type

Enum extensions allow additional values to be added to a pre-existing enum type

Attributes

See also

https://spec.graphql.org/draft/#sec-Enum-Extensions

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EnumType(name: String, description: Option[String], enumValues: List[EnumValueDefinition], directives: List[Directive]) extends Type, 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

https://facebook.github.io/graphql/draft/#sec-Enum

Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EnumValueDefinition(name: String, description: Option[String], directives: List[Directive])

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

https://facebook.github.io/graphql/draft/#sec-The-EnumValue-Type

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Env

An environment for elaboration or execution of a GraphQL query.

An environment for elaboration or execution of a GraphQL query.

Attributes

Companion
object
Source
cursor.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object EmptyEnv.type
class NonEmptyEnv
object Env

Attributes

Companion
trait
Source
cursor.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Env.type
case class Field(name: String, description: Option[String], args: List[InputValue], tpe: Type, directives: List[Directive])

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

https://facebook.github.io/graphql/draft/#sec-The-Field-Type

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphQLParser

Attributes

Source
parser.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class InputObjectExtension(baseType: String, inputFields: List[InputValue], directives: List[Directive]) extends TypeExtension

Input Object extensions allow additional fields to be added to a pre-existing Input Object type

Input Object extensions allow additional fields to be added to a pre-existing Input Object type

Attributes

See also

https://spec.graphql.org/draft/#sec-Input-Object-Extensions

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InputObjectType(name: String, description: Option[String], inputFields: List[InputValue], directives: List[Directive]) extends Type, 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

https://facebook.github.io/graphql/draft/#sec-Input-Object

Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InputValue(name: String, description: Option[String], tpe: Type, defaultValue: Option[Value], directives: List[Directive])

Value parameters

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.

Attributes

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InterfaceExtension(baseType: String, fields: List[Field], interfaces: List[NamedType], directives: List[Directive]) extends TypeExtension

Interface extensions allow additional fields to be added to a pre-existing interface type

Interface extensions allow additional fields to be added to a pre-existing interface type

Attributes

See also

https://spec.graphql.org/draft/#sec-Interface-Extensions

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

Interfaces are an abstract type where there are common fields declared.

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

https://facebook.github.io/graphql/draft/#sec-Interface

Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Introspection

Attributes

Source
introspection.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object JsonExtractor

Attributes

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

Lists represent sequences of values in GraphQL.

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

https://facebook.github.io/graphql/draft/#sec-Type-Kinds.List

Source
schema.scala
Supertypes
trait Serializable
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Literals

Attributes

Source
parser.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Literals.type
abstract class Mapping[F[_]]

Represents a mapping between a GraphQL schema and an underlying abstract data source.

Represents a mapping between a GraphQL schema and an underlying abstract data source.

Attributes

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

Attributes

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

Attributes

Companion
trait
Source
mappingvalidator.scala
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
Supertypes
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class EnumType
class ScalarType
class TypeRef
class ObjectType
class UnionType
Show all
case class NullableType(ofType: Type) extends Type

A Non‐null type is a type modifier: it wraps another type instance in the ofType field.

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

https://facebook.github.io/graphql/draft/#sec-Type-Kinds.Non-Null

Source
schema.scala
Supertypes
trait Serializable
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ObjectExtension(baseType: String, fields: List[Field], interfaces: List[NamedType], directives: List[Directive]) extends TypeExtension

Object extensions allow additional fields to be added to a pre-existing object type

Object extensions allow additional fields to be added to a pre-existing object type

Attributes

See also

https://spec.graphql.org/draft/#sec-Object-Extensions

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ObjectType(name: String, description: Option[String], fields: List[Field], interfaces: List[NamedType], directives: List[Directive]) extends TypeWithFields

Object types represent concrete instantiations of sets of fields.

Object types represent concrete instantiations of sets of fields.

Attributes

See also

https://facebook.github.io/graphql/draft/#sec-Object

Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Operation(query: Query, rootTpe: NamedType, directives: List[Directive])

Attributes

Source
operation.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Path

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Source
predicate.scala
Supertypes
trait Term[Boolean]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
class StartsWith
object True.type
Show all
object Predicate

Attributes

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

A problem, to be reported back to the user.

A problem, to be reported back to the user.

Attributes

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

Attributes

Companion
class
Source
problem.scala
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Component[F]
class Count
class Effect[F]
object Empty.type
class Environment
class Filter
class Group
class Introspect
class Limit
class Narrow
class Offset
class OrderBy
class Select
class Unique
Show all
object Query

Attributes

Companion
trait
Source
query.scala
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
Supertypes
class Object
trait Matchable
class Any
object QueryCompiler

Attributes

Companion
class
Source
compiler.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class QueryInterpreter[F[_]](mapping: Mapping[F])

Attributes

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

Attributes

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

Attributes

Source
minimizer.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object QueryParser

GraphQL query parser

GraphQL query parser

Attributes

Source
compiler.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Result[+T]

A result value.

A result value.

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

Attributes

Companion
object
Source
result.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Failure
class Success[T]
class Warning[T]
object Result extends ResultInstances

Attributes

Companion
trait
Source
result.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Result.type
trait ResultInstances extends ResultInstances0

Attributes

Source
result.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Result.type
trait ResultInstances0

Attributes

Source
result.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Result.type
final case class ResultT[F[_], A](value: F[Result[A]])

Attributes

Companion
object
Source
result.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResultT

Attributes

Companion
class
Source
result.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ResultT.type
case class ScalarExtension(baseType: String, directives: List[Directive]) extends TypeExtension

Scalar extensions allow additional directives to be applied to a pre-existing Scalar type

Scalar extensions allow additional directives to be applied to a pre-existing Scalar type

Attributes

See also

https://spec.graphql.org/draft/#sec-Scalar-Extensions

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ScalarType(name: String, description: Option[String], directives: List[Directive]) extends Type, NamedType

Represents scalar types such as Int, String, and Boolean.

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

Attributes

See also

https://facebook.github.io/graphql/draft/#sec-Scalar

Companion
object
Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ScalarType

Attributes

Companion
class
Source
schema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ScalarType.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
Supertypes
class Object
trait Matchable
class Any
object Schema

Attributes

Companion
trait
Source
schema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Schema.type
case class SchemaExtension(rootOperations: List[Field], directives: List[Directive])

Attributes

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SchemaLiteral extends Literally[Schema]

Attributes

Source
syntax3.scala
Supertypes
trait Literally[Schema]
class Object
trait Matchable
class Any
Self type
object SchemaParser

GraphQL schema parser

GraphQL schema parser

Attributes

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

Attributes

Source
schema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object SchemaValidator

Attributes

Source
schema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait Term[T] extends Product, 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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
class StartsWith
object True.type
class AndB
class Const[T]
class NotB
class OrB
class ToLowerCase
class ToUpperCase
class XorB
Show all
object Term extends TermLow

Attributes

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

Attributes

Source
predicate.scala
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
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class EnumType
class ListType
trait NamedType
class ScalarType
class TypeRef
class ObjectType
class UnionType
class NullableType
Show all
sealed trait TypeExtension

A GraphQL type extension

A GraphQL type extension

Attributes

Source
schema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
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
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TypeWithFields extends NamedType

A type with fields.

A type with fields.

This includes object types and inferface types.

Attributes

Source
schema.scala
Supertypes
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class ObjectType
case class UnionExtension(baseType: String, members: List[NamedType], directives: List[Directive]) extends TypeExtension

Union extensions allow additional members to be added to a pre-existing union type

Union extensions allow additional members to be added to a pre-existing union type

Attributes

See also

https://spec.graphql.org/draft/#sec-Union-Extensions

Source
schema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class UnionType(name: String, description: Option[String], members: List[NamedType], directives: List[Directive]) extends Type, NamedType

Unions are an abstract type where no common fields are declared.

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

https://facebook.github.io/graphql/draft/#sec-Union

Source
schema.scala
Supertypes
trait Serializable
trait NamedType
trait Type
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait UntypedOperation

Attributes

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

Attributes

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

Attributes

Companion
object
Source
schema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AbsentValue.type
class BooleanValue
class EnumValue
class FloatValue
class IDValue
class IntValue
class ListValue
object NullValue.type
class ObjectValue
class StringValue
class VariableRef
Show all
object Value

Attributes

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

Attributes

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

Attributes

Source
valuemapping.scala
Supertypes
class Mapping[F]
class Object
trait Matchable
class Any
Known subtypes
class ValueMapping[F]
trait VersionSpecificSyntax

Attributes

Source
syntax3.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object syntax.type
object syntax extends VersionSpecificSyntax

Attributes

Source
syntax.scala
Supertypes
class Object
trait Matchable
class Any
Self type
syntax.type
Generated with