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/serial_execution.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: NullExcept Classes: Arguments, Context, ExecutionCall, Executor, InputValidationResult, LiteralInput, OperationNameMissingError, SerialExecution, VariableValidationError, Variables
Instance Attribute Summary collapse
-
#context ⇒ Object
readonly
Returns the value of attribute context.
-
#document ⇒ Object
readonly
Returns the value of attribute document.
-
#fragments ⇒ Object
readonly
Returns the value of attribute fragments.
-
#max_depth ⇒ Object
readonly
Returns the value of attribute max_depth.
-
#operations ⇒ Object
readonly
Returns the value of attribute operations.
-
#query_string ⇒ Object
readonly
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.
- #selected_operation ⇒ GraphQL::Language::Nodes::Document? readonly
-
#warden ⇒ Object
readonly
Returns the value of attribute warden.
Instance Method Summary collapse
-
#analysis_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes.
-
#arguments_for(irep_node, definition) ⇒ GraphQL::Query::Arguments
Node-level cache for calculating arguments.
- #get_field(type, name) ⇒ Object
- #get_type(type_name) ⇒ Object
-
#initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) ⇒ Query
constructor
Prepare query
query_string
onschema
. -
#internal_representation ⇒ Hash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -
Irep node pairs.
- #possible_types(type) ⇒ Object
- #resolve_type(type) ⇒ Object
-
#result ⇒ Object
Get the result for this query, executing it once.
- #selections(nodes, type) ⇒ Object
- #valid? ⇒ Boolean
-
#validation_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes.
-
#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 = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) ⇒ Query
Prepare query query_string
on schema
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 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 |
# File 'lib/graphql/query.rb', line 40 def initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) fail ArgumentError, "a query string or document is required" unless query_string || document @schema = schema @warden = GraphQL::Schema::Warden.new(schema, except) @max_depth = max_depth || schema.max_depth @max_complexity = max_complexity || schema.max_complexity @query_analyzers = schema.query_analyzers.dup if @max_depth @query_analyzers << GraphQL::Analysis::MaxQueryDepth.new(@max_depth) end if @max_complexity @query_analyzers << GraphQL::Analysis::MaxQueryComplexity.new(@max_complexity) end @context = Context.new(query: self, values: context) @root_value = root_value @operation_name = operation_name @fragments = {} @operations = {} @provided_variables = variables @query_string = query_string @document = document || GraphQL.parse(query_string) @document.definitions.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 else raise GraphQL::ExecutionError, "GraphQL query cannot contain a schema definition" end end @arguments_cache = Hash.new { |h, k| h[k] = {} } @validation_errors = [] @analysis_errors = [] @internal_representation = nil @was_validated = false # Trying to execute a document # with no operations returns an empty hash @ast_variables = [] if @operations.any? @selected_operation = find_operation(@operations, @operation_name) if @selected_operation.nil? @validation_errors << GraphQL::Query::OperationNameMissingError.new(@operations.keys) else @ast_variables = @selected_operation.variables end end end |
Instance Attribute Details
#context ⇒ Object (readonly)
Returns the value of attribute context.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def context @context end |
#document ⇒ Object (readonly)
Returns the value of attribute document.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def document @document end |
#fragments ⇒ Object (readonly)
Returns the value of attribute fragments.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def fragments @fragments end |
#max_depth ⇒ Object (readonly)
Returns the value of attribute max_depth.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def max_depth @max_depth end |
#operations ⇒ Object (readonly)
Returns the value of attribute operations.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def operations @operations end |
#query_string ⇒ Object (readonly)
Returns the value of attribute query_string.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def query_string @query_string end |
#root_value ⇒ Object (readonly)
Returns the value of attribute root_value.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def root_value @root_value end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def schema @schema end |
#selected_operation ⇒ GraphQL::Language::Nodes::Document? (readonly)
104 105 106 |
# File 'lib/graphql/query.rb', line 104 def selected_operation @selected_operation end |
#warden ⇒ Object (readonly)
Returns the value of attribute warden.
28 29 30 |
# File 'lib/graphql/query.rb', line 28 def warden @warden end |
Instance Method Details
#analysis_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes
140 141 142 143 |
# File 'lib/graphql/query.rb', line 140 def analysis_errors valid? @analysis_errors end |
#arguments_for(irep_node, definition) ⇒ GraphQL::Query::Arguments
Node-level cache for calculating arguments. Used during execution and query analysis.
147 148 149 150 151 152 153 154 155 |
# File 'lib/graphql/query.rb', line 147 def arguments_for(irep_node, definition) @arguments_cache[irep_node][definition] ||= begin GraphQL::Query::LiteralInput.from_arguments( irep_node.ast_node.arguments, definition.arguments, self.variables ) end end |
#get_field(type, name) ⇒ Object
179 180 181 |
# File 'lib/graphql/query.rb', line 179 def get_field(type, name) @warden.get_field(type, name) end |
#get_type(type_name) ⇒ Object
175 176 177 |
# File 'lib/graphql/query.rb', line 175 def get_type(type_name) @warden.get_type(type_name) end |
#internal_representation ⇒ Hash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -
Returns Irep node pairs.
126 127 128 129 |
# File 'lib/graphql/query.rb', line 126 def internal_representation valid? @internal_representation end |
#possible_types(type) ⇒ Object
183 184 185 |
# File 'lib/graphql/query.rb', line 183 def possible_types(type) @warden.possible_types(type) end |
#resolve_type(type) ⇒ Object
187 188 189 |
# File 'lib/graphql/query.rb', line 187 def resolve_type(type) @schema.resolve_type(type, @context) end |
#result ⇒ Object
Get the result for this query, executing it once
92 93 94 95 96 97 98 |
# File 'lib/graphql/query.rb', line 92 def result @result ||= begin instrumenters = @schema.instrumenters[:query] execution_call = ExecutionCall.new(self, instrumenters) execution_call.call end end |
#selections(nodes, type) ⇒ Object
170 171 172 173 |
# File 'lib/graphql/query.rb', line 170 def selections(nodes, type) @selections ||= Hash.new { |h, k| h[k] = GraphQL::InternalRepresentation::Selections.build(self, k) } @selections[nodes][type] end |
#valid? ⇒ Boolean
160 161 162 163 164 165 166 167 168 |
# File 'lib/graphql/query.rb', line 160 def valid? @was_validated ||= begin @was_validated = true @valid = document_valid? && query_valid? && variables.errors.none? true end @valid end |
#validation_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes
133 134 135 136 |
# File 'lib/graphql/query.rb', line 133 def validation_errors valid? @validation_errors 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.
112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/graphql/query.rb', line 112 def variables @variables ||= begin vars = GraphQL::Query::Variables.new( @schema, @warden, @ast_variables, @provided_variables, ) @validation_errors.concat(vars.errors) vars end end |