gqlparser

README

gqlparser

This is a parser for graphql, written to mirror the graphql-js reference implementation as closely while remaining idiomatic and easy to use.

spec target: October 2021 and select portions of the Draft, based on the graphql-js reference implementation graphql-js v16.10.0. This includes Schema definition language, block strings as descriptions, error paths & extension, etc. If there is a spec update or new release, please follow this process to update and submit a PR.

This parser is used by gqlgen, and it should be reasonably stable.

Guiding principles:

• maintainability: It should be easy to stay up to date with the spec
• well tested: It shouldn't need a graphql server to validate itself. Changes to this repo should be self contained.
• server agnostic: It should be usable by any of the graphql server implementations, and any graphql client tooling.
• idiomatic & stable api: It should follow go best practices, especially around forwards compatibility.
• fast: Where it doesn't impact on the above it should be fast. Avoid unnecessary allocs in hot paths.
• close to reference: Where it doesn't impact on the above, it should stay close to the graphql/graphql-js reference implementation.

Documentation

Index

• func LoadQuery(schema *ast.Schema, str string) (*ast.QueryDocument, gqlerror.List)
• func LoadQueryWithRules(schema *ast.Schema, str string, rules *rules.Rules) (*ast.QueryDocument, gqlerror.List)
• func LoadSchema(str ...*ast.Source) (*ast.Schema, error)
• func MustLoadQuery(schema *ast.Schema, str string) *ast.QueryDocument
• func MustLoadQueryWithRules(schema *ast.Schema, str string, rules *rules.Rules) *ast.QueryDocument
• func MustLoadSchema(str ...*ast.Source) *ast.Schema

Functions

func LoadQuery

func LoadQuery(schema *ast.Schema, str string) (*ast.QueryDocument, gqlerror.List)

Deprecated: use LoadQueryWithRules instead.

func LoadQueryWithRules

func LoadQueryWithRules(schema *ast.Schema, str string, rules *rules.Rules) (*ast.QueryDocument, gqlerror.List)

func LoadSchema

func LoadSchema(str ...*ast.Source) (*ast.Schema, error)

func MustLoadQuery

func MustLoadQuery(schema *ast.Schema, str string) *ast.QueryDocument

Deprecated: use MustLoadQueryWithRules instead.

func MustLoadQueryWithRules

func MustLoadQueryWithRules(schema *ast.Schema, str string, rules *rules.Rules) *ast.QueryDocument

func MustLoadSchema

func MustLoadSchema(str ...*ast.Source) *ast.Schema