Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Extended by:
Delegate
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/null_context.rb,
lib/graphql/query/literal_input.rb,
lib/graphql/query/arguments_cache.rb,
lib/graphql/query/serial_execution.rb,
lib/graphql/query/validation_pipeline.rb,
lib/graphql/query/input_validation_result.rb,
lib/graphql/query/variable_validation_error.rb,
lib/graphql/query/serial_execution/field_resolution.rb,
lib/graphql/query/serial_execution/value_resolution.rb,
lib/graphql/query/serial_execution/operation_resolution.rb,
lib/graphql/query/serial_execution/selection_resolution.rb

Overview

A combination of query string and Schema instance which can be reduced to a #result.

Defined Under Namespace

Modules: ArgumentsCache Classes: Arguments, Context, Executor, InputValidationResult, LiteralInput, NullContext, OperationNameMissingError, SerialExecution, ValidationPipeline, VariableValidationError, Variables

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Delegate

def_delegators

Constructor Details

#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil) ⇒ Query

Prepare query query_string on schema

Parameters:

  • schema (GraphQL::Schema)
  • query_string (String) (defaults to: nil)
  • context (#[]) (defaults to: nil) —

    an arbitrary hash of values which you can access in Field#resolve

  • variables (Hash) (defaults to: {}) —

    values for $variables in the query

  • operation_name (String) (defaults to: nil) —

    if the query string contains many operations, this is the one which should be executed

  • root_value (Object) (defaults to: nil) —

    the object used to resolve fields on the root type

  • max_depth (Numeric) (defaults to: nil) —

    the maximum number of nested selections allowed for this query (falls back to schema-level value)

  • max_complexity (Numeric) (defaults to: nil) —

    the maximum field complexity for this query (falls back to schema-level value)

  • except (<#call(schema_member, context)>) (defaults to: nil) —

    If provided, objects will be hidden from the schema when .call(schema_member, context) returns truthy

  • only (<#call(schema_member, context)>) (defaults to: nil) —

    If provided, objects will be hidden from the schema when .call(schema_member, context) returns false



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/graphql/query.rb', line 62

def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil)
  @schema = schema
  @filter = schema.default_filter.merge(except: except, only: only)
  @context = Context.new(query: self, values: context)
  @root_value = root_value
  @fragments = nil
  @operations = nil
  @validate = validate

  @analysis_errors = []
  if variables.is_a?(String)
    raise ArgumentError, "Query variables should be a Hash, not a String. Try JSON.parse to prepare variables."
  else
    @provided_variables = variables
  end

  @query_string = query_string || query
  @document = document

  # A two-layer cache of type resolution:
  # { abstract_type => { value => resolved_type } }
  @resolved_types_cache = Hash.new do |h1, k1|
    h1[k1] = Hash.new do |h2, k2|
      h2[k2] = @schema.resolve_type(k1, k2, @context)
    end
  end

  @arguments_cache = ArgumentsCache.build(self)

  # Trying to execute a document
  # with no operations returns an empty hash
  @ast_variables = []
  @mutation = false
  @operation_name = operation_name
  @prepared_ast = false

  @validation_pipeline = nil
  @max_depth = max_depth || schema.max_depth
  @max_complexity = max_complexity || schema.max_complexity

  @result = nil
  @executed = false
end

Instance Attribute Details

#analysis_errors ⇒ Object

Returns the value of attribute analysis_errors.



189
190
191
 
# File 'lib/graphql/query.rb', line 189

def analysis_errors
  @analysis_errors
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



30
31
32
 
# File 'lib/graphql/query.rb', line 30

def context
  @context
end

#operation_name ⇒ nil, String

Returns The operation name provided by client or the one inferred from the document. Used to determine which operation to run.

Returns:

  • (nil, String) —

    The operation name provided by client or the one inferred from the document. Used to determine which operation to run.



33
34
35
 
# File 'lib/graphql/query.rb', line 33

def operation_name
  @operation_name
end

#provided_variables ⇒ Object (readonly)

Returns the value of attribute provided_variables.



30
31
32
 
# File 'lib/graphql/query.rb', line 30

def provided_variables
  @provided_variables
end

#query_string ⇒ Object

Returns the value of attribute query_string.



38
39
40
 
# File 'lib/graphql/query.rb', line 38

def query_string
  @query_string
end

#root_value ⇒ Object (readonly)

Returns the value of attribute root_value.



30
31
32
 
# File 'lib/graphql/query.rb', line 30

def root_value
  @root_value
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



30
31
32
 
# File 'lib/graphql/query.rb', line 30

def schema
  @schema
end

#validate ⇒ Boolean

Returns if false, static validation is skipped (execution behavior for invalid queries is undefined).

Returns:

  • (Boolean) —

    if false, static validation is skipped (execution behavior for invalid queries is undefined)



36
37
38
 
# File 'lib/graphql/query.rb', line 36

def validate
  @validate
end

#warden ⇒ Object (readonly)

Returns the value of attribute warden.



30
31
32
 
# File 'lib/graphql/query.rb', line 30

def warden
  @warden
end

Instance Method Details

#arguments_for(irep_or_ast_node, definition) ⇒ GraphQL::Query::Arguments

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Node-level cache for calculating arguments. Used during execution and query analysis.

Returns:



174
175
176
 
# File 'lib/graphql/query.rb', line 174

def arguments_for(irep_or_ast_node, definition)
  @arguments_cache[irep_or_ast_node][definition]
end

#document ⇒ GraphQL::Language::Nodes::Document

Returns:



41
42
43
 
# File 'lib/graphql/query.rb', line 41

def document
  with_prepared_ast { @document }
end

#fragments ⇒ Object 



116
117
118
 
# File 'lib/graphql/query.rb', line 116

def fragments
  with_prepared_ast { @fragments }
end

#irep_selection ⇒ Object 



164
165
166
167
168
169
 
# File 'lib/graphql/query.rb', line 164

def irep_selection
  @selection ||= begin
    return nil unless selected_operation
    internal_representation.operation_definitions[selected_operation.name]
  end
end

#merge_filters(only: nil, except: nil) ⇒ void

This method returns an undefined value.



222
223
224
225
226
227
228
229
 
# File 'lib/graphql/query.rb', line 222

def merge_filters(only: nil, except: nil)
  if @prepared_ast
    raise "Can't add filters after preparing the query"
  else
    @filter = @filter.merge(only: only, except: except)
  end
  nil
end

#mutation? ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/graphql/query.rb', line 213

def mutation?
  with_prepared_ast { @mutation }
end

#operations ⇒ Object 



120
121
122
 
# File 'lib/graphql/query.rb', line 120

def operations
  with_prepared_ast { @operations }
end

#query? ⇒ Boolean

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/graphql/query.rb', line 217

def query?
  with_prepared_ast { @query }
end

#resolve_type(abstract_type, value = :__undefined__) ⇒ GraphQL::ObjectType?

Returns The runtime type of value from Schema#resolve_type.

Parameters:

Returns:

See Also:

  • to apply filtering from `only` / `except`


204
205
206
207
208
209
210
211
 
# File 'lib/graphql/query.rb', line 204

def resolve_type(abstract_type, value = :__undefined__)
  if value.is_a?(Symbol) && value == :__undefined__
    # Old method signature
    value = abstract_type
    abstract_type = nil
  end
  @resolved_types_cache[abstract_type][value]
end

#result ⇒ Hash

Get the result for this query, executing it once

Returns:

  • (Hash) —

    A GraphQL response, with "data" and/or "errors" keys



126
127
128
129
130
131
132
133
 
# File 'lib/graphql/query.rb', line 126

def result
  if !@executed
    with_prepared_ast {
      Execution::Multiplex.run_queries(@schema, [self])
    }
  end
  @result
end

#result=(result_hash) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



107
108
109
110
111
112
113
114
 
# File 'lib/graphql/query.rb', line 107

def result=(result_hash)
  if @executed
    raise "Invariant: Can't reassign result"
  else
    @executed = true
    @result = result_hash
  end
end

#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?

Returns:



142
143
144
 
# File 'lib/graphql/query.rb', line 142

def selected_operation
  with_prepared_ast { @selected_operation }
end

#selected_operation_name ⇒ String?

Returns The name of the operation to run (may be inferred).

Returns:

  • (String, nil) —

    The name of the operation to run (may be inferred)



46
47
48
49
 
# File 'lib/graphql/query.rb', line 46

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errors ⇒ Object 



135
136
137
 
# File 'lib/graphql/query.rb', line 135

def static_errors
  validation_errors + analysis_errors + context.errors
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/graphql/query.rb', line 190

def valid?
  validation_pipeline.valid? && analysis_errors.none?
end

#validation_pipeline ⇒ Object 



183
184
185
 
# File 'lib/graphql/query.rb', line 183

def validation_pipeline
  with_prepared_ast { @validation_pipeline }
end

#variables ⇒ GraphQL::Query::Variables

Determine the values for variables of this query, using default values if a value isn't provided at runtime.

If some variable is invalid, errors are added to #validation_errors.

Returns:



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/graphql/query.rb', line 152

def variables
  @variables ||= begin
    with_prepared_ast {
      GraphQL::Query::Variables.new(
        @context,
        @ast_variables,
        @provided_variables,
      )
    }
  end
end