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



61
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
# File 'lib/graphql/query.rb', line 61

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_errorsObject

Returns the value of attribute analysis_errors



185
186
187
# File 'lib/graphql/query.rb', line 185

def analysis_errors
  @analysis_errors
end

#contextObject (readonly)

Returns the value of attribute context



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

def context
  @context
end

#operation_namenil, String



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

def operation_name
  @operation_name
end

#provided_variablesObject (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_stringObject

Returns the value of attribute query_string



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

def query_string
  @query_string
end

#root_valueObject (readonly)

Returns the value of attribute root_value



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

def root_value
  @root_value
end

#schemaObject (readonly)

Returns the value of attribute schema



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

def schema
  @schema
end

#validateBoolean



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

def validate
  @validate
end

#wardenObject (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.



170
171
172
# File 'lib/graphql/query.rb', line 170

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

#documentGraphQL::Language::Nodes::Document



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

def document
  with_prepared_ast { @document }
end

#fragmentsObject



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

def fragments
  with_prepared_ast { @fragments }
end

#irep_selectionObject



163
164
165
# File 'lib/graphql/query.rb', line 163

def irep_selection
  @selection ||= internal_representation.operation_definitions[selected_operation.name]
end

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



218
219
220
221
222
223
224
225
# File 'lib/graphql/query.rb', line 218

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



209
210
211
# File 'lib/graphql/query.rb', line 209

def mutation?
  with_prepared_ast { @mutation }
end

#operationsObject



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

def operations
  with_prepared_ast { @operations }
end

#query?Boolean



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

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

See Also:

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


200
201
202
203
204
205
206
207
# File 'lib/graphql/query.rb', line 200

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

#resultHash

Get the result for this query, executing it once



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

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.



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

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

#selected_operationGraphQL::Language::Nodes::OperationDefinition?



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

def selected_operation
  with_prepared_ast { @selected_operation }
end

#selected_operation_nameString?



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

def selected_operation_name
  selected_operation.name
end

#static_errorsObject



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

def static_errors
  validation_errors + analysis_errors + context.errors
end

#valid?Boolean



186
187
188
# File 'lib/graphql/query.rb', line 186

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

#validation_pipelineObject



179
180
181
# File 'lib/graphql/query.rb', line 179

def validation_pipeline
  with_prepared_ast { @validation_pipeline }
end

#variablesGraphQL::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.



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

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