graphql

package module
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: May 21, 2024 License: MIT Imports: 21 Imported by: 0

README

Installation

go-graphql-client requires Go version 1.13 or later.

go get -u github.com/gzltommy/go-graphql-client

Usage

package main

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/gzltommy/go-graphql-client"
)

func main() {
	client := graphql.NewClient("https://graphigo.prd.galaxy.eco/query", nil)
	client.Debug()
	var query struct {
		AddressInfo struct {
			Nfts struct {
				TotalCount int `graphql:"totalCount" json:"totalCount"`
				List       []struct {
					Id      string `graphql:"id" json:"id"`
					NftCore struct {
						ContractAddress string `graphql:"contractAddress" json:"contractAddress"`
					} `graphql:"nftCore" json:"nftCore"`
				} `graphql:"list" json:"list"`
			} `graphql:"nfts(option:{campaignID:$campaignID,nftCoreAddress:$nftCoreAddress,orderBy:ID,order:ASC})" json:"nfts"`
		} `graphql:"addressInfo(address:$address)" json:"addressInfo"`
	}

	variables := map[string]any{
		"address":        graphql.String("0xb262844a841c5a3fde9a962bd8996c3814896a65"),
		"campaignID":     graphql.ID("GComvUjWMG"),
		"nftCoreAddress": graphql.String("0xADc466855ebe8d1402C5F7e6706Fccc3AEdB44a0"),
	}

	jsonByte, err := client.QueryRaw(context.Background(), &query, variables)
	if err != nil || jsonByte == nil || len(*jsonByte) == 0 {
		fmt.Println("QueryProposals error:", err, jsonByte == nil)
		return
	}
	err = json.Unmarshal(*jsonByte, &query)
	if err != nil {
		fmt.Println("Unmarshal error:", err)
		return
	}

	fmt.Printf("%#v", query)

	return
}

Documentation

Overview

Package graphql provides a GraphQL client implementation.

For more information, see package github.com/shurcooL/githubv4, which is a specialized version targeting GitHub GraphQL API v4. That package is driving the feature development.

Status: In active early research and development. The API will change when opportunities for improvement are discovered; it is not yet frozen.

For now, see README for more details.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ElemSafe 

func ElemSafe(v reflect.Value) reflect.Value

func FieldSafe 

func FieldSafe(valStruct reflect.Value, i int) reflect.Value

func IndexSafe 

func IndexSafe(v reflect.Value, i int) reflect.Value

Types

type Boolean 

type Boolean bool

Boolean represents true or false values.

func NewBoolean 

func NewBoolean(v Boolean) *Boolean

NewBoolean is a helper to make a new *Boolean.

type Client 

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

Client is a GraphQL client.

func NewClient 

func NewClient(url string, httpClient *http.Client) *Client

NewClient creates a GraphQL client targeting the specified GraphQL server URL. If httpClient is nil, then http.DefaultClient is used.

func (*Client) Debug added in v1.0.2 

func (c *Client) Debug()

Debug 开启调试模式

func (*Client) Mutate 

func (c *Client) Mutate(ctx context.Context, m interface{}, variables map[string]interface{}, options ...Option) error

Mutate executes a single GraphQL mutation request, with a mutation derived from m, populating the response into it. m should be a pointer to struct that corresponds to the GraphQL schema.

func (*Client) MutateRaw 

func (c *Client) MutateRaw(ctx context.Context, m interface{}, variables map[string]interface{}, options ...Option) (*json.RawMessage, error)

MutateRaw executes a single GraphQL mutation request, with a mutation derived from m, populating the response into it. m should be a pointer to struct that corresponds to the GraphQL schema. return raw bytes message.

func (*Client) NamedMutate deprecated 

func (c *Client) NamedMutate(ctx context.Context, name string, m interface{}, variables map[string]interface{}, options ...Option) error

NamedMutate executes a single GraphQL mutation request, with operation name

Deprecated: this is the shortcut of Mutate method, with NewOperationName option

func (*Client) NamedMutateRaw 

func (c *Client) NamedMutateRaw(ctx context.Context, name string, m interface{}, variables map[string]interface{}, options ...Option) (*json.RawMessage, error)

