Mapping

grackle.Mapping

abstract class Mapping[F[_]]

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

Attributes

Source: mapping.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ComposedMapping[F]

class ValueMapping[F]

class IntrospectionMapping

trait ValueMappingLike[F]

Members list

Type members

Classlikes

Attributes

Companion: object
Source: mapping.scala
Supertypes: trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: mapping.scala
Supertypes: class Object

trait Matchable

class Any
Self type: CursorField.type

Attributes

Source: mapping.scala
Supertypes: trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Source: mapping.scala
Supertypes: trait EffectMapping

trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Abstract type of field mappings with effects.

Attributes

Source: mapping.scala
Supertypes: trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class EffectField

class RootEffect

class RootStream

Attributes

Source: mapping.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class CursorField[T]

class Delegate

trait EffectMapping

class EffectField

class RootEffect

class RootStream

class PrimitiveField

trait ValueFieldMapping[T]

class ValueField[T]

class Wrap[T]
Show all

Proxy Cursor which applies a function to the focus of an underlying LeafCursor.

Attributes

Source: mapping.scala
Supertypes: trait Serializable

trait Product

trait Equals

class ProxyCursor

trait Cursor

class Object

trait Matchable

class Any
Show all

Cursor positioned at a GraphQL result leaf

Attributes

Source: mapping.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Cursor

class Object

trait Matchable

class Any
Show all

Attributes

Companion: trait
Source: mapping.scala
Supertypes: class Object

trait Matchable

class Any
Self type: LeafMapping.type

Attributes

Companion: object
Source: mapping.scala
Supertypes: trait TypeMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class DefaultLeafMapping[T]

Attributes

Companion: object
Source: mapping.scala
Supertypes: trait TypeMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class ValueObjectMapping[T]

class DefaultObjectMapping

Attributes

Companion: class
Source: mapping.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ObjectMapping.type

Attributes

Source: mapping.scala
Supertypes: trait TypeMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Source: mapping.scala
Supertypes: trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Source: mapping.scala
Supertypes: trait TypeMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Root Cursor focussed on the top level operation of a query

Construction of mapping-specific cursors is handled by delegation to mkCursorForField which is typically overridden in Mapping subtypes.

Attributes

Source: mapping.scala
Supertypes: trait Serializable

trait Product

trait Equals

class AbstractCursor

trait Cursor

class Object

trait Matchable

class Any
Show all

Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

These effects are used to perform initial effectful setup for a query or to perform the effect associated with a GraphQL mutation. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed.

If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

Attributes

Companion: object
Source: mapping.scala
Supertypes: trait EffectMapping

trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: mapping.scala
Supertypes: class Object

trait Matchable

class Any
Self type: RootEffect.type

Root streams can perform an intial effect prior to emitting the resulting cursors and effective queries.

Stream effects are used for GraphQL subscriptions. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed

Attributes

Companion: object
Source: mapping.scala
Supertypes: trait EffectMapping

trait FieldMapping

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: mapping.scala
Supertypes: class Object

trait Matchable

class Any
Self type: RootStream.type

Attributes

Source: mapping.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait LeafMapping[T]

class DefaultLeafMapping[T]

class ObjectMapping

class ValueObjectMapping[T]

class DefaultObjectMapping

class PrefixedMapping

class PrimitiveMapping
Show all

Value members

Concrete methods

Combine and execute multiple queries.

Each query is interpreted in the context of the Cursor it is paired with. The result list is aligned with the argument query list. For each query at most one stage will be run and the corresponding result may contain deferred components.

Errors are aggregated across all the argument queries and are accumulated on the Left of the result.

This method is typically called at the end of a stage to evaluate deferred subqueries in the result of that stage. These will be grouped by and passed jointly to the responsible mapping in the next stage using this method. Maappongs which are able to benefit from combining queries may do so by overriding this method to implement their specific combinging logic.