Class: GraphQL::Schema

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, FindInheritedValue, Member::AcceptsDefinition, Member::HasAstNode
Includes:
Define::InstanceDefinable
Defined in:
lib/graphql/schema.rb,
lib/graphql/schema/enum.rb,
lib/graphql/schema/list.rb,
lib/graphql/schema/field.rb,
lib/graphql/schema/union.rb,
lib/graphql/schema/finder.rb,
lib/graphql/schema/loader.rb,
lib/graphql/schema/member.rb,
lib/graphql/schema/object.rb,
lib/graphql/schema/scalar.rb,
lib/graphql/schema/warden.rb,
lib/graphql/schema/printer.rb,
lib/graphql/schema/timeout.rb,
lib/graphql/schema/wrapper.rb,
lib/graphql/schema/argument.rb,
lib/graphql/schema/mutation.rb,
lib/graphql/schema/non_null.rb,
lib/graphql/schema/resolver.rb,
lib/graphql/schema/directive.rb,
lib/graphql/schema/interface.rb,
lib/graphql/schema/null_mask.rb,
lib/graphql/schema/traversal.rb,
lib/graphql/schema/enum_value.rb,
lib/graphql/schema/validation.rb,
lib/graphql/schema/input_object.rb,
lib/graphql/schema/subscription.rb,
lib/graphql/schema/member/scoped.rb,
lib/graphql/schema/built_in_types.rb,
lib/graphql/schema/directive/skip.rb,
lib/graphql/schema/possible_types.rb,
lib/graphql/schema/base_64_encoder.rb,
lib/graphql/schema/field_extension.rb,
lib/graphql/schema/late_bound_type.rb,
lib/graphql/schema/member/has_path.rb,
lib/graphql/schema/type_expression.rb,
lib/graphql/schema/type_membership.rb,
lib/graphql/schema/middleware_chain.rb,
lib/graphql/schema/directive/feature.rb,
lib/graphql/schema/directive/include.rb,
lib/graphql/schema/member/build_type.rb,
lib/graphql/schema/member/has_fields.rb,
lib/graphql/schema/rescue_middleware.rb,
lib/graphql/schema/default_type_error.rb,
lib/graphql/schema/invalid_type_error.rb,
lib/graphql/schema/timeout_middleware.rb,
lib/graphql/schema/unique_within_type.rb,
lib/graphql/schema/catchall_middleware.rb,
lib/graphql/schema/default_parse_error.rb,
lib/graphql/schema/directive/transform.rb,
lib/graphql/schema/member/has_ast_node.rb,
lib/graphql/schema/directive/deprecated.rb,
lib/graphql/schema/find_inherited_value.rb,
lib/graphql/schema/introspection_system.rb,
lib/graphql/schema/member/has_arguments.rb,
lib/graphql/schema/build_from_definition.rb,
lib/graphql/schema/field/scope_extension.rb,
lib/graphql/schema/member/instrumentation.rb,
lib/graphql/schema/member/relay_shortcuts.rb,
lib/graphql/schema/member/validates_input.rb,
lib/graphql/schema/relay_classic_mutation.rb,
lib/graphql/schema/member/base_dsl_methods.rb,
lib/graphql/schema/member/accepts_definition.rb,
lib/graphql/schema/member/graphql_type_names.rb,
lib/graphql/schema/resolver/has_payload_type.rb,
lib/graphql/schema/field/connection_extension.rb,
lib/graphql/schema/member/type_system_helpers.rb,
lib/graphql/schema/member/cached_graphql_definition.rb,
lib/graphql/schema/build_from_definition/resolve_map.rb,
lib/graphql/schema/build_from_definition/resolve_map/default_resolve.rb

Overview

Extend this class to define GraphQL enums in your schema.

By default, GraphQL enum values are translated into Ruby strings. You can provide a custom value with the value: keyword.

Examples:

# equivalent to
# enum PizzaTopping {
#   MUSHROOMS
#   ONIONS
#   PEPPERS
# }
class PizzaTopping < GraphQL::Enum
  value :MUSHROOMS
  value :ONIONS
  value :PEPPERS
end

Defined Under Namespace

Modules: Base64Encoder, BuildFromDefinition, CatchallMiddleware, DefaultParseError, DefaultTypeError, FindInheritedValue, Interface, Loader, NullMask, ResolveTypeWithType, TypeExpression, UniqueWithinType Classes: Argument, CyclicalDefinitionError, Directive, Enum, EnumValue, Field, FieldExtension, Finder, InputObject, IntrospectionSystem, InvalidDocumentError, InvalidTypeError, LateBoundType, List, Member, MiddlewareChain, Mutation, NonNull, Object, PossibleTypes, Printer, RelayClassicMutation, RescueMiddleware, Resolver, Scalar, Subscription, Timeout, TimeoutMiddleware, Traversal, TypeMembership, Union, UnresolvedLateBoundTypeError, Validation, Warden, Wrapper

Constant Summary collapse

DYNAMIC_FIELDS = 
["__type", "__typename", "__schema"].freeze
BUILT_IN_TYPES = 
{
  "Int" => GraphQL::Types::Int,
  "String" => GraphQL::Types::String,
  "Float" => GraphQL::Types::Float,
  "Boolean" => GraphQL::Types::Boolean,
  "ID" => GraphQL::Types::ID,
}

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Define::InstanceDefinable

#metadata, #redefine

Constructor Details

#initialize ⇒ Schema

Returns a new instance of Schema.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/graphql/schema.rb', line 198

def initialize
  @tracers = []
  @definition_error = nil
  @orphan_types = []
  @directives = {}
  self.class.default_directives.each do |name, dir|
    @directives[name] = dir.graphql_definition
  end
  @static_validator = GraphQL::StaticValidation::Validator.new(schema: self)
  @middleware = MiddlewareChain.new(final_step: GraphQL::Execution::Execute::FieldResolveStep)
  @query_analyzers = []
  @multiplex_analyzers = []
  @resolve_type_proc = nil
  @object_from_id_proc = nil
  @id_from_object_proc = nil
  @type_error_proc = DefaultTypeError
  @parse_error_proc = DefaultParseError
  @instrumenters = Hash.new { |h, k| h[k] = [] }
  @lazy_methods = GraphQL::Execution::Lazy::LazyMethodMap.new
  @lazy_methods.set(GraphQL::Execution::Lazy, :value)
  @cursor_encoder = Base64Encoder  # Default to the built-in execution strategy:

  @analysis_engine = GraphQL::Analysis
  @query_execution_strategy = self.class.default_execution_strategy
  @mutation_execution_strategy = self.class.default_execution_strategy
  @subscription_execution_strategy = self.class.default_execution_strategy
  @default_mask = GraphQL::Schema::NullMask
  @rebuilding_artifacts = false
  @context_class = GraphQL::Query::Context
  @introspection_namespace = nil
  @introspection_system = nil
  @interpreter = false
  @error_bubbling = false
  @disable_introspection_entry_points = false
  @disable_schema_introspection_entry_point = false
  @disable_type_introspection_entry_point = false
end

Class Attribute Details

.analysis_engine ⇒ Object 



1198
1199
1200
 
# File 'lib/graphql/schema.rb', line 1198

def analysis_engine
  @analysis_engine || find_inherited_value(:analysis_engine, GraphQL::Analysis)
end

.connections ⇒ GraphQL::Pagination::Connections

Returns if installed.

Returns:



949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/graphql/schema.rb', line 949

def connections
  if defined?(@connections)
    @connections
  else
    inherited_connections = find_inherited_value(:connections, nil)    # This schema is part of an inheritance chain which is using new connections,
    # make a new instance, so we don't pollute the upstream one.

    if inherited_connections
      @connections = Pagination::Connections.new(schema: self)
    else
      nil
    end
  end
end

.default_execution_strategy ⇒ Object 



1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/graphql/schema.rb', line 1291

def default_execution_strategy
  if superclass <= GraphQL::Schema
    superclass.default_execution_strategy
  else
    @default_execution_strategy ||= GraphQL::Execution::Execute
  end
end

.error_bubbling(new_error_bubbling = nil) ⇒ Object 



1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/graphql/schema.rb', line 1216

def error_bubbling(new_error_bubbling = nil)
  if !new_error_bubbling.nil?
    @error_bubbling = new_error_bubbling
  else
    @error_bubbling.nil? ? find_inherited_value(:error_bubbling) : @error_bubbling
  end
end

.error_handler ⇒ GraphQL::Execution::Errors, Class<GraphQL::Execution::Errors::NullErrorHandler>

Returns:



1432
1433
1434
 
# File 'lib/graphql/schema.rb', line 1432

def error_handler
  @error_handler ||= GraphQL::Execution::Errors::NullErrorHandler
end

.interpreter=(value) ⇒ Object (writeonly)

Sets the attribute interpreter

