ghc_run_gql: Run a GrahQL query

In KopfLab/ghctools: Tools for GitHub Classroom

Run a GrahQL query

Description

Run a GraphQL query against the github graphql node. Stops if errors are encountered during query execution. This function is exported for users who want to run custom GraphQL queries against the GitHub server but does not need to be called directly for standard use of the ghctools package.

Usage

ghc_run_gql(
  query,
  query_name = "query",
  gql_client = ghc_authenticate_gql(token),
  token = NULL
)

Arguments

query	GraphQL query
gql_client	a GraphQL client object - will be generated based on the token by default
token	authentication token (only needed if gql_client is not provided)

Value

returns the $data of the query

See Also

Other GitHub query functions: ghc_authenticate_gql()

KopfLab/ghctools documentation built on Feb. 20, 2023, 9:25 a.m.