NamedMutateRaw executes a single GraphQL mutation request, with operation name return raw bytes message.

func (*Client) NamedQuery deprecated 

func (c *Client) NamedQuery(ctx context.Context, name string, q interface{}, variables map[string]interface{}, options ...Option) error

NamedQuery executes a single GraphQL query request, with operation name

Deprecated: this is the shortcut of Query method, with NewOperationName option

func (*Client) NamedQueryRaw 

func (c *Client) NamedQueryRaw(ctx context.Context, name string, q interface{}, variables map[string]interface{}, options ...Option) (*json.RawMessage, error)

NamedQueryRaw executes a single GraphQL query request, with operation name return raw bytes message.

func (*Client) Query 

func (c *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}, options ...Option) error

Query executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GraphQL schema.

func (*Client) QueryByGet 

func (c *Client) QueryByGet(ctx context.Context, q interface{}, variables map[string]interface{}, options ...Option) error

QueryByGet executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GraphQL schema.

func (*Client) QueryRaw 

func (c *Client) QueryRaw(ctx context.Context, q interface{}, variables map[string]interface{}, options ...Option) (*json.RawMessage, error)

Query executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GraphQL schema. return raw bytes message.

func (*Client) QueryRawByGet added in v1.0.1 

func (c *Client) QueryRawByGet(ctx context.Context, q interface{}, variables map[string]interface{}, options ...Option) (*json.RawMessage, error)

Query executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GraphQL schema. return raw bytes message.

func (*Client) WithRequestModifier 

func (c *Client) WithRequestModifier(f RequestModifier) *Client

Returns a copy of the client with the request modifier set. This allows you to reuse the same TCP connection for multiple slghtly different requests to the same server (i.e. different authentication headers for multitenant applications)

type Errors 

type Errors []struct {
	Message    string
	Extensions map[string]interface{}
	Locations  []struct {
		Line   int
		Column int
	}
}

errors represents the "errors" array in a response from a GraphQL server. If returned via error interface, the slice is expected to contain at least 1 element.

Specification: https://facebook.github.io/graphql/#sec-Errors.

func (Errors) Error 

func (e Errors) Error() string

Error implements error interface.

type Float 

type Float float64

Float represents signed double-precision fractional values as specified by IEEE 754.

func NewFloat 

func NewFloat(v Float) *Float

NewFloat is a helper to make a new *Float.

type ID 

type ID interface{}

ID represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

func NewID 

func NewID(v ID) *ID

NewID is a helper to make a new *ID.

type Int 

type Int int32

Int represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

func NewInt 

func NewInt(v Int) *Int

NewInt is a helper to make a new *Int.

type OperationMessage 

type OperationMessage struct {
	ID      string               `json:"id,omitempty"`
	Type    OperationMessageType `json:"type"`
	Payload json.RawMessage      `json:"payload,omitempty"`
}

func (OperationMessage) String 

func (om OperationMessage) String() string

type OperationMessageType 

type OperationMessageType string

OperationMessageType 

const (
	// Client sends this message after plain websocket connection to start the communication with the server
	GQL_CONNECTION_INIT OperationMessageType = "connection_init"
	// The server may responses with this message to the GQL_CONNECTION_INIT from client, indicates the server rejected the connection.
	GQL_CONNECTION_ERROR OperationMessageType = "conn_err"
	// Client sends this message to execute GraphQL operation
	GQL_START OperationMessageType = "start"
	// Client sends this message in order to stop a running GraphQL operation execution (for example: unsubscribe)
	GQL_STOP OperationMessageType = "stop"
	// Server sends this message upon a failing operation, before the GraphQL execution, usually due to GraphQL validation errors (resolver errors are part of GQL_DATA message, and will be added as errors array)
	GQL_ERROR OperationMessageType = "error"
	// The server sends this message to transfter the GraphQL execution result from the server to the client, this message is a response for GQL_START message.
	GQL_DATA OperationMessageType = "data"
	// Server sends this message to indicate that a GraphQL operation is done, and no more data will arrive for the specific operation.
	GQL_COMPLETE OperationMessageType = "complete"
	// Server message that should be sent right after each GQL_CONNECTION_ACK processed and then periodically to keep the client connection alive.
	// The client starts to consider the keep alive message only upon the first received keep alive message from the server.
	GQL_CONNECTION_KEEP_ALIVE OperationMessageType = "ka"
	// The server may responses with this message to the GQL_CONNECTION_INIT from client, indicates the server accepted the connection. May optionally include a payload.
	GQL_CONNECTION_ACK OperationMessageType = "connection_ack"
	// Client sends this message to terminate the connection.
	GQL_CONNECTION_TERMINATE OperationMessageType = "connection_terminate"
	// Unknown operation type, for logging only
	GQL_UNKNOWN OperationMessageType = "unknown"
	// Internal status, for logging only
	GQL_INTERNAL OperationMessageType = "internal"
)

