codegen

package
v0.17.90 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2026 License: MIT Imports: 22 Imported by: 153

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ClearInlineArgsMetadata added in v0.17.84 

func ClearInlineArgsMetadata()

ClearInlineArgsMetadata clears all stored metadata.

func ExpandInlineArguments added in v0.17.84 

func ExpandInlineArguments(schema *ast.Schema) error

ExpandInlineArguments expands arguments marked with @inlineArguments and stores metadata for later codegen phase.

func GenerateCode added in v0.8.0 

func GenerateCode(data *Data) error

func GenerateCodeIncremental added in v0.17.88 

func GenerateCodeIncremental(data *Data, opts IncrementalOptions) error

GenerateCodeIncremental generates code with content-based file writing. Files are only written if their content has changed, preserving mtimes for unchanged files and allowing Go's build cache to remain valid.

The changedSchemas parameter is used for logging purposes to show what triggered the regeneration. The actual optimization comes from the content-based file writing in templates.write().

func SerializeTransformedSchema added in v0.17.84 

func SerializeTransformedSchema(
	schema *ast.Schema,
	originalSources []*ast.Source,
) ([]*ast.Source, error)

Types

type ArgSet added in v0.8.0 

type ArgSet struct {
	Args     []*FieldArgument
	FuncDecl string
}

type AugmentedSource added in v0.17.6 

type AugmentedSource struct {
	// path relative to Config.Exec.Filename
	RelativePath string
	Embeddable   bool
	BuiltIn      bool
	Source       string
}

AugmentedSource contains extra information about graphql schema files which is not known directly from the Config.Sources data

type ChildFieldType added in v0.17.90 

type ChildFieldType struct {
	TypeName   string
	Definition *ast.Definition
}

ChildFieldType represents a unique object type referenced as a return type from fields across all objects. Used to generate shared childFields_* functions that deduplicate the repeated switch statements in fieldContext_*.

type Data added in v0.8.0 

type Data struct {
	Config *config.Config
	Schema *ast.Schema
	// If a schema is broken up into multiple Data instance, each representing part of the schema,
	// AllDirectives should contain the directives for the entire schema. Directives() can
	// then be used to get the directives that were defined in this Data instance's sources.
	// If a single Data instance is used for the entire schema, AllDirectives and Directives()
	// will be identical.
	// AllDirectives should rarely be used directly.
	AllDirectives   DirectiveList
	Objects         Objects
	Inputs          Objects
	Interfaces      map[string]*Interface
	ReferencedTypes map[string]*config.TypeReference
	ComplexityRoots map[string]*Object

	QueryRoot        *Object
	MutationRoot     *Object
	SubscriptionRoot *Object
	AugmentedSources []AugmentedSource
	Plugins          []any
}

Data is a unified model of the code to be generated. Plugins may modify this structure to do things like implement resolvers or directives automatically (eg grpc, validation)

func BuildData added in v0.8.0 

func BuildData(cfg *config.Config, plugins ...any) (*Data, error)

func (*Data) Args added in v0.8.0 

func (d *Data) Args() map[string][]*FieldArgument

func (*Data) BuiltInDirectives added in v0.17.54 

func (d *Data) BuiltInDirectives() DirectiveList

Get only the directives which should have a statically provided definition

func (*Data) Directives added in v0.8.0 

func (d *Data) Directives() DirectiveList

Get only the directives which are defined in the config's sources.

func (*Data) ECArg added in v0.17.90 

func (d *Data) ECArg() string

ECArg returns the ec argument at a generated call site. 

function syntax:  "ec, "
receiver syntax:  ""

func (*Data) ECDot added in v0.17.90 

func (d *Data) ECDot() string

ECDot returns the call-site prefix for a generated function call. 

function syntax:  ""
receiver syntax:  "ec."

func (*Data) ECFuncParam added in v0.17.90 

func (d *Data) ECFuncParam() string

ECFuncParam returns the ec parameter in a generated function declaration. 

function syntax:  "ec *executionContext, "
receiver syntax:  ""