Parameters:

  • value —

    the value to set the attribute interpreter to.



1214
1215
1216
 
# File 'lib/graphql/schema.rb', line 1214

def interpreter=(value)
  @interpreter = value
end

.max_complexity(max_complexity = nil) ⇒ Object 



1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/graphql/schema.rb', line 1186

def max_complexity(max_complexity = nil)
  if max_complexity
    @max_complexity = max_complexity
  elsif defined?(@max_complexity)
    @max_complexity
  else
    find_inherited_value(:max_complexity)
  end
end

.max_depth(new_max_depth = nil) ⇒ Object 



1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'lib/graphql/schema.rb', line 1228

def max_depth(new_max_depth = nil)
  if new_max_depth
    @max_depth = new_max_depth
  elsif defined?(@max_depth)
    @max_depth
  else
    find_inherited_value(:max_depth)
  end
end

.subscriptions ⇒ GraphQL::Subscriptions

Returns:



798
799
800
 
# File 'lib/graphql/schema.rb', line 798

def subscriptions
  @subscriptions
end

Instance Attribute Details

#analysis_engine ⇒ Object

Returns the value of attribute analysis_engine.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def analysis_engine
  @analysis_engine
end

#ast_node ⇒ Object

Returns the value of attribute ast_node.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def ast_node
  @ast_node
end

#connections ⇒ Object

Returns the value of attribute connections.



779
780
781
 
# File 'lib/graphql/schema.rb', line 779

def connections
  @connections
end

#context_class ⇒ Class

Returns Instantiated for each query.

Returns:

  • (Class) —

    Instantiated for each query

See Also:

  • The parent class of these classes


159
160
161
 
# File 'lib/graphql/schema.rb', line 159

def context_class
  @context_class
end

#cursor_encoder ⇒ Object

Returns the value of attribute cursor_encoder.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def cursor_encoder
  @cursor_encoder
end

#default_mask ⇒ <#call(member, ctx)>

Returns A callable for filtering members of the schema.

Returns:

  • (<#call(member, ctx)>) —

    A callable for filtering members of the schema

See Also:

  • for query-specific filters with `except:`


155
156
157
 
# File 'lib/graphql/schema.rb', line 155

def default_mask
  @default_mask
end

#default_max_page_size ⇒ Object

Returns the value of attribute default_max_page_size.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def default_max_page_size
  @default_max_page_size
end

#directives ⇒ Object

Returns the value of attribute directives.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def directives
  @directives
end

#disable_introspection_entry_points ⇒ Object

[Boolean] True if this object disables the introspection entry point fields



162
163
164
 
# File 'lib/graphql/schema.rb', line 162

def disable_introspection_entry_points
  @disable_introspection_entry_points
end

#disable_schema_introspection_entry_point ⇒ Object

[Boolean] True if this object disables the __schema introspection entry point field



169
170
171
 
# File 'lib/graphql/schema.rb', line 169

def disable_schema_introspection_entry_point
  @disable_schema_introspection_entry_point
end

#disable_type_introspection_entry_point ⇒ Object

[Boolean] True if this object disables the __type introspection entry point field



176
177
178
 
# File 'lib/graphql/schema.rb', line 176

def disable_type_introspection_entry_point
  @disable_type_introspection_entry_point
end

#error_bubbling ⇒ Object

[Boolean] True if this object bubbles validation errors up from a field into its parent InputObject, if there is one.



144
145
146
 
# File 'lib/graphql/schema.rb', line 144

def error_bubbling
  @error_bubbling
end

#id_from_object_proc ⇒ Object (readonly)

Returns the value of attribute id_from_object_proc.



196
197
198
 
# File 'lib/graphql/schema.rb', line 196

def id_from_object_proc
  @id_from_object_proc
end

#instrumenters ⇒ Object

Returns the value of attribute instrumenters.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def instrumenters
  @instrumenters
end

#interpreter=(value) ⇒ Object (writeonly)

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. 



242
243
244
 
# File 'lib/graphql/schema.rb', line 242

def interpreter=(value)
  @interpreter = value
end

#introspection_namespace ⇒ Object

Returns the value of attribute introspection_namespace.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def introspection_namespace
  @introspection_namespace
end

#lazy_methods ⇒ Object

Returns the value of attribute lazy_methods.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def lazy_methods
  @lazy_methods
end

#max_complexity ⇒ Object

Returns the value of attribute max_complexity.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def max_complexity
  @max_complexity
end

#max_depth ⇒ Object

Returns the value of attribute max_depth.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def max_depth
  @max_depth
end

#middleware ⇒ MiddlewareChain

Returns MiddlewareChain which is applied to fields during execution.

Returns:

  • (MiddlewareChain) —

    MiddlewareChain which is applied to fields during execution



151
152
153
 
# File 'lib/graphql/schema.rb', line 151

def middleware
  @middleware
end

#multiplex_analyzers ⇒ Object

Returns the value of attribute multiplex_analyzers.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def multiplex_analyzers
  @multiplex_analyzers
end

#mutation ⇒ Object

Returns the value of attribute mutation.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def mutation
  @mutation
end

#mutation_execution_strategy ⇒ Object

Returns the value of attribute mutation_execution_strategy.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def mutation_execution_strategy
  @mutation_execution_strategy
end

#object_from_id_proc ⇒ Object (readonly)

Returns the value of attribute object_from_id_proc.



196
197
198
 
# File 'lib/graphql/schema.rb', line 196

def object_from_id_proc
  @object_from_id_proc
end

#orphan_types ⇒ Object

Returns the value of attribute orphan_types.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def orphan_types
  @orphan_types
end

#query ⇒ Object

Returns the value of attribute query.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def query
  @query
end

#query_analyzers ⇒ Object

Returns the value of attribute query_analyzers.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def query_analyzers
  @query_analyzers
end

#query_execution_strategy ⇒ Object

Returns the value of attribute query_execution_strategy.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def query_execution_strategy
  @query_execution_strategy
end

#raise_definition_error ⇒ Object

Returns the value of attribute raise_definition_error.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def raise_definition_error
  @raise_definition_error
end

#resolve_type_proc ⇒ Object (readonly)

Returns the value of attribute resolve_type_proc.



196
197
198
 
# File 'lib/graphql/schema.rb', line 196

def resolve_type_proc
  @resolve_type_proc
end

#static_validator ⇒ Object (readonly)

Returns the value of attribute static_validator.



196
197
198
 
# File 'lib/graphql/schema.rb', line 196

def static_validator
  @static_validator
end

#subscription ⇒ Object

Returns the value of attribute subscription.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def subscription
  @subscription
end

#subscription_execution_strategy ⇒ Object

Returns the value of attribute subscription_execution_strategy.



131
132
133
 
# File 'lib/graphql/schema.rb', line 131

def subscription_execution_strategy
  @subscription_execution_strategy
end

#subscriptions ⇒ GraphQL::Subscriptions

Single, long-lived instance of the provided subscriptions class, if there is one.

Returns:



148
149
150
 
# File 'lib/graphql/schema.rb', line 148

def subscriptions
  @subscriptions
end

#tracers ⇒ Array<#trace(key, data)> (readonly)

Returns Tracers applied to every query.

Returns:

  • (Array<#trace(key, data)>) —

    Tracers applied to every query

See Also:

  • for query-specific tracers


192
193
194
 
# File 'lib/graphql/schema.rb', line 192

def tracers
  @tracers
end

Class Method Details

.accessible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean) 


1365
1366
1367
 
# File 'lib/graphql/schema.rb', line 1365

def accessible?(member, ctx)
  member.type_class.accessible?(ctx)
end

.after_lazy(value) ⇒ 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.

Call the given block at the right time, either: - Right away, if value is not registered with lazy_resolve - After resolving value, if it’s registered with lazy_resolve (eg, Promise)



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
 
# File 'lib/graphql/schema.rb', line 1571

def after_lazy(value)
  if lazy?(value)
    GraphQL::Execution::Lazy.new do
      result = sync_lazy(value)      # The returned result might also be lazy, so check it, too

      after_lazy(result) do |final_result|
        yield(final_result) if block_given?
      end
    end
  else
    yield(value) if block_given?
  end
end

.as_json(only: nil, except: nil, context: {}) ⇒ Hash

Return the Hash response of Introspection::INTROSPECTION_QUERY.

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (Hash) —

    GraphQL result



812
813
814
 
# File 'lib/graphql/schema.rb', line 812

def as_json(only: nil, except: nil, context: {})
  execute(Introspection::INTROSPECTION_QUERY, only: only, except: except, context: context).to_h
end

.context_class(new_context_class = nil) ⇒ Object 



1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/graphql/schema.rb', line 1299

def context_class(new_context_class = nil)
  if new_context_class
    @context_class = new_context_class
  else
    @context_class || find_inherited_value(:context_class, GraphQL::Query::Context)
  end
end

.cursor_encoder(new_encoder = nil) ⇒ Object 



1145
1146
1147
1148
1149
1150
 
# File 'lib/graphql/schema.rb', line 1145

def cursor_encoder(new_encoder = nil)
  if new_encoder
    @cursor_encoder = new_encoder
  end
  @cursor_encoder || find_inherited_value(:cursor_encoder, Base64Encoder)
end

.default_directives ⇒ Object 



1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/graphql/schema.rb', line 1467

def default_directives
  {
    "include" => GraphQL::Schema::Directive::Include,
    "skip" => GraphQL::Schema::Directive::Skip,
    "deprecated" => GraphQL::Schema::Directive::Deprecated,
  }
end

.default_filter ⇒ Object 



843
844
845
 
# File 'lib/graphql/schema.rb', line 843

def default_filter
  GraphQL::Filter.new(except: default_mask)
end

.default_mask(new_mask = nil) ⇒ Object 



847
848
849
850
851
852
853
 
# File 'lib/graphql/schema.rb', line 847

def default_mask(new_mask = nil)
  if new_mask
    @own_default_mask = new_mask
  else
    @own_default_mask || find_inherited_value(:default_mask, Schema::NullMask)
  end
end

.default_max_page_size(new_default_max_page_size = nil) ⇒ Object 



1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/graphql/schema.rb', line 1152

def default_max_page_size(new_default_max_page_size = nil)
  if new_default_max_page_size
    @default_max_page_size = new_default_max_page_size
  else
    @default_max_page_size || find_inherited_value(:default_max_page_size)
  end
end

.directive(new_directive) ⇒ Object

Attach a single directive to this schema

Parameters:

  • new_directive (Class) 


1462
1463
1464
1465
 
# File 'lib/graphql/schema.rb', line 1462

def directive(new_directive)
  add_type_and_traverse(new_directive, root: false)
  own_directives[new_directive.graphql_name] = new_directive
end

.directives(new_directives = nil) ⇒ Object

Add several directives at once

Parameters:

  • new_directives (Class) (defaults to: nil) 


1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/graphql/schema.rb', line 1452

def directives(new_directives = nil)
  if new_directives
    new_directives.each { |d| directive(d) }
  end

  find_inherited_value(:directives, default_directives).merge(own_directives)
end

.disable_introspection_entry_points ⇒ Object 



1238
1239
1240
1241
1242
 
# File 'lib/graphql/schema.rb', line 1238

def disable_introspection_entry_points
  @disable_introspection_entry_points = true  # TODO: this clears the cache made in `def types`. But this is not a great solution.

  @introspection_system = nil
end

.disable_introspection_entry_points? ⇒ Boolean

Returns:

  • (Boolean) 


1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/graphql/schema.rb', line 1256

def disable_introspection_entry_points?
  if instance_variable_defined?(:@disable_introspection_entry_points)
    @disable_introspection_entry_points
  else
    find_inherited_value(:disable_introspection_entry_points?, false)
  end
end

.disable_schema_introspection_entry_point ⇒ Object 



1244
1245
1246
1247
1248
 
# File 'lib/graphql/schema.rb', line 1244

def disable_schema_introspection_entry_point
  @disable_schema_introspection_entry_point = true  # TODO: this clears the cache made in `def types`. But this is not a great solution.

  @introspection_system = nil
end

.disable_schema_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/graphql/schema.rb', line 1264

def disable_schema_introspection_entry_point?
  if instance_variable_defined?(:@disable_schema_introspection_entry_point)
    @disable_schema_introspection_entry_point
  else
    find_inherited_value(:disable_schema_introspection_entry_point?, false)
  end
end

.disable_type_introspection_entry_point ⇒ Object 



1250
1251
1252
1253
1254
 
# File 'lib/graphql/schema.rb', line 1250

def disable_type_introspection_entry_point
  @disable_type_introspection_entry_point = true  # TODO: this clears the cache made in `def types`. But this is not a great solution.

  @introspection_system = nil
end

.disable_type_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/graphql/schema.rb', line 1272

def disable_type_introspection_entry_point?
  if instance_variable_defined?(:@disable_type_introspection_entry_point)
    @disable_type_introspection_entry_point
  else
    find_inherited_value(:disable_type_introspection_entry_point?, false)
  end
end

.execute(query_str = nil, **kwargs) ⇒ Hash

Execute a query on itself.

Returns:

  • (Hash) —

    query result, ready to be serialized as JSON

See Also:

  • for arguments.


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/graphql/schema.rb', line 1514

def execute(query_str = nil, **kwargs)
  if query_str
    kwargs[:query] = query_str
  end  # Some of the query context _should_ be passed to the multiplex, too

  multiplex_context = if (ctx = kwargs[:context])
    {
      backtrace: ctx[:backtrace],
      tracers: ctx[:tracers],
    }
  else
    {}
  end  # Since we're running one query, don't run a multiplex-level complexity analyzer

  all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context)
  all_results[0]
