com.netflix.graphql.dgs

Interface DgsQueryExecutor

public interface DgsQueryExecutor

Represents the core query executing capability of the framework. Use this interface to easily execute GraphQL queries, without using the HTTP endpoint. This is meant to be used in tests, and is also used internally in the framework.

The executeAnd* methods use the JsonPath library library to easily get specific fields out of a nested Json structure. The executeAndGetDocumentContext(String) method sets up a DocumentContext, which can then be reused to get multiple fields.

See Also:

Query Execution Testing docs

Method Summary

Modifier and Type	Method and Description
default graphql.ExecutionResult	execute(java.lang.String query)
default graphql.ExecutionResult	execute(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables)
default graphql.ExecutionResult	execute(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables, java.util.Map<java.lang.String,java.lang.Object> extensions, org.springframework.http.HttpHeaders headers)
graphql.ExecutionResult	execute(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables, java.util.Map<java.lang.String,java.lang.Object> extensions, org.springframework.http.HttpHeaders headers, java.lang.String operationName, org.springframework.web.context.request.WebRequest webRequest) Executes a GraphQL query.
default graphql.ExecutionResult	execute(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.String operationName)
default <T> T	executeAndExtractJsonPath(java.lang.String query, java.lang.String jsonPath) Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data.
<T> T	executeAndExtractJsonPath(java.lang.String query, java.lang.String jsonPath, org.springframework.http.HttpHeaders headers) Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data.
<T> T	executeAndExtractJsonPath(java.lang.String query, java.lang.String jsonPath, java.util.Map<java.lang.String,java.lang.Object> variables) Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data.
<T> T	executeAndExtractJsonPath(java.lang.String query, java.lang.String jsonPath, org.springframework.web.context.request.ServletWebRequest servletWebRequest) Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data.
default <T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, java.lang.Class<T> clazz) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
default <T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Class<T> clazz) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
<T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Class<T> clazz, org.springframework.http.HttpHeaders headers) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
default <T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, java.util.Map<java.lang.String,java.lang.Object> variables, com.jayway.jsonpath.TypeRef<T> typeRef) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
<T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, java.util.Map<java.lang.String,java.lang.Object> variables, com.jayway.jsonpath.TypeRef<T> typeRef, org.springframework.http.HttpHeaders headers) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
default <T> T	executeAndExtractJsonPathAsObject(java.lang.String query, java.lang.String jsonPath, com.jayway.jsonpath.TypeRef<T> typeRef) Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type.
default com.jayway.jsonpath.DocumentContext	executeAndGetDocumentContext(java.lang.String query) Executes a GraphQL query, parses the returned data, and return a DocumentContext.
com.jayway.jsonpath.DocumentContext	executeAndGetDocumentContext(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables) Executes a GraphQL query, parses the returned data, and return a DocumentContext.
com.jayway.jsonpath.DocumentContext	executeAndGetDocumentContext(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables, org.springframework.http.HttpHeaders headers) Executes a GraphQL query, parses the returned data, and return a DocumentContext.

Method Detail

execute

default graphql.ExecutionResult execute(java.lang.String query)

Parameters:

query - The query string

Returns:

Returns a GraphQL ExecutionResult. This includes data and errors.

execute

default graphql.ExecutionResult execute(java.lang.String query,
                                        java.util.Map<java.lang.String,java.lang.Object> variables)

Parameters:

query - The query string

variables - A map of variables

Returns:

Returns a GraphQL ExecutionResult. This includes data and errors.

See Also:

Query Variables

execute

default graphql.ExecutionResult execute(java.lang.String query,
                                        java.util.Map<java.lang.String,java.lang.Object> variables,
                                        java.lang.String operationName)

Parameters:

query - The query string

variables - A map of variables

operationName - The operation name

Returns:

Returns a GraphQL ExecutionResult. This includes data and errors.

See Also:

Query Variables, Operation name

execute

default graphql.ExecutionResult execute(java.lang.String query,
                                        java.util.Map<java.lang.String,java.lang.Object> variables,
                                        java.util.Map<java.lang.String,java.lang.Object> extensions,
                                        org.springframework.http.HttpHeaders headers)