func (*Data) FuncReceiver added in v0.17.90 

func (d *Data) FuncReceiver() string

FuncReceiver returns the receiver clause for a generated function declaration. 

function syntax:  ""
receiver syntax:  "(ec *executionContext) "

func (*Data) HasBatchResolverFields added in v0.17.87 

func (d *Data) HasBatchResolverFields() bool

func (*Data) HasEmbeddableSources added in v0.17.6 

func (d *Data) HasEmbeddableSources() bool

func (*Data) ImplDirectivesCtx added in v0.17.90 

func (d *Data) ImplDirectivesCtx(f ImplDirectivesField) ImplDirectivesContext

ImplDirectivesCtx returns a context for the implDirectives template suitable for field and argument directive processing (ErrVal="zeroVal", ErrWrap=false).

func (*Data) InputObjectImplDirectivesCtx added in v0.17.90 

func (d *Data) InputObjectImplDirectivesCtx(obj *Object, errVal string) ImplDirectivesContext

InputObjectImplDirectivesCtx returns a context for the implDirectives template for INPUT_OBJECT-level directive processing. errVal is the Go variable name to return on error (e.g., "it" or "&it").

func (*Data) QueryDirectivesCtx added in v0.17.90 

func (d *Data) QueryDirectivesCtx(dl DirectiveList) QueryDirectivesContext

QueryDirectivesCtx returns a context for the queryDirectives template.

func (*Data) UniqueChildFieldTypes added in v0.17.90 

func (d *Data) UniqueChildFieldTypes() []*ChildFieldType

UniqueChildFieldTypes collects all unique OBJECT types that appear as return types from fields. Each type appears once, enabling generation of a shared childFields_* lookup function instead of inlining the switch in every fieldContext_* function.

func (*Data) UserDirectives added in v0.17.54 

func (d *Data) UserDirectives() DirectiveList

Get only the directives which should have a user provided definition on server instantiation

type DependencyGraph added in v0.17.88 

type DependencyGraph struct {
	// SchemaToTypes maps schema file path -> type names defined in that file
	SchemaToTypes map[string][]string

	// TypeToSchema maps type name -> schema file path where it's defined
	TypeToSchema map[string]string

	// TypeDependencies maps type name -> type names it references
	TypeDependencies map[string][]string

	// SchemaDependencies maps schema file -> schema files it depends on
	SchemaDependencies map[string]map[string]bool
}

DependencyGraph tracks type definitions and their cross-schema dependencies. This enables incremental generation by computing which schemas are affected when a subset of schema files change.

func BuildDependencyGraph added in v0.17.88 

func BuildDependencyGraph(schema *ast.Schema) *DependencyGraph

BuildDependencyGraph constructs a dependency graph from the parsed schema

func NewDependencyGraph added in v0.17.88 

func NewDependencyGraph() *DependencyGraph

NewDependencyGraph creates a new empty dependency graph

func (*DependencyGraph) GetAffectedSchemas added in v0.17.88 

func (g *DependencyGraph) GetAffectedSchemas(changedSchemas []string) []string

GetAffectedSchemas returns all schema files that need regeneration when the given schemas have changed. Computes transitive closure of dependencies.

func (*DependencyGraph) GetTypesForSchemas added in v0.17.88 

func (g *DependencyGraph) GetTypesForSchemas(schemas []string) map[string]bool

GetTypesForSchemas returns all type names defined in the given schema files

type Directive 

type Directive struct {
	*ast.DirectiveDefinition
	Name string
	Args []*FieldArgument

	config.DirectiveConfig
}

func (*Directive) ArgsFunc added in v0.5.1 

func (d *Directive) ArgsFunc() string

func (*Directive) CallArgs 

func (d *Directive) CallArgs() string

func (*Directive) CallName added in v0.17.54 

func (d *Directive) CallName() string

func (*Directive) CallPath added in v0.17.54 

func (d *Directive) CallPath() string

func (*Directive) Declaration 

func (d *Directive) Declaration() string

func (*Directive) FunctionImpl added in v0.17.54 

func (d *Directive) FunctionImpl() string

