Class: GraphQL::Query
- Inherits:
-
Object
- Object
- GraphQL::Query
- Defined in:
- lib/graphql/query.rb,
lib/graphql/query/context.rb,
lib/graphql/query/executor.rb,
lib/graphql/query/arguments.rb,
lib/graphql/query/variables.rb,
lib/graphql/query/literal_input.rb,
lib/graphql/query/base_execution.rb,
lib/graphql/query/serial_execution.rb,
lib/graphql/query/base_execution/value_resolution.rb,
lib/graphql/query/serial_execution/field_resolution.rb,
lib/graphql/query/serial_execution/operation_resolution.rb,
lib/graphql/query/serial_execution/selection_resolution.rb
Defined Under Namespace
Classes: Arguments, BaseExecution, Context, DirectiveChain, Executor, LiteralInput, OperationNameMissingError, SerialExecution, TypeResolver, VariableMissingError, VariableValidationError, Variables
Constant Summary collapse
- DEFAULT_RESOLVE =
If a resolve function returns ‘GraphQL::Query::DEFAULT_RESOLVE`, The executor will send the field’s name to the target object and use the result.
:__default_resolve
Instance Attribute Summary collapse
-
#context ⇒ Object
readonly
Returns the value of attribute context.
-
#debug ⇒ Object
readonly
Returns the value of attribute debug.
-
#document ⇒ Object
readonly
Returns the value of attribute document.
-
#fragments ⇒ Object
readonly
Returns the value of attribute fragments.
-
#operations ⇒ Object
readonly
Returns the value of attribute operations.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
Instance Method Summary collapse
-
#initialize(schema, query_string, context: nil, variables: {}, debug: false, validate: true, operation_name: nil) ⇒ Query
constructor
Prepare query ‘query_string` on `schema`.
-
#result ⇒ Object
Get the result for this query, executing it once.
-
#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?
This is the operation to run for this query.
-
#variables ⇒ GraphQL::Query::Variables
Determine the values for variables of this query, using default values if a value isn’t provided at runtime.
Constructor Details
#initialize(schema, query_string, context: nil, variables: {}, debug: false, validate: true, operation_name: nil) ⇒ Query
Prepare query ‘query_string` on `schema`
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/graphql/query.rb', line 37 def initialize(schema, query_string, context: nil, variables: {}, debug: false, validate: true, operation_name: nil) @schema = schema @debug = debug @context = Context.new(values: context) @validate = validate @operation_name = operation_name @fragments = {} @operations = {} @provided_variables = variables @document = GraphQL.parse(query_string) @document.parts.each do |part| if part.is_a?(GraphQL::Language::Nodes::FragmentDefinition) @fragments[part.name] = part elsif part.is_a?(GraphQL::Language::Nodes::OperationDefinition) @operations[part.name] = part end end end |
Instance Attribute Details
#context ⇒ Object (readonly)
Returns the value of attribute context.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def context @context end |
#debug ⇒ Object (readonly)
Returns the value of attribute debug.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def debug @debug end |
#document ⇒ Object (readonly)
Returns the value of attribute document.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def document @document end |
#fragments ⇒ Object (readonly)
Returns the value of attribute fragments.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def fragments @fragments end |
#operations ⇒ Object (readonly)
Returns the value of attribute operations.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def operations @operations end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
27 28 29 |
# File 'lib/graphql/query.rb', line 27 def schema @schema end |
Instance Method Details
#result ⇒ Object
Get the result for this query, executing it once
57 58 59 60 61 62 63 |
# File 'lib/graphql/query.rb', line 57 def result if @validate && validation_errors.any? return { "errors" => validation_errors } end @result ||= Executor.new(self).result end |
#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?
This is the operation to run for this query. If more than one operation is present, it must be named at runtime.
69 70 71 |
# File 'lib/graphql/query.rb', line 69 def selected_operation @selected_operation ||= find_operation(@operations, @operation_name) end |
#variables ⇒ GraphQL::Query::Variables
Determine the values for variables of this query, using default values if a value isn’t provided at runtime.
Raises if a non-null variable isn’t provided at runtime.
78 79 80 81 82 83 84 |
# File 'lib/graphql/query.rb', line 78 def variables @variables ||= GraphQL::Query::Variables.new( schema, selected_operation.variables, @provided_variables ) end |