Parameters:

query - The query string

variables - A map of variables

extensions - A map representing GraphQL extensions. This is made available in the DgsRequestData object on com.netflix.graphql.dgs.context.DgsContext}.

Returns:

Returns a GraphQL ExecutionResult. This includes data and errors.

See Also:

Query Variables

execute

graphql.ExecutionResult execute(java.lang.String query,
                                java.util.Map<java.lang.String,java.lang.Object> variables,
                                java.util.Map<java.lang.String,java.lang.Object> extensions,
                                org.springframework.http.HttpHeaders headers,
                                java.lang.String operationName,
                                org.springframework.web.context.request.WebRequest webRequest)

Executes a GraphQL query. This method is used internally by all other methods in this interface.

Parameters:

query - The query string

variables - A map of variables

extensions - A map representing GraphQL extensions. This is made available in the DgsRequestData object on DgsContext.

headers - Request headers represented as a Spring Framework HttpHeaders

operationName - Operation name

webRequest - A Spring WebRequest giving access to request details. Can cast to an environment specific class such as ServletWebRequest.

Returns:

Returns a GraphQL ExecutionResult. This includes data and errors.

See Also:

Query Variables, Operation name

executeAndExtractJsonPath

default <T> T executeAndExtractJsonPath(java.lang.String query,
                                        java.lang.String jsonPath)

Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data. The method is generic, and tries to cast the result into the type you specify. This does NOT work on Lists. Use executeAndExtractJsonPathAsObject(String, String, TypeRef)instead.

Type Parameters:

T - The type of primitive or map representation that should be returned.

Parameters:

query - Query string

jsonPath - JsonPath expression.

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs

executeAndExtractJsonPath

<T> T executeAndExtractJsonPath(java.lang.String query,
                                java.lang.String jsonPath,
                                java.util.Map<java.lang.String,java.lang.Object> variables)

Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data. The method is generic, and tries to cast the result into the type you specify. This does NOT work on Lists. Use executeAndExtractJsonPathAsObject(String, String, TypeRef)instead.

This only works for primitive types and map representations. Use executeAndExtractJsonPathAsObject(String, String, Class) for complex types and lists.*

Type Parameters:

T - The type of primitive or map representation that should be returned.

Parameters:

query - Query string

jsonPath - JsonPath expression.

variables - A Map of variables

Returns:

The extracted value from the result, converted to type T

See Also:

Query Variables, JsonPath syntax docs

executeAndExtractJsonPath

<T> T executeAndExtractJsonPath(java.lang.String query,
                                java.lang.String jsonPath,
                                org.springframework.http.HttpHeaders headers)

Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data. The method is generic, and tries to cast the result into the type you specify. This does NOT work on Lists. Use executeAndExtractJsonPathAsObject(String, String, TypeRef)instead.

This only works for primitive types and map representations. Use executeAndExtractJsonPathAsObject(String, String, Class) for complex types and lists. *

Type Parameters:

T - The type of primitive or map representation that should be returned.

Parameters:

query - Query string

jsonPath - JsonPath expression.

headers - Spring HttpHeaders

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs

executeAndExtractJsonPath

<T> T executeAndExtractJsonPath(java.lang.String query,
                                java.lang.String jsonPath,
                                org.springframework.web.context.request.ServletWebRequest servletWebRequest)

Executes a GraphQL query, parses the returned data, and uses a Json Path to extract specific elements out of the data. The method is generic, and tries to cast the result into the type you specify. This does NOT work on Lists. Use executeAndExtractJsonPathAsObject(String, String, TypeRef)instead.

This only works for primitive types and map representations. Use executeAndExtractJsonPathAsObject(String, String, Class) for complex types and lists. *

Type Parameters:

T - The type of primitive or map representation that should be returned.

Parameters:

query - Query string

jsonPath - JsonPath expression.

servletWebRequest - Spring ServletWebRequest

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs

executeAndGetDocumentContext

default com.jayway.jsonpath.DocumentContext executeAndGetDocumentContext(java.lang.String query)