end

.find(path) ⇒ Object 



831
832
833
834
835
836
837
 
# File 'lib/graphql/schema.rb', line 831

def find(path)
  if !@finder
    @find_cache = {}
    @finder ||= GraphQL::Schema::Finder.new(self)
  end
  @find_cache[path] ||= @finder.find(path)
end

.from_definition(definition_or_path, default_resolve: BuildFromDefinition::DefaultResolve, interpreter: true, parser: BuildFromDefinition::DefaultParser, using: {}) ⇒ Class

Create schema from an IDL schema or file containing an IDL definition.

Parameters:

  • definition_or_path (String) —

    A schema definition string, or a path to a file containing the definition

  • default_resolve (<#call(type, field, obj, args, ctx)>) (defaults to: BuildFromDefinition::DefaultResolve) —

    A callable for handling field resolution

  • parser (Object) (defaults to: BuildFromDefinition::DefaultParser) —

    An object for handling definition string parsing (must respond to parse)

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

    Plugins to attach to the created schema with use(key, value)

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

    If false, the legacy Execution::Execute runtime will be used

Returns:

  • (Class) —

    the schema described by document



718
719
720
721
722
723
724
725
726
 
# File 'lib/graphql/schema.rb', line 718

def self.from_definition(definition_or_path, default_resolve: BuildFromDefinition::DefaultResolve, interpreter: true, parser: BuildFromDefinition::DefaultParser, using: {})
  # If the file ends in `.graphql`, treat it like a filepath
  definition = if definition_or_path.end_with?(".graphql")
    File.read(definition_or_path)
  else
    definition_or_path
  end
  GraphQL::Schema::BuildFromDefinition.from_definition(definition, default_resolve: default_resolve, parser: parser, using: using, interpreter: interpreter)
end

.from_introspection(introspection_result) ⇒ GraphQL::Schema

Create schema with the result of an introspection query.

Parameters:

Returns:



707
708
709
 
# File 'lib/graphql/schema.rb', line 707

def self.from_introspection(introspection_result)
  GraphQL::Schema::Loader.load(introspection_result)
end

.get_field(type_or_name, field_name) ⇒ Object 



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/graphql/schema.rb', line 1100

def get_field(type_or_name, field_name)
  parent_type = case type_or_name
  when LateBoundType
    get_type(type_or_name.name)
  when String
    get_type(type_or_name)
  when Module
    type_or_name
  else
    raise ArgumentError, "unexpected field owner for #{field_name.inspect}: #{type_or_name.inspect} (#{type_or_name.class})"
  end

  if parent_type.kind.fields? && (field = parent_type.get_field(field_name))
    field
  elsif parent_type == query && (entry_point_field = introspection_system.entry_point(name: field_name))
    entry_point_field
  elsif (dynamic_field = introspection_system.dynamic_field(name: field_name))
    dynamic_field
  else
    nil
  end
end

.get_fields(type) ⇒ Object 



1123
1124
1125
 
# File 'lib/graphql/schema.rb', line 1123

def get_fields(type)
  type.fields
end

.get_type(type_name) ⇒ Module?

Returns A type, or nil if there’s no type called type_name.

Parameters:

  • type_name (String)

Returns:

  • (Module, nil) —

    A type, or nil if there’s no type called type_name



939
940
941
942
943
 
# File 'lib/graphql/schema.rb', line 939

def get_type(type_name)
  own_types[type_name] ||
    introspection_system.types[type_name] ||
    find_inherited_value(:types, EMPTY_HASH)[type_name]
end

.graphql_definition ⇒ Object 



839
840
841
 
# File 'lib/graphql/schema.rb', line 839

def graphql_definition
  @graphql_definition ||= to_graphql
end

.id_from_object(object, type, ctx) ⇒ Object

Raises:



1357
1358
1359
 
# File 'lib/graphql/schema.rb', line 1357

def id_from_object(object, type, ctx)
  raise GraphQL::RequiredImplementationMissingError, "#{self.name}.id_from_object(object, type, ctx) must be implemented to create global ids (tried to create an id for `#{object.inspect}`)"
end

.inaccessible_fields(error) ⇒ AnalysisError?

This hook is called when a client tries to access one or more fields that fail the accessible? check.

By default, an error is added to the response. Override this hook to track metrics or return a different error to the client.

Parameters:

  • error (InaccessibleFieldsError) —

    The analysis error for this check

Returns:



1377
1378
1379
 
# File 'lib/graphql/schema.rb', line 1377

def inaccessible_fields(error)
  error
end

.inherited(child_class) ⇒ Object

rubocop:enable Lint/DuplicateMethods



1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/graphql/schema.rb', line 1341

def inherited(child_class)
  if self == GraphQL::Schema
    child_class.directives(default_directives.values)
  end
  child_class.singleton_class.prepend(ResolveTypeWithType)
  super
end

.instrument(instrument_step, instrumenter, options = {}) ⇒ Object 



1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/graphql/schema.rb', line 1440

def instrument(instrument_step, instrumenter, options = {})
  step = if instrument_step == :field && options[:after_built_ins]
    :field_after_built_ins
  else
    instrument_step
  end

  own_instrumenters[step] << instrumenter
end

.instrumenters ⇒ Object 



1560
1561
1562
1563
1564
1565
 
# File 'lib/graphql/schema.rb', line 1560

def instrumenters
  inherited_instrumenters = find_inherited_value(:instrumenters) || Hash.new { |h,k| h[k] = [] }
  inherited_instrumenters.merge(own_instrumenters) do |_step, inherited, own|
    inherited + own
  end
end

.interpreter? ⇒ Boolean

Returns:

  • (Boolean) 


1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/graphql/schema.rb', line 1206

def interpreter?
  if defined?(@interpreter)
    @interpreter
  else
    find_inherited_value(:interpreter?, false)
  end
end

.introspection(new_introspection_namespace = nil) ⇒ Object 



1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/graphql/schema.rb', line 1127

def introspection(new_introspection_namespace = nil)
  if new_introspection_namespace
    @introspection = new_introspection_namespace    # reset this cached value:

    @introspection_system = nil
  else
    @introspection || find_inherited_value(:introspection)
  end
end

.introspection_system ⇒ Object 



1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/graphql/schema.rb', line 1137

def introspection_system
  if !@introspection_system
    @introspection_system = Schema::IntrospectionSystem.new(self)
    @introspection_system.resolve_late_bindings
  end
  @introspection_system
end

.lazy?(obj) ⇒ Boolean

Returns True if this object should be lazily resolved.

Returns:

  • (Boolean) —

    True if this object should be lazily resolved



1605
1606
1607
 
# File 'lib/graphql/schema.rb', line 1605

def lazy?(obj)
  !!lazy_method_name(obj)
end

.lazy_method_name(obj) ⇒ Symbol?

Returns The method name to lazily resolve obj, or nil if obj’s class wasn’t registered wtih #lazy_resolve.

Returns:

  • (Symbol, nil) —

    The method name to lazily resolve obj, or nil if obj’s class wasn’t registered wtih #lazy_resolve.



1600
1601
1602
 
# File 'lib/graphql/schema.rb', line 1600

def lazy_method_name(obj)
  lazy_methods.get(obj)
end

.lazy_resolve(lazy_class, value_method) ⇒ Object 



1436
1437
1438
 
# File 'lib/graphql/schema.rb', line 1436

def lazy_resolve(lazy_class, value_method)
  lazy_methods.set(lazy_class, value_method)
end

.middleware(new_middleware = nil) ⇒ Object 



1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/graphql/schema.rb', line 1494

def middleware(new_middleware = nil)
  if new_middleware
    own_middleware << new_middleware
  else
    # TODO make sure this is cached when running a query
    MiddlewareChain.new(steps: all_middleware, final_step: GraphQL::Execution::Execute::FieldResolveStep)
  end
end

.multiplex(queries, **kwargs) ⇒ Array<Hash>

Execute several queries on itself, concurrently.

Examples:

Run several queries at once

context = { ... }
queries = [
  { query: params[:query_1], variables: params[:variables_1], context: context },
  { query: params[:query_2], variables: params[:variables_2], context: context },
]
results = MySchema.multiplex(queries)
render json: {
  result_1: results[0],
  result_2: results[1],
}

Parameters:

  • queries (Array<Hash>) —

    Keyword arguments for each query

  • context (Hash) —

    Multiplex-level context

Returns:

  • (Array<Hash>) —

    One result for each query in the input

See Also:

  • for query keyword arguments
  • for multiplex keyword arguments


1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/graphql/schema.rb', line 1551

def multiplex(queries, **kwargs)
  schema = if interpreter?
    self
  else
    graphql_definition
  end
  GraphQL::Execution::Multiplex.run_all(schema, queries, **kwargs)
end

.multiplex_analyzer(new_analyzer) ⇒ Object 



1503
1504
1505
 
# File 'lib/graphql/schema.rb', line 1503

def multiplex_analyzer(new_analyzer)
  own_multiplex_analyzers << new_analyzer
end

.multiplex_analyzers ⇒ Object 



1507
1508
1509
 
# File 'lib/graphql/schema.rb', line 1507

def multiplex_analyzers
  find_inherited_value(:multiplex_analyzers, EMPTY_ARRAY) + own_multiplex_analyzers
end

.mutation(new_mutation_object = nil) ⇒ Object 



982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/graphql/schema.rb', line 982

def mutation(new_mutation_object = nil)
  if new_mutation_object
    if @mutation_object
      raise GraphQL::Error, "Second definition of `mutation(...)` (#{new_mutation_object.inspect}) is invalid, already configured with #{@mutation_object.inspect}"
    else
      @mutation_object = new_mutation_object
      add_type_and_traverse(new_mutation_object, root: true)
      nil
    end
  else
    @mutation_object || find_inherited_value(:mutation)
  end
end

.mutation_execution_strategy(new_mutation_execution_strategy = nil) ⇒ Object 



1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/graphql/schema.rb', line 1168

def mutation_execution_strategy(new_mutation_execution_strategy = nil)
  if new_mutation_execution_strategy
    @mutation_execution_strategy = new_mutation_execution_strategy
  else
    @mutation_execution_strategy || find_inherited_value(:mutation_execution_strategy, self.default_execution_strategy)
  end
end

.new_connections? ⇒ Boolean

Returns:

  • (Boolean) 


964
965
966
 
# File 'lib/graphql/schema.rb', line 964

def new_connections?
  !!connections
end

.object_from_id(node_id, ctx) ⇒ Object

Raises:



1353
1354
1355
 
# File 'lib/graphql/schema.rb', line 1353

def object_from_id(node_id, ctx)
  raise GraphQL::RequiredImplementationMissingError, "#{self.name}.object_from_id(node_id, ctx) must be implemented to load by ID (tried to load from id `#{node_id}`)"
end

.orphan_types(*new_orphan_types) ⇒ Object 



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'lib/graphql/schema.rb', line 1280

def orphan_types(*new_orphan_types)
  if new_orphan_types.any?
    new_orphan_types = new_orphan_types.flatten
    add_type_and_traverse(new_orphan_types, root: false)
    @orphan_types = new_orphan_types
    own_orphan_types.concat(new_orphan_types.flatten)
  end

  find_inherited_value(:orphan_types, EMPTY_ARRAY) + own_orphan_types
end

.parse_error(parse_err, ctx) ⇒ Object

A function to call when #execute receives an invalid query string

The default is to add the error to context.errors

Parameters:

Returns:

  • void



1426
1427
1428
 
# File 'lib/graphql/schema.rb', line 1426

def parse_error(parse_err, ctx)
  ctx.errors.push(parse_err)
end

.plugins ⇒ Object 



868
869
870
 
# File 'lib/graphql/schema.rb', line 868

def plugins
  find_inherited_value(:plugins, EMPTY_ARRAY) + own_plugins
end

.possible_types(type = nil, context = GraphQL::Query::NullContext) ⇒ Hash<String, Module>, Array<Module>

Parameters:

  • type (Module) (defaults to: nil) —

    The type definition whose possible types you want to see

Returns:

  • (Hash<String, Module>) —

    All possible types, if no type is given.

  • (Array<Module>) —

    Possible types for type, if it’s given.



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/graphql/schema.rb', line 1032

def possible_types(type = nil, context = GraphQL::Query::NullContext)
  if type    # TODO duck-typing `.possible_types` would probably be nicer here

    if type.kind.union?
      type.possible_types(context: context)
    else
      own_possible_types[type.graphql_name] ||
        introspection_system.possible_types[type.graphql_name] ||
        (
          superclass.respond_to?(:possible_types) ?
            superclass.possible_types(type, context) :
            EMPTY_ARRAY
        )
    end
  else
    find_inherited_value(:possible_types, EMPTY_HASH)
      .merge(own_possible_types)
      .merge(introspection_system.possible_types)
  end
end

.query(new_query_object = nil) ⇒ Object 



968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/graphql/schema.rb', line 968

def query(new_query_object = nil)
  if new_query_object
    if @query_object
      raise GraphQL::Error, "Second definition of `query(...)` (#{new_query_object.inspect}) is invalid, already configured with #{@query_object.inspect}"
    else
      @query_object = new_query_object
      add_type_and_traverse(new_query_object, root: true)
      nil
    end
  else
    @query_object || find_inherited_value(:query)
  end
end

.query_analyzer(new_analyzer) ⇒ Object 



1483
1484
1485
1486
1487
1488
 
# File 'lib/graphql/schema.rb', line 1483

def query_analyzer(new_analyzer)
  if new_analyzer == GraphQL::Authorization::Analyzer
    warn("The Authorization query analyzer is deprecated. Authorizing at query runtime is generally a better idea.")
  end
  own_query_analyzers << new_analyzer
end

.query_analyzers ⇒ Object 



1490
1491
1492
 
# File 'lib/graphql/schema.rb', line 1490

def query_analyzers
  find_inherited_value(:query_analyzers, EMPTY_ARRAY) + own_query_analyzers
end

.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object 



1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/graphql/schema.rb', line 1160

def query_execution_strategy(new_query_execution_strategy = nil)
  if new_query_execution_strategy
    @query_execution_strategy = new_query_execution_strategy
  else
    @query_execution_strategy || find_inherited_value(:query_execution_strategy, self.default_execution_strategy)
  end
end

.references_to(to_type = nil, from: nil) ⇒ Object 



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/graphql/schema.rb', line 1068

def references_to(to_type = nil, from: nil)
  @own_references_to ||= Hash.new { |h, k| h[k] = [] }
  if to_type
    if !to_type.is_a?(String)
      to_type = to_type.graphql_name
    end

    if from
      @own_references_to[to_type] << from
    else
      own_refs = @own_references_to[to_type]
      inherited_refs = find_inherited_value(:references_to, EMPTY_HASH)[to_type] || EMPTY_ARRAY
      own_refs + inherited_refs
    end
  else
    # `@own_references_to` can be quite large for big schemas,
    # and generally speaking, we won't inherit any values.
    # So optimize the most common case -- don't create a duplicate Hash.
    inherited_value = find_inherited_value(:references_to, EMPTY_HASH)
    if inherited_value.any?
      inherited_value.merge(@own_references_to)
    else
      @own_references_to
    end
  end
end

.rescue_from(*err_classes, &handler_block) ⇒ Object 



1307
1308
1309
1310
1311
 
# File 'lib/graphql/schema.rb', line 1307

def rescue_from(*err_classes, &handler_block)
  err_classes.each do |err_class|
    own_rescues[err_class] = handler_block
  end
end

.rescues ⇒ Object 



1349
1350
1351
 
# File 'lib/graphql/schema.rb', line 1349

def rescues
  find_inherited_value(:rescues, EMPTY_HASH).merge(own_rescues)
end

.resolve_type(type, obj, ctx) ⇒ Object 



1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/graphql/schema.rb', line 1332

def resolve_type(type, obj, ctx)
  if type.kind.object?
    type
  else
    raise GraphQL::RequiredImplementationMissingError, "#{self.name}.resolve_type(type, obj, ctx) must be implemented to use Union types or Interface types (tried to resolve: #{type.name})"
  end
end

.root_type_for_operation(operation) ⇒ GraphQL::ObjectType?

Returns:

See Also:

  • Resticted access to root types


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/graphql/schema.rb', line 1012

def root_type_for_operation(operation)
  case operation
  when "query"
    query
  when "mutation"
    mutation
  when "subscription"
    subscription
  else
    raise ArgumentError, "unknown operation type: #{operation}"
  end
end

.root_types ⇒ Object 



1025
1026
1027
 
# File 'lib/graphql/schema.rb', line 1025

def root_types
  @root_types
end

.static_validator ⇒ Object 



855
856
857
 
# File 'lib/graphql/schema.rb', line 855

def static_validator
  GraphQL::StaticValidation::Validator.new(schema: self)
end

.subscription(new_subscription_object = nil) ⇒ Object 



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/graphql/schema.rb', line 996

def subscription(new_subscription_object = nil)
  if new_subscription_object
    if @subscription_object
      raise GraphQL::Error, "Second definition of `subscription(...)` (#{new_subscription_object.inspect}) is invalid, already configured with #{@subscription_object.inspect}"
    else
      @subscription_object = new_subscription_object
      add_type_and_traverse(new_subscription_object, root: true)
      nil
    end
  else
    @subscription_object || find_inherited_value(:subscription)
  end
end

.subscription_execution_strategy(new_subscription_execution_strategy = nil) ⇒ Object 



1176
1177
1178
1179
1180
1181
1182
 
# File 'lib/graphql/schema.rb', line 1176

def subscription_execution_strategy(new_subscription_execution_strategy = nil)
  if new_subscription_execution_strategy
    @subscription_execution_strategy = new_subscription_execution_strategy
  else
    @subscription_execution_strategy || find_inherited_value(:subscription_execution_strategy, self.default_execution_strategy)
  end
end

.sync_lazy(value) ⇒ Object

Override this method to handle lazy objects in a custom way.

Parameters:

Returns:

  • (Object) —

    A GraphQL-ready (non-lazy) object



1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/graphql/schema.rb', line 1589

def sync_lazy(value)
  lazy_method = lazy_method_name(value)
  if lazy_method
    synced_value = value.public_send(lazy_method)
    sync_lazy(synced_value)
  else
    value
  end
end

.to_definition(only: nil, except: nil, context: {}) ⇒ String

Return the GraphQL IDL for the schema

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (String) 


821
822
823
 
# File 'lib/graphql/schema.rb', line 821

def to_definition(only: nil, except: nil, context: {})
  GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context)
