Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/query.rb

Defined Under Namespace

Classes: Arguments, Context, DirectiveChain, FieldResolutionStrategy, FragmentSpreadResolutionStrategy, InlineFragmentResolutionStrategy, OperationNameMissingError, OperationResolver, SelectionResolver, TypeResolver

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

Instance Method Summary collapse

Constructor Details

#initialize(schema, query_string, context: nil, params: nil, variables: {}, debug: true, validate: true, operation_name: nil) ⇒ Query

Prepare query ‘query_string` on `schema`

Parameters:

  • schema (GraphQL::Schema)
  • query_string (String)
  • 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

  • debug (Boolean) (defaults to: true) —

    if true, errors are raised, if false, errors are put in the ‘errors` key

  • validate (Boolean) (defaults to: true) —

    if true, ‘query_string` will be validated with StaticValidation::Validator

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

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/graphql/query.rb', line 16

def initialize(schema, query_string, context: nil, params: nil, variables: {}, debug: true, validate: true, operation_name: nil)
  @schema = schema
  @debug = debug
  @context = Context.new(context)

  @variables = variables
  if params
    warn("[GraphQL] params option is deprecated for GraphQL::Query#new, use variables instead")
    @variables = params
  end

  @validate = validate
  @operation_name = operation_name
  @fragments = {}
  @operations = {}

  @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.



6
7
8
 
# File 'lib/graphql/query.rb', line 6

def context
  @context
end

#document ⇒ Object (readonly)

Returns the value of attribute document.



6
7
8
 
# File 'lib/graphql/query.rb', line 6

def document
  @document
end

#fragments ⇒ Object (readonly)

Returns the value of attribute fragments.



6
7
8
 
# File 'lib/graphql/query.rb', line 6

def fragments
  @fragments
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



6
7
8
 
# File 'lib/graphql/query.rb', line 6

def schema
  @schema
end

#variables ⇒ Object (readonly)

Returns the value of attribute variables.



6
7
8
 
# File 'lib/graphql/query.rb', line 6

def variables
  @variables
end

Instance Method Details

#result ⇒ Object

Get the result for this query, executing it once



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/graphql/query.rb', line 43

def result
  if @validate && validation_errors.any?
    return { "errors" => validation_errors }
  end

  @result ||= { "data" => execute }

rescue OperationNameMissingError => err
  {"errors" => [{"message" => err.message}]}
rescue StandardError => err
  @debug && raise(err)
  message = "Something went wrong during query execution: #{err}" # \n  #{err.backtrace.join("\n  ")}"
  {"errors" => [{"message" => message}]}
end