type Option 

type Option interface {
	// Type returns the supported type of the renderer
	// available types: operation_name and operation_directive
	Type() OptionType
	// String returns the query component string
	String() string
}

Option abstracts an extra render interface for the query string They are optional parts. By default GraphQL queries can request data without them

func OperationName 

func OperationName(name string) Option

OperationName creates the operation name option

type OptionType 

type OptionType string

OptionType represents the logic of graphql query construction 

const (
	OptionTypeOperationDirective OptionType = "operation_directive"
)

type RequestModifier 

type RequestModifier func(*http.Request)

This function allows you to tweak the HTTP request. It might be useful to set authentication headers amongst other things

type String 

type String string

String represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

func NewString 

func NewString(v String) *String

NewString is a helper to make a new *String.

type SubscriptionClient 

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

SubscriptionClient is a GraphQL subscription client.

func NewSubscriptionClient 

func NewSubscriptionClient(url string) *SubscriptionClient

func (*SubscriptionClient) Close 

func (sc *SubscriptionClient) Close() (err error)

Close closes all subscription channel and websocket as well

func (*SubscriptionClient) GetContext 

func (sc *SubscriptionClient) GetContext() context.Context

GetContext returns current context of subscription client

func (*SubscriptionClient) GetTimeout 

func (sc *SubscriptionClient) GetTimeout() time.Duration

GetContext returns write timeout of websocket client

func (*SubscriptionClient) GetURL 

func (sc *SubscriptionClient) GetURL() string

GetURL returns GraphQL server's URL

func (*SubscriptionClient) NamedSubscribe deprecated 

func (sc *SubscriptionClient) NamedSubscribe(name string, v interface{}, variables map[string]interface{}, handler func(message *json.RawMessage, err error) error, options ...Option) (string, error)

NamedSubscribe sends start message to server and open a channel to receive data, with operation name

Deprecated: this is the shortcut of Subscribe method, with NewOperationName option

func (*SubscriptionClient) OnConnected 

func (sc *SubscriptionClient) OnConnected(fn func()) *SubscriptionClient

OnConnected event is triggered when the websocket connected to GraphQL server successfully

func (*SubscriptionClient) OnDisconnected 

func (sc *SubscriptionClient) OnDisconnected(fn func()) *SubscriptionClient

OnDisconnected event is triggered when the websocket server was still down after retry timeout

func (*SubscriptionClient) OnError 

func (sc *SubscriptionClient) OnError(onError func(sc *SubscriptionClient, err error) error) *SubscriptionClient

OnConnected event is triggered when there is any connection error. This is bottom exception handler level If this function is empty, or returns nil, the error is ignored If returns error, the websocket connection will be terminated

func (*SubscriptionClient) Reset 

func (sc *SubscriptionClient) Reset() error

Reset restart websocket connection and subscriptions

func (*SubscriptionClient) Run 

func (sc *SubscriptionClient) Run() error

Run start websocket client and subscriptions. If this function is run with goroutine, it can be stopped after closed

func (*SubscriptionClient) Subscribe 

func (sc *SubscriptionClient) Subscribe(v interface{}, variables map[string]interface{}, handler func(message *json.RawMessage, err error) error, options ...Option) (string, error)

Subscribe sends start message to server and open a channel to receive data. The handler callback function will receive raw message data or error. If the call return error, onError event will be triggered The function returns subscription ID and error. You can use subscription ID to unsubscribe the subscription

func (*SubscriptionClient) SubscribeRaw 