func (*Directive) IsBuiltIn added in v0.17.54 

func (d *Directive) IsBuiltIn() bool

func (*Directive) IsLocation added in v0.9.1 

func (d *Directive) IsLocation(location ...ast.DirectiveLocation) bool

IsLocation check location directive

func (*Directive) ResolveArgs added in v0.8.0 

func (d *Directive) ResolveArgs(obj string, next int) string

type DirectiveList added in v0.9.1 

type DirectiveList map[string]*Directive

func (DirectiveList) LocationDirectives added in v0.9.1 

func (dl DirectiveList) LocationDirectives(location string) DirectiveList

LocationDirectives filter directives by location

type Field 

type Field struct {
	*ast.FieldDefinition

	TypeReference    *config.TypeReference
	GoFieldType      GoFieldType      // The field type in go, if any
	GoReceiverName   string           // The name of method & var receiver in go, if any
	GoFieldName      string           // The name of the method or var in go, if any
	IsResolver       bool             // Does this field need a resolver
	Args             []*FieldArgument // A list of arguments to be passed to this field
	MethodHasContext bool             // If this is bound to a go method, does the method also take a context
	NoErr            bool             // If this is bound to a go method, does that method have an error as the second argument
	VOkFunc          bool             // If this is bound to a go method, is it of shape (any, bool)
	Object           *Object          // A link back to the parent object
	Default          any              // The default value
	Stream           bool             // does this field return a channel?
	Directives       []*Directive
	HasHaser         bool   // Whether a haser method is available (e.g., HasName())
	HaserMethodName  string // Name of the haser method
	Batch            bool   // Enable batch resolver for this field
}

func (*Field) ArgsFunc added in v0.5.1 

func (f *Field) ArgsFunc() string

func (*Field) BatchCallArgs added in v0.17.87 

func (f *Field) BatchCallArgs(parentVar string) string

BatchCallArgs returns a comma-separated list of resolver call arguments for batch resolvers.

func (*Field) CallArgs 

func (f *Field) CallArgs() string

func (*Field) ChildFieldContextFunc added in v0.17.3 

func (f *Field) ChildFieldContextFunc(name string) string

ChildFieldContextFunc returns the fieldContext function name for a child field. Callers must ensure TypeReference and Definition are non-nil (guaranteed by the template rendering path, which only calls this for bound fields).

func (*Field) ChildFieldContextTypeName added in v0.17.90 

func (f *Field) ChildFieldContextTypeName() string

ChildFieldContextTypeName returns the GraphQL type name that this field resolves to. Used by templates to reference shared childFields_* functions.

func (*Field) ComplexityArgs added in v0.5.0 

func (f *Field) ComplexityArgs() string

func (*Field) ComplexitySignature added in v0.5.0 

func (f *Field) ComplexitySignature() string

func (*Field) DirectiveObjName added in v0.9.1 

func (f *Field) DirectiveObjName() string

func (*Field) FieldContextFunc added in v0.17.3 

func (f *Field) FieldContextFunc() string

func (*Field) GoNameUnexported 

func (f *Field) GoNameUnexported() string

func (*Field) GoResultName added in v0.17.25 

func (f *Field) GoResultName() (string, bool)

func (*Field) HasDirectives added in v0.8.0 

func (f *Field) HasDirectives() bool

func (*Field) ImplDirectives added in v0.9.1 

func (f *Field) ImplDirectives() []*Directive

func (*Field) IsBatch added in v0.17.87 

func (f *Field) IsBatch() bool

IsBatch returns true if this field has batch resolver enabled.

func (*Field) IsConcurrent 

func (f *Field) IsConcurrent() bool

func (*Field) IsInputObject added in v0.17.25 

func (f *Field) IsInputObject() bool

func (*Field) IsMap added in v0.8.2 

func (f *Field) IsMap() bool

func (*Field) IsMethod 

func (f *Field) IsMethod() bool

func (*Field) IsReserved added in v0.5.0 

func (f *Field) IsReserved() bool

func (*Field) IsRoot added in v0.17.25 

