gql

Documentation

Overview

Package gql is responsible for lexing and parsing a GraphQL query/mutation.

Index

• func Parse(input string) (gq *GraphQuery, mu *Mutation, rerr error)
• type FilterTree
• type Function
• type GraphQuery
  • func (gq *GraphQuery) DebugPrint(prefix string)
• type Mutation

Functions

func Parse

func Parse(input string) (gq *GraphQuery, mu *Mutation, rerr error)

Parse initializes and runs the lexer. It also constructs the GraphQuery subgraph from the lexed items.

Types

type FilterTree

type FilterTree struct {
	Op    string
	Func  *Function
	Child []*FilterTree
}

FilterTree is the result of parsing the filter directive.

type Function

type Function struct {
	Attr string
	Name string   // Specifies the name of the function.
	Args []string // Contains the arguments of the function.
}

Function holds the information about gql functions.

type GraphQuery

type GraphQuery struct {
	UID   uint64
	XID   string
	Attr  string
	Alias string
	Func  *Function

	Args     map[string]string
	Children []*GraphQuery
	Filter   *FilterTree
	// contains filtered or unexported fields
}

GraphQuery stores the parsed Query in a tree format. This gets converted to internally used query.SubGraph before processing the query.

func (*GraphQuery) DebugPrint

func (gq *GraphQuery) DebugPrint(prefix string)

DebugPrint is useful for debugging.

type Mutation

type Mutation struct {
	Set string
	Del string
}

Mutation stores the strings corresponding to set and delete operations.