func (sc *SubscriptionClient) SubscribeRaw(query string, variables map[string]interface{}, handler func(message *json.RawMessage, err error) error) (string, error)

SubscribeRaw sends start message to server and open a channel to receive data, with raw query

func (*SubscriptionClient) Unsubscribe 

func (sc *SubscriptionClient) Unsubscribe(id string) error

Unsubscribe sends stop message to server and close subscription channel The input parameter is subscription ID that is returned from Subscribe function

func (*SubscriptionClient) WithConnectionParams 

func (sc *SubscriptionClient) WithConnectionParams(params map[string]interface{}) *SubscriptionClient

WithConnectionParams updates connection params for sending to server through GQL_CONNECTION_INIT event It's usually used for authentication handshake

func (*SubscriptionClient) WithLog 

func (sc *SubscriptionClient) WithLog(logger func(args ...interface{})) *SubscriptionClient

WithLog sets loging function to print out received messages. By default, nothing is printed

func (*SubscriptionClient) WithReadLimit 

func (sc *SubscriptionClient) WithReadLimit(limit int64) *SubscriptionClient

WithReadLimit set max size of response message

func (*SubscriptionClient) WithRetryTimeout 

func (sc *SubscriptionClient) WithRetryTimeout(timeout time.Duration) *SubscriptionClient

WithRetryTimeout updates reconnecting timeout. When the websocket server was stopped, the client will retry connecting every second until timeout

func (*SubscriptionClient) WithTimeout 

func (sc *SubscriptionClient) WithTimeout(timeout time.Duration) *SubscriptionClient

WithTimeout updates write timeout of websocket client

func (*SubscriptionClient) WithWebSocket 

func (sc *SubscriptionClient) WithWebSocket(fn func(sc *SubscriptionClient) (WebsocketConn, error)) *SubscriptionClient

WithWebSocket replaces customized websocket client constructor In default, subscription client uses https://github.com/nhooyr/websocket

func (*SubscriptionClient) WithWebSocketOptions 

func (sc *SubscriptionClient) WithWebSocketOptions(options WebsocketOptions) *SubscriptionClient

WithWebSocketOptions provides options to the websocket client

func (*SubscriptionClient) WithoutLogTypes 

func (sc *SubscriptionClient) WithoutLogTypes(types ...OperationMessageType) *SubscriptionClient

WithoutLogTypes these operation types won't be printed

type WebsocketConn 

type WebsocketConn interface {
	ReadJSON(v interface{}) error
	WriteJSON(v interface{}) error
	Close() error
	// SetReadLimit sets the maximum size in bytes for a message read from the peer. If a
	// message exceeds the limit, the connection sends a close message to the peer
	// and returns ErrReadLimit to the application.
	SetReadLimit(limit int64)
}

WebsocketHandler abstracts WebSocket connection functions ReadJSON and WriteJSON data of a frame from the WebSocket connection. Close the WebSocket connection.

type WebsocketHandler 

type WebsocketHandler struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

default websocket handler implementation using https://github.com/nhooyr/websocket

func (*WebsocketHandler) Close 

func (wh *WebsocketHandler) Close() error

func (*WebsocketHandler) ReadJSON 

func (wh *WebsocketHandler) ReadJSON(v interface{}) error

func (*WebsocketHandler) WriteJSON 

func (wh *WebsocketHandler) WriteJSON(v interface{}) error

type WebsocketOptions 

type WebsocketOptions struct {
	// HTTPClient is used for the connection.
	HTTPClient *http.Client
}

WebsocketOptions allows implementation agnostic configuration of the websocket client

Source Files

View all Source files

Directories

Path Synopsis
example
graphqldev
graphqldev is a test program currently being used for developing graphql package.
 graphqldev is a test program currently being used for developing graphql package.
subscription
subscription is a test program currently being used for developing graphql package.
 subscription is a test program currently being used for developing graphql package.
Package ident provides functions for parsing and converting identifier names between various naming convention.
 Package ident provides functions for parsing and converting identifier names between various naming convention.
internal
jsonutil
Package jsonutil provides a function for decoding JSON into a GraphQL query data structure.
 Package jsonutil provides a function for decoding JSON into a GraphQL query data structure.

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.