Executes a GraphQL query, parses the returned data, and return a DocumentContext. A DocumentContext can be used to extract multiple values using JsonPath, without re-executing the query.

Parameters:

query - Query string

Returns:

DocumentContext is a JsonPath type used to extract values from.

executeAndGetDocumentContext

com.jayway.jsonpath.DocumentContext executeAndGetDocumentContext(java.lang.String query,
                                                                 java.util.Map<java.lang.String,java.lang.Object> variables)

Executes a GraphQL query, parses the returned data, and return a DocumentContext. A DocumentContext can be used to extract multiple values using JsonPath, without re-executing the query.

Parameters:

query - Query string

variables - A Map of variables

Returns:

DocumentContext is a JsonPath type used to extract values from.

See Also:

Query Variables

executeAndGetDocumentContext

com.jayway.jsonpath.DocumentContext executeAndGetDocumentContext(java.lang.String query,
                                                                 java.util.Map<java.lang.String,java.lang.Object> variables,
                                                                 org.springframework.http.HttpHeaders headers)

Executes a GraphQL query, parses the returned data, and return a DocumentContext. A DocumentContext can be used to extract multiple values using JsonPath, without re-executing the query.

Parameters:

query - Query string

variables - A Map of variables

headers - Spring HttpHeaders

Returns:

DocumentContext is a JsonPath type used to extract values from.

See Also:

Query Variables

executeAndExtractJsonPathAsObject

default <T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                                java.lang.String jsonPath,
                                                java.lang.Class<T> clazz)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

clazz - The type to convert the extracted value to.

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs

executeAndExtractJsonPathAsObject

default <T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                                java.lang.String jsonPath,
                                                java.util.Map<java.lang.String,java.lang.Object> variables,
                                                java.lang.Class<T> clazz)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

variables - A Map of variables

clazz - The type to convert the extracted value to.

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs, Query Variables

executeAndExtractJsonPathAsObject

<T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                        java.lang.String jsonPath,
                                        java.util.Map<java.lang.String,java.lang.Object> variables,
                                        java.lang.Class<T> clazz,
                                        org.springframework.http.HttpHeaders headers)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

variables - A Map of variables

clazz - The type to convert the extracted value to.

headers - Request headers represented as a Spring Framework HttpHeaders

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs, Query Variables

executeAndExtractJsonPathAsObject

default <T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                                java.lang.String jsonPath,
                                                com.jayway.jsonpath.TypeRef<T> typeRef)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Uses a TypeRef to specify the expected type, which is useful for Lists and Maps. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

typeRef - A JsonPath [TypeRef] representing the expected result type.

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs, Using TypeRef

executeAndExtractJsonPathAsObject

default <T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                                java.lang.String jsonPath,
                                                java.util.Map<java.lang.String,java.lang.Object> variables,
                                                com.jayway.jsonpath.TypeRef<T> typeRef)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Uses a TypeRef to specify the expected type, which is useful for Lists and Maps. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

variables - A Map of variables

typeRef - A JsonPath TypeRef representing the expected result type.

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs, Query Variables, Using TypeRef

executeAndExtractJsonPathAsObject

<T> T executeAndExtractJsonPathAsObject(java.lang.String query,
                                        java.lang.String jsonPath,
                                        java.util.Map<java.lang.String,java.lang.Object> variables,
                                        com.jayway.jsonpath.TypeRef<T> typeRef,
                                        org.springframework.http.HttpHeaders headers)

Executes a GraphQL query, parses the returned data, extracts a value using JsonPath, and converts that value into the given type. Uses a TypeRef to specify the expected type, which is useful for Lists and Maps. Be aware that this method can't guarantee type safety.

Type Parameters:

T - The type that the extracted value should be converted to.

Parameters:

query - Query string

jsonPath - JsonPath expression.

variables - A Map of variables

typeRef - A JsonPath TypeRef representing the expected result type.

headers - Request headers represented as a Spring Framework HttpHeaders

Returns:

The extracted value from the result, converted to type T

See Also:

JsonPath syntax docs, Query Variables, Using TypeRef