Class: GraphQL::Query

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

Defined Under Namespace

Classes: Arguments, Context, DirectiveChain, FieldResolutionStrategy, FragmentSpreadResolutionStrategy, InlineFragmentResolutionStrategy, 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: {}, debug: true, validate: true) ⇒ Query

Prepare query ‘query_string` on Schema `schema`

Parameters:

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

    (default: ‘nil`) an arbitrary hash of values which you can access in Field#resolve

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

    (default: ‘{}`) values for `$variables` in the query

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

    (default: ‘true`) if true, errors are raised, if false, errors are put in the `errors` key

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

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/graph_ql/query.rb', line 15

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

  @document = GraphQL.parse(@query_string)
  @document.parts.each do |part|
    if part.is_a?(GraphQL::Nodes::FragmentDefinition)
      @fragments[part.name] = part
    elsif part.is_a?(GraphQL::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/graph_ql/query.rb', line 6

def context
  @context
end

#document ⇒ Object (readonly)

Returns the value of attribute document.



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

def document
  @document
end

#fragments ⇒ Object (readonly)

Returns the value of attribute fragments.



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

def fragments
  @fragments
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



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

def params
  @params
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



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

def schema
  @schema
end

Instance Method Details

#result ⇒ Object

Get the result for this query, executing it once



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/graph_ql/query.rb', line 36

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

  @result ||= {
    "data" => execute,
  }
rescue StandardError => err
  if @debug
    raise err
  else
    message = "Something went wrong during query execution: #{err}" # \n  #{err.backtrace.join("\n  ")}"
    {"errors" => [{"message" => message}]}
  end
end