func (f *Field) IsRoot() bool

func (*Field) IsVariable 

func (f *Field) IsVariable() bool

func (*Field) ResolverType 

func (f *Field) ResolverType() string

func (*Field) ShortBatchResolverDeclaration added in v0.17.87 

func (f *Field) ShortBatchResolverDeclaration() string

ShortBatchResolverDeclaration returns the method signature for a batch resolver. Batch resolvers accept multiple parent objects and return results for all of them. For example, if the normal resolver is: 

Posts(ctx context.Context, obj *User) ([]*Post, error)

The batch resolver would be: 

Posts(ctx context.Context, objs []*User) ([][]*Post, error)

func (*Field) ShortInvocation 

func (f *Field) ShortInvocation() string

func (*Field) ShortResolverDeclaration 

func (f *Field) ShortResolverDeclaration() string

func (*Field) ShortResolverSignature added in v0.17.23 

func (f *Field) ShortResolverSignature(ft *goast.FuncType) string

ShortResolverSignature is identical to ShortResolverDeclaration, but respects previous naming (return) conventions, if any.

func (*Field) StubCallArgs added in v0.17.84 

func (f *Field) StubCallArgs() string

StubCallArgs returns a comma-separated list of argument variable names for stub code.

func (*Field) ZeroVal added in v0.17.90 

func (f *Field) ZeroVal() string

ZeroVal returns the Go declaration for the typed zero value of this field's return type, suitable for use as an error-path return value inside a directive closure.

type FieldArgument 

type FieldArgument struct {
	*ast.ArgumentDefinition
	TypeReference                  *config.TypeReference
	VarName                        string  // The name of the var in go
	Object                         *Object // A link back to the parent object
	Default                        any     // The default value
	Directives                     []*Directive
	Value                          any // value set in Data
	CallArgumentDirectivesWithNull bool
}

func (*FieldArgument) DirectiveObjName added in v0.9.1 

func (f *FieldArgument) DirectiveObjName() string

func (*FieldArgument) ImplDirectives added in v0.9.1 

func (f *FieldArgument) ImplDirectives() []*Directive

ImplDirectives get not SkipRuntime and location ARGUMENT_DEFINITION directive

func (*FieldArgument) Stream 

func (f *FieldArgument) Stream() bool

func (*FieldArgument) ZeroVal added in v0.17.90 

func (f *FieldArgument) ZeroVal() string

ZeroVal returns the Go declaration for the typed zero value of this argument's type, suitable for use as an error-path return value inside a directive closure.

type GoFieldType 

type GoFieldType int
const (
	GoFieldUndefined GoFieldType = iota
	GoFieldMethod
	GoFieldVariable
	GoFieldMap
)

type ImplDirectivesContext added in v0.17.90 

type ImplDirectivesContext struct {
	Field   ImplDirectivesField
	Data    *Data
	ErrVal  string
	ErrWrap bool
}

ImplDirectivesContext is the typed context passed to the implDirectives template. ErrVal is the Go variable name to return on error ("zeroVal" for the standard case, or the partially-built struct variable for INPUT_OBJECT directives). ErrWrap controls whether the error is wrapped in graphql.ErrorOnPath(ctx, err).

func (ImplDirectivesContext) ErrReturn added in v0.17.90 

func (c ImplDirectivesContext) ErrReturn(errExpr string) string

ErrReturn returns the Go statements for the error path inside a directive closure. When ErrWrap is true the error is wrapped in graphql.ErrorOnPath; when false the typed zero value is declared before the plain error return. errExpr is the Go error expression to return (e.g. "err" or `errors.New("not implemented")`).

type ImplDirectivesField added in v0.17.90 

type ImplDirectivesField interface {
	DirectiveObjName() string
	ImplDirectives() []*Directive
	ZeroVal() string
}

ImplDirectivesField is the subset of Field and FieldArgument needed by the implDirectives template.

type IncrementalOptions added in v0.17.88 

type IncrementalOptions struct {
	// ChangedSchemas is the list of schema file paths that have changed.
	// If empty, performs full generation.
	ChangedSchemas []string

	// Verbose enables detailed logging
	Verbose bool
}

