graphql

Documentation

Overview

Package graphql contains the main API for GraphQL.

Example GraphQL query:

{
	Person @withValue(name : "Marvin") {
		key
		kind
		name
	}
}

Index

• func ParseQuery(name string, query string) (*parser.ASTNode, error)
• func RunQuery(name string, part string, query map[string]interface{}, gm *graph.Manager, ...) (map[string]interface{}, error)

Functions

func ParseQuery

func ParseQuery(name string, query string) (*parser.ASTNode, error)

ParseQuery parses a GraphQL query and return its Abstract Syntax Tree.

func RunQuery

func RunQuery(name string, part string, query map[string]interface{},
	gm *graph.Manager, callbackHandler interpreter.SubscriptionCallbackHandler,
	readOnly bool) (map[string]interface{}, error)

RunQuery runs a GraphQL query against a given graph database. The query parameter needs to have the following fields:

operationName - Operation to Execute (string)
query         - Query document (string)
variables     - Variables map (map[string]interface{})

Set the readOnly flag if the query should only be allowed to do read operations.