end

.to_document ⇒ GraphQL::Language::Document

Return the GraphQL::Language::Document IDL AST for the schema

Returns:

  • (GraphQL::Language::Document) 


827
828
829
 
# File 'lib/graphql/schema.rb', line 827

def to_document
  GraphQL::Language::DocumentFromSchemaDefinition.new(self).document
end

.to_graphql ⇒ Object 



872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/graphql/schema.rb', line 872

def to_graphql
  schema_defn = self.new
  schema_defn.raise_definition_error = true
  schema_defn.query = query && query.graphql_definition
  schema_defn.mutation = mutation && mutation.graphql_definition
  schema_defn.subscription = subscription && subscription.graphql_definition
  schema_defn.max_complexity = max_complexity
  schema_defn.error_bubbling = error_bubbling
  schema_defn.max_depth = max_depth
  schema_defn.default_max_page_size = default_max_page_size
  schema_defn.orphan_types = orphan_types.map(&:graphql_definition)
  schema_defn.disable_introspection_entry_points = disable_introspection_entry_points?
  schema_defn.disable_schema_introspection_entry_point = disable_schema_introspection_entry_point?
  schema_defn.disable_type_introspection_entry_point = disable_type_introspection_entry_point?

  prepped_dirs = {}
  directives.each { |k, v| prepped_dirs[k] = v.graphql_definition}
  schema_defn.directives = prepped_dirs
  schema_defn.introspection_namespace = introspection
  schema_defn.resolve_type = method(:resolve_type)
  schema_defn.object_from_id = method(:object_from_id)
  schema_defn.id_from_object = method(:id_from_object)
  schema_defn.type_error = method(:type_error)
  schema_defn.context_class = context_class
  schema_defn.cursor_encoder = cursor_encoder
  schema_defn.tracers.concat(tracers)
  schema_defn.query_analyzers.concat(query_analyzers)

  schema_defn.middleware.concat(all_middleware)
  schema_defn.multiplex_analyzers.concat(multiplex_analyzers)
  schema_defn.query_execution_strategy = query_execution_strategy
  schema_defn.mutation_execution_strategy = mutation_execution_strategy
  schema_defn.subscription_execution_strategy = subscription_execution_strategy
  schema_defn.default_mask = default_mask
  instrumenters.each do |step, insts|
    insts.each do |inst|
      schema_defn.instrumenters[step] << inst
    end
  end

  lazy_methods.each do |lazy_class, value_method|
    schema_defn.lazy_methods.set(lazy_class, value_method)
  end

  rescues.each do |err_class, handler|
    schema_defn.rescue_from(err_class, &handler)
  end

  schema_defn.subscriptions ||= self.subscriptions

  if !schema_defn.interpreter?
    schema_defn.instrumenters[:query] << GraphQL::Schema::Member::Instrumentation
  end
  schema_defn.send(:rebuild_artifacts)

  schema_defn
