graphql

README

graphql

Simple GraphQL client for executing mutations and queries.

Copyright 2020, Ardan Labs
info@ardanlabs.com

Licensing

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About The Project

Package graphql provides support for executing mutations and queries against a database using GraphQL. It was designed specifically for working with Dgraph.

All of the documentation can be found on the go.dev website.

Documentation

Overview

Package graphql provides support for executing mutations and queries against a database using GraphQL. It was designed specifically for working with [Dgraph](https://dgraph.io/) and has some Dgraph specific support.

Index

• func WithClient(client *http.Client) func(gql *GraphQL)
• func WithHeader(key string, value string) func(gql *GraphQL)
• func WithLogging(logFunc func(s string)) func(gql *GraphQL)
• func WithVariable(key string, value interface{}) func(m map[string]interface{})
• type GraphQL
  • func New(url string, options ...func(gql *GraphQL)) *GraphQL
  • func (g *GraphQL) Execute(ctx context.Context, queryString string, response interface{}, ...) error
  • func (g *GraphQL) ExecuteOnEndpoint(ctx context.Context, endpoint string, queryString string, response interface{}, ...) error
  • func (g *GraphQL) RawRequest(ctx context.Context, endpoint string, r io.Reader, response interface{}) error

Functions

func WithClient

func WithClient(client *http.Client) func(gql *GraphQL)

WithClient adds a custom client for processing requests.

func WithHeader

func WithHeader(key string, value string) func(gql *GraphQL)

WithHeader adds a key value pair to the header for requests.

func WithLogging

func WithLogging(logFunc func(s string)) func(gql *GraphQL)

WithLogging acceps a function for logging raw execution messages.

func WithVariable

func WithVariable(key string, value interface{}) func(m map[string]interface{})

WithVariable allows for the submission of variables to the query.

Types

type GraphQL

type GraphQL struct {
	// contains filtered or unexported fields
}

GraphQL represents a system that can accept a graphql query.

func New

func New(url string, options ...func(gql *GraphQL)) *GraphQL

New constructs a GraphQL for use to making queries agains a specified host. The url is the fully qualifying URL without the /graphql path.

func (*GraphQL) Execute

func (g *GraphQL) Execute(ctx context.Context, queryString string, response interface{}, variables ...func(m map[string]interface{})) error

Execute performs a GraphQL query against the configured server on the graphql endpoint from the base URL.

func (*GraphQL) ExecuteOnEndpoint

func (g *GraphQL) ExecuteOnEndpoint(ctx context.Context, endpoint string, queryString string, response interface{}, variables ...func(m map[string]interface{})) error

ExecuteOnEndpoint performs a GraphQL query against the configured server on the specified endpoint from the base URL.

func (*GraphQL) RawRequest

func (g *GraphQL) RawRequest(ctx context.Context, endpoint string, r io.Reader, response interface{}) error

RawRequest performs a request against the specified endpoint and doesn't prepare the request as a GraphQL request.