IncrementalOptions configures incremental generation

type InlineArgsInfo added in v0.17.84 

type InlineArgsInfo struct {
	OriginalArgName string
	OriginalType    string
	OriginalASTType *ast.Type
	GoType          string
	ExpandedArgs    []string
}

InlineArgsInfo stores metadata about arguments that were inlined. Used during codegen to bundle expanded arguments back into a single resolver parameter.

func GetInlineArgsMetadata added in v0.17.84 

func GetInlineArgsMetadata(typeName, fieldName string) *InlineArgsInfo

GetInlineArgsMetadata retrieves metadata for a given type and field.

type Interface 

type Interface struct {
	*ast.Definition
	Type         types.Type
	Implementors []InterfaceImplementor
	InTypemap    bool
}

type InterfaceImplementor 

type InterfaceImplementor struct {
	*ast.Definition

	Type    types.Type
	TakeRef bool
}

func (*InterfaceImplementor) CanBeNil added in v0.11.0 

func (i *InterfaceImplementor) CanBeNil() bool

type Object 

type Object struct {
	*ast.Definition

	Type                     types.Type
	ResolverInterface        types.Type
	Root                     bool
	Fields                   []*Field
	Implements               []*ast.Definition
	DisableConcurrency       bool
	Stream                   bool
	Directives               []*Directive
	PointersInUnmarshalInput bool
}

func (*Object) Description added in v0.8.0 

func (o *Object) Description() string

func (*Object) HasDirectives added in v0.8.0 

func (o *Object) HasDirectives() bool

func (*Object) HasField added in v0.17.25 

func (o *Object) HasField(name string) bool

func (*Object) HasResolvers 

func (o *Object) HasResolvers() bool

func (*Object) HasUnmarshal added in v0.8.0 

func (o *Object) HasUnmarshal() bool

func (*Object) Implementors 

func (o *Object) Implementors() string

func (*Object) InputObjectDirectives added in v0.17.87 

func (o *Object) InputObjectDirectives() []*Directive

InputObjectDirectives returns directives that should be executed at the INPUT_OBJECT level. This is used for input types to execute @directives placed on the input object itself, after all fields have been unmarshaled. See: https://github.com/99designs/gqlgen/issues/2281

func (*Object) InvalidsIncrement added in v0.17.90 

func (o *Object) InvalidsIncrement(fieldSetVar string) string

InvalidsIncrement returns the Go statement that increments the invalids counter for this object's field set. Concurrent objects require atomic access; sequential objects use a plain increment.

func (*Object) IsConcurrent added in v0.5.0 

func (o *Object) IsConcurrent() bool

func (*Object) IsMap added in v0.17.40 

func (o *Object) IsMap() bool

func (*Object) IsReserved added in v0.5.0 

func (o *Object) IsReserved() bool

func (*Object) Reference added in v0.8.2 

func (o *Object) Reference() types.Type

func (*Object) UniqueFields added in v0.8.2 

func (o *Object) UniqueFields() map[string][]*Field

type Objects 

type Objects []*Object

func (Objects) ByName 

func (os Objects) ByName(name string) *Object

type QueryDirectivesContext added in v0.17.90 

type QueryDirectivesContext struct {
	DirectiveList DirectiveList
	Data          *Data
}

QueryDirectivesContext is the typed context passed to the queryDirectives template.

Source Files

View all Source files

Directories

Path Synopsis
benchmark
benchmark/generated
benchmark/generated/models
benchmark/generated/resolvers
childfielddedup
compliant-int/generated-compliant-strict
compliant-int/generated-default
followschema
followschema/introspection
followschema/invalid-packagename
followschema/otherpkg
nullabledirectives
nullabledirectives/generated
nullabledirectives/generated/models
nullabledirectives/generated/resolvers
protogetters
protogetters/models
singlefile
singlefile/introspection
singlefile/invalid-packagename
singlefile/otherpkg
usefunctionsyntaxforexecutioncontext

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.