end

.to_json(*args) ⇒ String

Returns the JSON response of Introspection::INTROSPECTION_QUERY.

Returns:

  • (String)

See Also:

  • {{#as_json}


803
804
805
 
# File 'lib/graphql/schema.rb', line 803

def to_json(*args)
  JSON.pretty_generate(as_json(*args))
end

.tracer(new_tracer) ⇒ Object 



1475
1476
1477
 
# File 'lib/graphql/schema.rb', line 1475

def tracer(new_tracer)
  own_tracers << new_tracer
end

.tracers ⇒ Object 



1479
1480
1481
 
# File 'lib/graphql/schema.rb', line 1479

def tracers
  find_inherited_value(:tracers, EMPTY_ARRAY) + own_tracers
end

.type_error(type_err, ctx) ⇒ Object 



1416
1417
1418
 
# File 'lib/graphql/schema.rb', line 1416

def type_error(type_err, ctx)
  DefaultTypeError.call(type_err, ctx)
end

.type_from_ast(ast_node, context: nil) ⇒ Object 



1095
1096
1097
1098
 
# File 'lib/graphql/schema.rb', line 1095

def type_from_ast(ast_node, context: nil)
  type_owner = context ? context.warden : self
  GraphQL::Schema::TypeExpression.build_type(type_owner, ast_node)
end

.types ⇒ Hash<String => Class>

Build a map of { name => type } and return it

Returns:

  • (Hash<String => Class>) —

    A dictionary of type classes by their GraphQL name

See Also:



933
934
935
 
# File 'lib/graphql/schema.rb', line 933

def types
  non_introspection_types.merge(introspection_system.types)
end

.unauthorized_field(unauthorized_error) ⇒ Field

This hook is called when a field fails an authorized? check.

By default, this hook implements the same behavior as unauthorized_object.

Whatever value is returned from this method will be used instead of the unauthorized field . If an error is raised, then nil will be used.

If you want to add an error to the "errors" key, raise a ExecutionError in this hook.

Parameters:

Returns:

  • (Field) —

    The returned field will be put in the GraphQL response



1412
1413
1414
 
# File 'lib/graphql/schema.rb', line 1412

def unauthorized_field(unauthorized_error)
  unauthorized_object(unauthorized_error)
end

.unauthorized_object(unauthorized_error) ⇒ Object

This hook is called when an object fails an authorized? check. You might report to your bug tracker here, so you can correct the field resolvers not to return unauthorized objects.

By default, this hook just replaces the unauthorized object with nil.

Whatever value is returned from this method will be used instead of the unauthorized object (accessible as unauthorized_error.object). If an error is raised, then nil will be used.

If you want to add an error to the "errors" key, raise a ExecutionError in this hook.

Parameters:

Returns:

  • (Object) —

    The returned object will be put in the GraphQL response



1396
1397
1398
 
# File 'lib/graphql/schema.rb', line 1396

def unauthorized_object(unauthorized_error)
  nil
end

.union_memberships(type = nil) ⇒ Object 



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/graphql/schema.rb', line 1053

def union_memberships(type = nil)
  if type
    own_um = own_union_memberships.fetch(type.graphql_name, EMPTY_ARRAY)
    inherited_um = find_inherited_value(:union_memberships, EMPTY_HASH).fetch(type.graphql_name, EMPTY_ARRAY)
    own_um + inherited_um
  else
    joined_um = own_union_memberships.dup
    find_inherited_value(:union_memberhips, EMPTY_HASH).each do |k, v|
      um = joined_um[k] ||= []
      um.concat(v)
    end
    joined_um
  end
end

.use(plugin, **kwargs) ⇒ Object 



859
860
861
862
863
864
865
866
 
# File 'lib/graphql/schema.rb', line 859

def use(plugin, **kwargs)
  if kwargs.any?
    plugin.use(self, **kwargs)
  else
    plugin.use(self)
  end
  own_plugins << [plugin, kwargs]
end

.using_ast_analysis? ⇒ Boolean

Returns:

  • (Boolean) 


1202
1203
1204
 
# File 'lib/graphql/schema.rb', line 1202

def using_ast_analysis?
  analysis_engine == GraphQL::Analysis::AST
end

.visible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean) 


1361
1362
1363
 
# File 'lib/graphql/schema.rb', line 1361

def visible?(member, ctx)
  member.type_class.visible?(ctx)
end

Instance Method Details

#accessible?(member, context) ⇒ Boolean

Returns:

  • (Boolean) 


667
668
669
 
# File 'lib/graphql/schema.rb', line 667

def accessible?(member, context)
  call_on_type_class(member, :accessible?, context, default: true)
end

#after_lazy(value) ⇒ 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.

Call the given block at the right time, either: - Right away, if value is not registered with lazy_resolve - After resolving value, if it’s registered with lazy_resolve (eg, Promise)



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/graphql/schema.rb', line 1857

def after_lazy(value)
  if lazy?(value)
    GraphQL::Execution::Lazy.new do
      result = sync_lazy(value)      # The returned result might also be lazy, so check it, too

      after_lazy(result) do |final_result|
        yield(final_result) if block_given?
      end
    end
  else
    yield(value) if block_given?
  end
end

#as_json(only: nil, except: nil, context: {}) ⇒ Hash

Return the Hash response of Introspection::INTROSPECTION_QUERY.

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (Hash) —

    GraphQL result



764
765
766
 
# File 'lib/graphql/schema.rb', line 764

def as_json(only: nil, except: nil, context: {})
  execute(Introspection::INTROSPECTION_QUERY, only: only, except: except, context: context).to_h
end

#call_on_type_class(member, method_name, context, default:) ⇒ Object

Given this schema member, find the class-based definition object whose method_name should be treated as an application hook

See Also:

  • GraphQL::Schema.{{.visible?}
  • GraphQL::Schema.{{.accessible?}


645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/graphql/schema.rb', line 645

def call_on_type_class(member, method_name, context, default:)
  member = if member.respond_to?(:type_class)
    member.type_class
  else
    member
  end

  if member.respond_to?(:relay_node_type) && (t = member.relay_node_type)
    member = t
  end

  if member.respond_to?(method_name)
    member.public_send(method_name, context)
  else
    default
  end
end

#check_resolved_type(type, object, ctx = :__undefined__) ⇒ 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.

This is a compatibility hack so that instance-level and class-level methods can get correctness checks without calling one another



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/graphql/schema.rb', line 542

def check_resolved_type(type, object, ctx = :__undefined__)
  if ctx == :__undefined__    # Old method signature

    ctx = object
    object = type
    type = nil
  end

  if object.is_a?(GraphQL::Schema::Object)
    object = object.object
  end

  if type.respond_to?(:graphql_definition)
    type = type.graphql_definition
  end

  # Prefer a type-local function; fall back to the schema-level function
  type_proc = type && type.resolve_type_proc
  type_result = if type_proc
    type_proc.call(object, ctx)
  else
    yield(type, object, ctx)
  end

  if type_result.nil?
    nil
  else
    after_lazy(type_result) do |resolved_type_result|
      if resolved_type_result.respond_to?(:graphql_definition)
        resolved_type_result = resolved_type_result.graphql_definition
      end
      if !resolved_type_result.is_a?(GraphQL::BaseType)
        type_str = "#{resolved_type_result} (#{resolved_type_result.class.name})"
        raise "resolve_type(#{object}) returned #{type_str}, but it should return a GraphQL type"
      else
        resolved_type_result
      end
    end
  end
end

#default_filter ⇒ Object 



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

def default_filter
  GraphQL::Filter.new(except: default_mask)
end

#define(**kwargs, &block) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/graphql/schema.rb', line 308

def define(**kwargs, &block)
  super
  ensure_defined  # Assert that all necessary configs are present:

  validation_error = Validation.validate(self)
  validation_error && raise(GraphQL::RequiredImplementationMissingError, validation_error)
  rebuild_artifacts

  @definition_error = nil
  nil
rescue StandardError => err
  if @raise_definition_error || err.is_a?(CyclicalDefinitionError) || err.is_a?(GraphQL::RequiredImplementationMissingError)
    raise
  else
    # Raise this error _later_ to avoid messing with Rails constant loading
    @definition_error = err
  end
  nil
end

#disable_introspection_entry_points? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/graphql/schema.rb', line 164

def disable_introspection_entry_points?
  !!@disable_introspection_entry_points
end

#disable_schema_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/graphql/schema.rb', line 171

def disable_schema_introspection_entry_point?
  !!@disable_schema_introspection_entry_point
end

#disable_type_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/graphql/schema.rb', line 178

def disable_type_introspection_entry_point?
  !!@disable_type_introspection_entry_point
end

#execute(query_str = nil, **kwargs) ⇒ Hash

Execute a query on itself. Raises an error if the schema definition is invalid.

Returns:

  • (Hash) —

    query result, ready to be serialized as JSON

See Also:

  • for arguments.


391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/graphql/schema.rb', line 391

def execute(query_str = nil, **kwargs)
  if query_str
    kwargs[:query] = query_str
  end  # Some of the query context _should_ be passed to the multiplex, too

  multiplex_context = if (ctx = kwargs[:context])
    {
      backtrace: ctx[:backtrace],
      tracers: ctx[:tracers],
    }
  else
    {}
  end  # Since we're running one query, don't run a multiplex-level complexity analyzer

  all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context)
  all_results[0]
end

#execution_strategy_for_operation(operation) ⇒ Object 



510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/graphql/schema.rb', line 510

def execution_strategy_for_operation(operation)
  case operation
  when "query"
    query_execution_strategy
  when "mutation"
    mutation_execution_strategy
  when "subscription"
    subscription_execution_strategy
  else
    raise ArgumentError, "unknown operation type: #{operation}"
  end
end

#find(path) ⇒ GraphQL::BaseType, ...

Search for a schema member using a string path Schema.find(“Ensemble.musicians”)

Examples:

Finding a Field

Parameters:

  • path (String) —

    A dot-separated path to the member

Returns:

Raises:

See Also:

  • for more examples


441
442
443
444
 
# File 'lib/graphql/schema.rb', line 441

def find(path)
  rebuild_artifacts unless defined?(@finder)
  @find_cache[path] ||= @finder.find(path)
end

#get_field(parent_type, field_name) ⇒ GraphQL::Field?

Resolve field named field_name for type parent_type. Handles dynamic fields __typename, __type and __schema, too

Parameters:

Returns:

See Also:

  • Restricted access to members of a schema


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/graphql/schema.rb', line 452

def get_field(parent_type, field_name)
  with_definition_error_check do
    parent_type_name = case parent_type
    when GraphQL::BaseType, Class, Module
      parent_type.graphql_name
    when String
      parent_type
    else
      raise "Unexpected parent_type: #{parent_type}"
    end

    defined_field = @instrumented_field_map[parent_type_name][field_name]
    if defined_field
      defined_field
    elsif parent_type == query && (entry_point_field = introspection_system.entry_point(name: field_name))
      entry_point_field
    elsif (dynamic_field = introspection_system.dynamic_field(name: field_name))
      dynamic_field
    else
      nil
    end
  end
end

#get_fields(type) ⇒ Hash<String, GraphQL::Field>

Fields for this type, after instrumentation is applied

Returns:



478
479
480
 
# File 'lib/graphql/schema.rb', line 478

def get_fields(type)
  @instrumented_field_map[type.graphql_name]
end

#get_type(type_name) ⇒ Object 



356
357
358
 
# File 'lib/graphql/schema.rb', line 356

def get_type(type_name)
  @types[type_name]
end

#id_from_object(object, type, ctx) ⇒ String

Get a unique identifier from this object

Parameters:

Returns:

  • (String) —

    a unique identifier for object which clients can use to refetch it



691
692
693
694
695
696
697
 
# File 'lib/graphql/schema.rb', line 691

def id_from_object(object, type, ctx)
  if @id_from_object_proc.nil?
    raise(GraphQL::RequiredImplementationMissingError, "Can't generate an ID for #{object.inspect} of type #{type}, schema's `id_from_object` must be defined")
  else
    @id_from_object_proc.call(object, type, ctx)
  end
end

#id_from_object=(new_proc) ⇒ Object

Parameters:

  • new_proc (#call) —

    A new callable for generating unique IDs



700
701
702
 
# File 'lib/graphql/schema.rb', line 700

def id_from_object=(new_proc)
  @id_from_object_proc = new_proc
end

#initialize_copy(other) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/graphql/schema.rb', line 248

def initialize_copy(other)
  super
  @orphan_types = other.orphan_types.dup
  @directives = other.directives.dup
  @static_validator = GraphQL::StaticValidation::Validator.new(schema: self)
  @middleware = other.middleware.dup
  @query_analyzers = other.query_analyzers.dup
  @multiplex_analyzers = other.multiplex_analyzers.dup
  @tracers = other.tracers.dup
  @possible_types = GraphQL::Schema::PossibleTypes.new(self)

  @lazy_methods = other.lazy_methods.dup

  @instrumenters = Hash.new { |h, k| h[k] = [] }
  other.instrumenters.each do |key, insts|
    @instrumenters[key].concat(insts)
  end

  if other.rescues?
    @rescue_middleware = other.rescue_middleware
  end

  # This will be rebuilt when it's requested
  # or during a later `define` call
  @types = nil
  @introspection_system = nil
end

#inspect ⇒ Object 



244
245
246
 
# File 'lib/graphql/schema.rb', line 244

def inspect
  "#<#{self.class.name} ...>"
end

#instrument(instrumentation_type, instrumenter) ⇒ void

This method returns an undefined value.

Attach instrumenter to this schema for instrumenting events of instrumentation_type.

Parameters:

  • instrumentation_type (Symbol)
  • instrumenter 


332
333
334
335
336
337
 
# File 'lib/graphql/schema.rb', line 332

def instrument(instrumentation_type, instrumenter)
  @instrumenters[instrumentation_type] << instrumenter
  if instrumentation_type == :field
    rebuild_artifacts
  end
end

#interpreter? ⇒ Boolean

Returns True if using the new Execution::Interpreter.

Returns:



237
238
239
 
# File 'lib/graphql/schema.rb', line 237

def interpreter?
  @interpreter
end

#introspection_system ⇒ 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. 



361
362
363
364
365
366
 
# File 'lib/graphql/schema.rb', line 361

def introspection_system
  @introspection_system ||= begin
    rebuild_artifacts
    @introspection_system
  end
end

#lazy?(obj) ⇒ Boolean

Returns True if this object should be lazily resolved.

Returns:

  • (Boolean) —

    True if this object should be lazily resolved



737
738
739
 
# File 'lib/graphql/schema.rb', line 737

def lazy?(obj)
  !!lazy_method_name(obj)
end

#lazy_method_name(obj) ⇒ Symbol?

Returns The method name to lazily resolve obj, or nil if obj’s class wasn’t registered wtih #lazy_resolve.

Returns:

  • (Symbol, nil) —

    The method name to lazily resolve obj, or nil if obj’s class wasn’t registered wtih #lazy_resolve.



732
733
734
 
# File 'lib/graphql/schema.rb', line 732

def lazy_method_name(obj)
  @lazy_methods.get(obj)
end

#multiplex(queries, **kwargs) ⇒ Array<Hash>

Execute several queries on itself. Raises an error if the schema definition is invalid.

Examples:

Run several queries at once

context = { ... }
queries = [
  { query: params[:query_1], variables: params[:variables_1], context: context },
  { query: params[:query_2], variables: params[:variables_2], context: context },
]
results = MySchema.multiplex(queries)
render json: {
  result_1: results[0],
  result_2: results[1],
}

Parameters:

  • queries (Array<Hash>) —

    Keyword arguments for each query

  • context (Hash) —

    Multiplex-level context

Returns:

  • (Array<Hash>) —

    One result for each query in the input

See Also:

  • for query keyword arguments
  • for multiplex keyword arguments


427
428
429
430
431
 
# File 'lib/graphql/schema.rb', line 427

def multiplex(queries, **kwargs)
  with_definition_error_check {
    GraphQL::Execution::Multiplex.run_all(self, queries, **kwargs)
  }
end

#new_connections? ⇒ Boolean

Returns:

  • (Boolean) 


775
776
777
 
# File 'lib/graphql/schema.rb', line 775

def new_connections?
  !!connections
end

#object_from_id(id, ctx) ⇒ Any

Fetch an application object by its unique id

Parameters:

  • id (String) —

    A unique identifier, provided previously by this GraphQL schema

  • ctx (GraphQL::Query::Context) —

    The context for the current query

Returns:

  • (Any) —

    The application object identified by id



592
593
594
595
596
597
598
 
# File 'lib/graphql/schema.rb', line 592

def object_from_id(id, ctx)
  if @object_from_id_proc.nil?
    raise(GraphQL::RequiredImplementationMissingError, "Can't fetch an object for id \"#{id}\" because the schema's `object_from_id (id, ctx) -> { ... }` function is not defined")
  else
    @object_from_id_proc.call(id, ctx)
  end
end

#object_from_id=(new_proc) ⇒ Object

Parameters:

  • new_proc (#call) —

    A new callable for fetching objects by ID



601
602
603
 
# File 'lib/graphql/schema.rb', line 601

def object_from_id=(new_proc)
  @object_from_id_proc = new_proc
end

#parse_error(err, ctx) ⇒ Object

A function to call when #execute receives an invalid query string

Parameters:

Returns:

  • void

See Also:

  • is the default behavior.


677
678
679
 
# File 'lib/graphql/schema.rb', line 677

def parse_error(err, ctx)
  @parse_error_proc.call(err, ctx)
end

#parse_error=(new_proc) ⇒ Object

Parameters:

  • new_proc (#call) —

    A new callable for handling parse errors during execution



682
683
684
 
# File 'lib/graphql/schema.rb', line 682

def parse_error=(new_proc)
  @parse_error_proc = new_proc
end

#possible_types(type_defn, context = GraphQL::Query::NullContext) ⇒ Array<GraphQL::ObjectType>

Returns types which belong to type_defn in this schema.

Parameters:

Returns:

See Also:

  • Restricted access to members of a schema


490
491
492
493
 
# File 'lib/graphql/schema.rb', line 490

def possible_types(type_defn, context = GraphQL::Query::NullContext)
  @possible_types ||= GraphQL::Schema::PossibleTypes.new(self)
  @possible_types.possible_types(type_defn, context)
end

#references_to(type_name = nil) ⇒ Hash

Returns a list of Arguments and Fields referencing a certain type

Parameters:

  • type_name (String) (defaults to: nil)

Returns:

  • (Hash) 


371
372
373
374
375
376
377
378
 
# File 'lib/graphql/schema.rb', line 371

def references_to(type_name = nil)
  rebuild_artifacts unless defined?(@type_reference_map)
  if type_name
    @type_reference_map.fetch(type_name, [])
  else
    @type_reference_map
  end
end

#remove_handler(*args, &block) ⇒ Object 



280
281
282
 
# File 'lib/graphql/schema.rb', line 280

def remove_handler(*args, &block)
  rescue_middleware.remove_handler(*args, &block)
end

#rescue_from(*args, &block) ⇒ Object 



276
277
278
 
# File 'lib/graphql/schema.rb', line 276

def rescue_from(*args, &block)
  rescue_middleware.rescue_from(*args, &block)
end

#resolve_type(type, object, ctx = :__undefined__) ⇒ GraphQL::ObjectType

Determine the GraphQL type for a given object. This is required for unions and interfaces (including Relay’s Node interface)

Parameters:

  • type (GraphQL::UnionType, GraphQL:InterfaceType) —

    the abstract type which is being resolved

  • object (Any) —

    An application object which GraphQL is currently resolving on

  • ctx (GraphQL::Query::Context) (defaults to: :__undefined__) —

    The context for the current query

Returns:

See Also:

  • Restricted access to members of a schema


530
531
532
533
534
535
536
537
 
# File 'lib/graphql/schema.rb', line 530

def resolve_type(type, object, ctx = :__undefined__)
  check_resolved_type(type, object, ctx) do |ok_type, ok_object, ok_ctx|
    if @resolve_type_proc.nil?
      raise(GraphQL::RequiredImplementationMissingError, "Can't determine GraphQL type for: #{ok_object.inspect}, define `resolve_type (type, obj, ctx) -> { ... }` inside `Schema.define`.")
    end
    @resolve_type_proc.call(ok_type, ok_object, ok_ctx)
  end
end

#resolve_type=(new_resolve_type_proc) ⇒ Object 



583
584
585
586
 
# File 'lib/graphql/schema.rb', line 583

def resolve_type=(new_resolve_type_proc)
  callable = GraphQL::BackwardsCompatibility.wrap_arity(new_resolve_type_proc, from: 2, to: 3, last: true, name: "Schema#resolve_type(type, obj, ctx)")
  @resolve_type_proc = callable
end

#root_type_for_operation(operation) ⇒ GraphQL::ObjectType?

Returns:

See Also:

  • Resticted access to root types


497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/graphql/schema.rb', line 497

def root_type_for_operation(operation)
  case operation
  when "query"
    query
  when "mutation"
    mutation
  when "subscription"
    subscription
  else
    raise ArgumentError, "unknown operation type: #{operation}"
  end
end

#root_types ⇒ Array<GraphQL::BaseType>

Returns The root types of this schema.

Returns:



340
341
342
343
344
345
 
# File 'lib/graphql/schema.rb', line 340

def root_types
  @root_types ||= begin
    rebuild_artifacts
    @root_types
  end
end

#sync_lazy(value) ⇒ 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.

See Also:



1873
1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/graphql/schema.rb', line 1873

def sync_lazy(value)
  lazy_method = lazy_method_name(value)
  if lazy_method
    synced_value = value.public_send(lazy_method)
    sync_lazy(synced_value)
  else
    value
  end
end

#to_definition(only: nil, except: nil, context: {}) ⇒ String

Return the GraphQL IDL for the schema

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (String) 


746
747
748
 
# File 'lib/graphql/schema.rb', line 746

def to_definition(only: nil, except: nil, context: {})
  GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context)
end

#to_document(only: nil, except: nil, context: {}) ⇒ GraphQL::Language::Document

Return the GraphQL::Language::Document IDL AST for the schema

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (GraphQL::Language::Document) 


755
756
757
 
# File 'lib/graphql/schema.rb', line 755

def to_document(only: nil, except: nil, context: {})
  GraphQL::Language::DocumentFromSchemaDefinition.new(self, only: only, except: except, context: context).document
end

#to_json(*args) ⇒ String

Returns the JSON response of Introspection::INTROSPECTION_QUERY.

Returns:

  • (String)

See Also:

  • GraphQL::Schema.{{#as_json}


771
772
773
 
# File 'lib/graphql/schema.rb', line 771

def to_json(*args)
  JSON.pretty_generate(as_json(*args))
end

#type_error(err, ctx) ⇒ Object

When we encounter a type error during query execution, we call this hook.

You can use this hook to write a log entry, add a ExecutionError to the response (with ctx.add_error) or raise an exception and halt query execution.

Examples:

A nil is encountered by a non-null field

type_error ->(err, query_ctx) {
  err.is_a?(GraphQL::InvalidNullError) # => true
}

An object doesn’t resolve to one of a UnionType’s members

type_error ->(err, query_ctx) {
  err.is_a?(GraphQL::UnresolvedTypeError) # => true
}

Parameters:

  • err (GraphQL::TypeError) —

    The error encountered during execution

  • ctx (GraphQL::Query::Context) —

    The context for the field where the error occurred

Returns:

  • void

See Also:

  • is the default behavior.


625
626
627
 
# File 'lib/graphql/schema.rb', line 625

def type_error(err, ctx)
  @type_error_proc.call(err, ctx)
end

#type_error=(new_proc) ⇒ Object

Parameters:

  • new_proc (#call) —

    A new callable for handling type errors during execution



630
631
632
 
# File 'lib/graphql/schema.rb', line 630

def type_error=(new_proc)
  @type_error_proc = new_proc
end

#type_from_ast(ast_node, context:) ⇒ Object 



482
483
484
 
# File 'lib/graphql/schema.rb', line 482

def type_from_ast(ast_node, context:)
  GraphQL::Schema::TypeExpression.build_type(self, ast_node)
end

#types ⇒ GraphQL::Schema::TypeMap

Returns { name => type } pairs of types in this schema.

Returns:

  • (GraphQL::Schema::TypeMap) —

    { name => type } pairs of types in this schema

See Also:

  • Restricted access to members of a schema


349
350
351
352
353
354
 
# File 'lib/graphql/schema.rb', line 349

def types
  @types ||= begin
    rebuild_artifacts
    @types
  end
end

#union_memberships(type) ⇒ Array<GraphQL::UnionType>

Returns a list of Union types in which a type is a member

Parameters:

Returns:



383
384
385
386
 
# File 'lib/graphql/schema.rb', line 383

def union_memberships(type)
  rebuild_artifacts unless defined?(@union_memberships)
  @union_memberships.fetch(type.name, [])
end

#using_ast_analysis? ⇒ Boolean

Returns:

  • (Boolean) 


284
285
286
 
# File 'lib/graphql/schema.rb', line 284

def using_ast_analysis?
  @analysis_engine == GraphQL::Analysis::AST
end

#validate(string_or_document, rules: nil, context: nil) ⇒ Array<GraphQL::StaticValidation::Error >

Validate a query string according to this schema.

Parameters:

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/graphql/schema.rb', line 294

def validate(string_or_document, rules: nil, context: nil)
  doc = if string_or_document.is_a?(String)
    GraphQL.parse(string_or_document)
  else
    string_or_document
  end
  query = GraphQL::Query.new(self, document: doc, context: context)
  validator_opts = { schema: self }
  rules && (validator_opts[:rules] = rules)
  validator = GraphQL::StaticValidation::Validator.new(**validator_opts)
  res = validator.validate(query)
  res[:errors]
end

#visible?(member, context) ⇒ Boolean

Returns:

  • (Boolean) 


663
664
665
 
# File 'lib/graphql/schema.rb', line 663

def visible?(member, context)
  call_on_type_class(member, :visible?, context, default: true)
end