federation

Documentation

Index

• func New() plugin.Plugin
• type Entity
• type KeyField
• type RequireField
• type Requires

Functions

func New

func New() plugin.Plugin

New returns a federation plugin that injects federated directives and types into the schema

Types

type Entity

type Entity struct {
	Name         string      // The same name as the type declaration
	KeyFields    []*KeyField // The fields declared in @key.
	ResolverName string      // The resolver name, such as FindUserByID
	Def          *ast.Definition
	Requires     []*Requires
}

Entity represents a federated type that was declared in the GQL schema.

type KeyField

type KeyField struct {
	Field         *ast.FieldDefinition
	TypeReference *config.TypeReference // The Go representation of that field type
}

type RequireField

type RequireField struct {
	Name          string                // The same name as the type declaration
	NameGo        string                // The Go struct field name
	TypeReference *config.TypeReference // The Go representation of that field type
}

RequireField is similar to an entity but it is a field not an object

type Requires

type Requires struct {
	Name   string          // the name of the field
	Fields []*RequireField // the name of the sibling fields
}

Requires represents an @requires clause