Class: GraphQL::Query
- Inherits:
-
Object
- Object
- GraphQL::Query
- Extended by:
- Delegate
- Includes:
- Tracing::Traceable
- Defined in:
- lib/graphql/query.rb,
lib/graphql/query/result.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
Defined Under Namespace
Modules: ArgumentsCache Classes: Arguments, Context, Executor, InputValidationResult, LiteralInput, NullContext, OperationNameMissingError, Result, SerialExecution, ValidationPipeline, VariableValidationError, Variables
Instance Attribute Summary collapse
-
#analysis_errors ⇒ Object
Returns the value of attribute analysis_errors.
-
#context ⇒ Object
readonly
Returns the value of attribute context.
- #operation_name ⇒ String?
-
#provided_variables ⇒ Object
readonly
Returns the value of attribute provided_variables.
-
#query_string ⇒ Object
Returns the value of attribute query_string.
-
#root_value ⇒ Object
readonly
Returns the value of attribute root_value.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
-
#subscription_topic ⇒ String?
readonly
The triggered event, if this query is a subscription update.
-
#tracers ⇒ Object
readonly
Returns the value of attribute tracers.
-
#validate ⇒ Boolean
If false, static validation is skipped (execution behavior for invalid queries is undefined).
-
#warden ⇒ Object
readonly
Returns the value of attribute warden.
Instance Method Summary collapse
-
#arguments_for(irep_or_ast_node, definition) ⇒ GraphQL::Query::Arguments
private
Node-level cache for calculating arguments.
- #document ⇒ GraphQL::Language::Nodes::Document
- #fragments ⇒ Object
-
#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil) ⇒ Query
constructor
Prepare query
query_string
onschema
. - #irep_selection ⇒ Object
- #merge_filters(only: nil, except: nil) ⇒ void
- #mutation? ⇒ Boolean
- #operations ⇒ Object
- #query? ⇒ Boolean
-
#resolve_type(abstract_type, value = :__undefined__) ⇒ GraphQL::ObjectType?
The runtime type of
value
from Schema#resolve_type. -
#result ⇒ Hash
Get the result for this query, executing it once.
- #result_values=(result_hash) ⇒ Object private
- #selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?
-
#selected_operation_name ⇒ String?
The name of the operation to run (may be inferred).
- #static_errors ⇒ Object
- #subscription? ⇒ Boolean
- #subscription_update? ⇒ Boolean
- #valid? ⇒ Boolean
- #validation_pipeline ⇒ Object
-
#variables ⇒ GraphQL::Query::Variables
Determine the values for variables of this query, using default values if a value isn't provided at runtime.
Methods included from Delegate
Methods included from Tracing::Traceable
Constructor Details
#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil) ⇒ Query
Prepare query query_string
on schema
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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/graphql/query.rb', line 72 def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, subscription_topic: nil, 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, object: root_value, values: context) @subscription_topic = subscription_topic @root_value = root_value @fragments = nil @operations = nil @validate = validate # TODO: remove support for global tracers @tracers = schema.tracers + GraphQL::Tracing.tracers + (context ? context.fetch(:tracers, []) : []) # Support `ctx[:backtrace] = true` for wrapping backtraces if context && context[:backtrace] && !@tracers.include?(GraphQL::Backtrace::Tracer) @tracers << GraphQL::Backtrace::Tracer end @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 if @query_string && @document raise ArgumentError, "Query should only be provided a query string or a document, not both." end # 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_values = nil @executed = false end |
Instance Attribute Details
#analysis_errors ⇒ Object
Returns the value of attribute analysis_errors.
213 214 215 |
# File 'lib/graphql/query.rb', line 213 def analysis_errors @analysis_errors end |
#context ⇒ Object (readonly)
Returns the value of attribute context.
32 33 34 |
# File 'lib/graphql/query.rb', line 32 def context @context end |
#operation_name ⇒ String?
35 36 37 |
# File 'lib/graphql/query.rb', line 35 def operation_name @operation_name end |
#provided_variables ⇒ Object (readonly)
Returns the value of attribute provided_variables.
32 33 34 |
# File 'lib/graphql/query.rb', line 32 def provided_variables @provided_variables end |
#query_string ⇒ Object
Returns the value of attribute query_string.
40 41 42 |
# File 'lib/graphql/query.rb', line 40 def query_string @query_string end |
#root_value ⇒ Object (readonly)
Returns the value of attribute root_value.
32 33 34 |
# File 'lib/graphql/query.rb', line 32 def root_value @root_value end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
32 33 34 |
# File 'lib/graphql/query.rb', line 32 def schema @schema end |
#subscription_topic ⇒ String? (readonly)
Returns the triggered event, if this query is a subscription update.
54 55 56 |
# File 'lib/graphql/query.rb', line 54 def subscription_topic @subscription_topic end |
#tracers ⇒ Object (readonly)
Returns the value of attribute tracers.
59 60 61 |
# File 'lib/graphql/query.rb', line 59 def tracers @tracers end |
#validate ⇒ Boolean
Returns if false, static validation is skipped (execution behavior for invalid queries is undefined).
38 39 40 |
# File 'lib/graphql/query.rb', line 38 def validate @validate end |
#warden ⇒ Object (readonly)
Returns the value of attribute warden.
32 33 34 |
# File 'lib/graphql/query.rb', line 32 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.
198 199 200 |
# File 'lib/graphql/query.rb', line 198 def arguments_for(irep_or_ast_node, definition) @arguments_cache[irep_or_ast_node][definition] end |
#document ⇒ GraphQL::Language::Nodes::Document
43 44 45 |
# File 'lib/graphql/query.rb', line 43 def document with_prepared_ast { @document } end |
#fragments ⇒ Object
140 141 142 |
# File 'lib/graphql/query.rb', line 140 def fragments with_prepared_ast { @fragments } end |
#irep_selection ⇒ Object
188 189 190 191 192 193 |
# File 'lib/graphql/query.rb', line 188 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.
246 247 248 249 250 251 252 253 |
# File 'lib/graphql/query.rb', line 246 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
237 238 239 |
# File 'lib/graphql/query.rb', line 237 def mutation? with_prepared_ast { @mutation } end |
#operations ⇒ Object
144 145 146 |
# File 'lib/graphql/query.rb', line 144 def operations with_prepared_ast { @operations } end |
#query? ⇒ Boolean
241 242 243 |
# File 'lib/graphql/query.rb', line 241 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.
228 229 230 231 232 233 234 235 |
# File 'lib/graphql/query.rb', line 228 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
150 151 152 153 154 155 156 157 |
# File 'lib/graphql/query.rb', line 150 def result if !@executed with_prepared_ast { Execution::Multiplex.run_queries(@schema, [self]) } end @result ||= Query::Result.new(query: self, values: @result_values) end |
#result_values=(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.
131 132 133 134 135 136 137 138 |
# File 'lib/graphql/query.rb', line 131 def result_values=(result_hash) if @executed raise "Invariant: Can't reassign result" else @executed = true @result_values = result_hash end end |
#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?
166 167 168 |
# File 'lib/graphql/query.rb', line 166 def selected_operation with_prepared_ast { @selected_operation } end |
#selected_operation_name ⇒ String?
Returns The name of the operation to run (may be inferred).
48 49 50 51 |
# File 'lib/graphql/query.rb', line 48 def selected_operation_name return nil unless selected_operation selected_operation.name end |
#static_errors ⇒ Object
159 160 161 |
# File 'lib/graphql/query.rb', line 159 def static_errors validation_errors + analysis_errors + context.errors end |
#subscription? ⇒ Boolean
255 256 257 |
# File 'lib/graphql/query.rb', line 255 def subscription? with_prepared_ast { @subscription } end |
#subscription_update? ⇒ Boolean
126 127 128 |
# File 'lib/graphql/query.rb', line 126 def subscription_update? @subscription_topic && subscription? end |
#valid? ⇒ Boolean
214 215 216 |
# File 'lib/graphql/query.rb', line 214 def valid? validation_pipeline.valid? && analysis_errors.none? end |
#validation_pipeline ⇒ Object
207 208 209 |
# File 'lib/graphql/query.rb', line 207 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.
176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/graphql/query.rb', line 176 def variables @variables ||= begin with_prepared_ast { GraphQL::Query::Variables.new( @context, @ast_variables, @provided_variables, ) } end end |