Class: GraphQL::Schema

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, Define::InstanceDefinable::DeprecatedDefine, FindInheritedValue, LazyHandlingMethods, Member::AcceptsDefinition, Member::CachedGraphQLDefinition::DeprecatedToGraphQL, Member::HasAstNode
Includes:
Define::InstanceDefinable, LazyHandlingMethods
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/addition.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/validator.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/flagged.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/has_directives.rb,
lib/graphql/schema/member/has_interfaces.rb,
lib/graphql/schema/member/has_validators.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/validator/format_validator.rb,
lib/graphql/schema/validator/length_validator.rb,
lib/graphql/schema/validator/required_validator.rb,
lib/graphql/schema/member/has_deprecation_reason.rb,
lib/graphql/schema/validator/exclusion_validator.rb,
lib/graphql/schema/validator/inclusion_validator.rb,
lib/graphql/schema/validator/allow_null_validator.rb,
lib/graphql/schema/validator/allow_blank_validator.rb,
lib/graphql/schema/member/cached_graphql_definition.rb,
lib/graphql/schema/member/has_unresolved_type_error.rb,
lib/graphql/schema/validator/numericality_validator.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

Direct Known Subclasses

Query::NullContext::NullSchema

Defined Under Namespace

Modules: Base64Encoder, BuildFromDefinition, CatchallMiddleware, DefaultParseError, DefaultTypeError, FindInheritedValue, Interface, LazyHandlingMethods, Loader, NullMask, ResolveTypeWithType, TypeExpression, UniqueWithinType Classes: Addition, Argument, CyclicalDefinitionError, Directive, DuplicateNamesError, DuplicateTypeNamesError, 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, Validator, 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::DeprecatedDefine

define

Methods included from LazyHandlingMethods

after_any_lazies, after_lazy, lazy?, lazy_method_name, sync_lazy

Methods included from Member::CachedGraphQLDefinition::DeprecatedToGraphQL

to_graphql

Methods included from Define::InstanceDefinable

#define, #metadata, #redefine

Constructor Details

#initializeSchema

Returns a new instance of Schema.


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/graphql/schema.rb', line 269

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
  # For schema instances, default to legacy runtime modules
  @analysis_engine = GraphQL::Analysis
  @query_execution_strategy = GraphQL::Execution::Execute
  @mutation_execution_strategy = GraphQL::Execution::Execute
  @subscription_execution_strategy = GraphQL::Execution::Execute
  @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_engineObject


1380
1381
1382
# File 'lib/graphql/schema.rb', line 1380

def analysis_engine
  @analysis_engine || find_inherited_value(:analysis_engine, self.default_analysis_engine)
end

.connectionsGraphQL::Pagination::Connections

Returns if installed.

Returns:


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/graphql/schema.rb', line 1071

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

.dataloader_classObject

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:


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

def dataloader_class
  @dataloader_class || GraphQL::Dataloader::NullDataloader
end

.default_execution_strategyObject


1470
1471
1472
1473
1474
1475
1476
# File 'lib/graphql/schema.rb', line 1470

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

.error_bubbling(new_error_bubbling = nil) ⇒ Object


1396
1397
1398
1399
1400
1401
1402
# File 'lib/graphql/schema.rb', line 1396

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

.interpreter=(value) ⇒ Object (writeonly)

Sets the attribute interpreter

Parameters:

  • value

    the value to set the attribute interpreter to.


1394
1395
1396
# File 'lib/graphql/schema.rb', line 1394

def interpreter=(value)
  @interpreter = value
end

.max_complexity(max_complexity = nil) ⇒ Object


1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/graphql/schema.rb', line 1368

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


1408
1409
1410
1411
1412
1413
1414
1415
1416
# File 'lib/graphql/schema.rb', line 1408

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

.subscriptionsGraphQL::Subscriptions


862
863
864
# File 'lib/graphql/schema.rb', line 862

def subscriptions
  @subscriptions
end

.validate_max_errors(new_validate_max_errors = nil) ⇒ Object


1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/graphql/schema.rb', line 1356

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

.validate_timeout(new_validate_timeout = nil) ⇒ Object


1327
1328
1329
1330
1331
1332
1333
1334
1335
# File 'lib/graphql/schema.rb', line 1327

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

Instance Attribute Details

#analysis_engineObject

Returns the value of attribute analysis_engine.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def analysis_engine
  @analysis_engine
end

#ast_nodeObject

Returns the value of attribute ast_node.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def ast_node
  @ast_node
end

#connectionsObject

Returns the value of attribute connections.


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

def connections
  @connections
end

#context_classClass

Returns Instantiated for each query.

Returns:

  • (Class)

    Instantiated for each query

See Also:

  • The parent class of these classes

230
231
232
# File 'lib/graphql/schema.rb', line 230

def context_class
  @context_class
end

#cursor_encoderObject

Returns the value of attribute cursor_encoder.


202
203
204
# File 'lib/graphql/schema.rb', line 202

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:`

226
227
228
# File 'lib/graphql/schema.rb', line 226

def default_mask
  @default_mask
end

#default_max_page_sizeObject

Returns the value of attribute default_max_page_size.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def default_max_page_size
  @default_max_page_size
end

#directivesObject

Returns the value of attribute directives.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def directives
  @directives
end

#disable_introspection_entry_pointsObject

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


233
234
235
# File 'lib/graphql/schema.rb', line 233

def disable_introspection_entry_points
  @disable_introspection_entry_points
end

#disable_schema_introspection_entry_pointObject

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


240
241
242
# File 'lib/graphql/schema.rb', line 240

def disable_schema_introspection_entry_point
  @disable_schema_introspection_entry_point
end

#disable_type_introspection_entry_pointObject

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


247
248
249
# File 'lib/graphql/schema.rb', line 247

def disable_type_introspection_entry_point
  @disable_type_introspection_entry_point
end

#error_bubblingObject

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


215
216
217
# File 'lib/graphql/schema.rb', line 215

def error_bubbling
  @error_bubbling
end

#id_from_object_procObject (readonly)

Returns the value of attribute id_from_object_proc.


267
268
269
# File 'lib/graphql/schema.rb', line 267

def id_from_object_proc
  @id_from_object_proc
end

#instrumentersObject

Returns the value of attribute instrumenters.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def instrumenters
  @instrumenters
end

#introspection_namespaceObject

Returns the value of attribute introspection_namespace.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def introspection_namespace
  @introspection_namespace
end

#lazy_methodsObject

Returns the value of attribute lazy_methods.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def lazy_methods
  @lazy_methods
end

#max_complexityObject

Returns the value of attribute max_complexity.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def max_complexity
  @max_complexity
end

#max_depthObject

Returns the value of attribute max_depth.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def max_depth
  @max_depth
end

#middlewareMiddlewareChain

Returns MiddlewareChain which is applied to fields during execution.

Returns:

  • (MiddlewareChain)

    MiddlewareChain which is applied to fields during execution


222
223
224
# File 'lib/graphql/schema.rb', line 222

def middleware
  @middleware
end

#multiplex_analyzersObject

Returns the value of attribute multiplex_analyzers.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def multiplex_analyzers
  @multiplex_analyzers
end

#mutationObject

Returns the value of attribute mutation.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def mutation
  @mutation
end

#mutation_execution_strategyObject

Returns the value of attribute mutation_execution_strategy.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def mutation_execution_strategy
  @mutation_execution_strategy
end

#object_from_id_procObject (readonly)

Returns the value of attribute object_from_id_proc.


267
268
269
# File 'lib/graphql/schema.rb', line 267

def object_from_id_proc
  @object_from_id_proc
end

#orphan_typesObject

Returns the value of attribute orphan_types.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def orphan_types
  @orphan_types
end

#queryObject

Returns the value of attribute query.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def query
  @query
end

#query_analyzersObject

Returns the value of attribute query_analyzers.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def query_analyzers
  @query_analyzers
end

#query_execution_strategyObject

Returns the value of attribute query_execution_strategy.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def query_execution_strategy
  @query_execution_strategy
end

#raise_definition_errorObject

Returns the value of attribute raise_definition_error.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def raise_definition_error
  @raise_definition_error
end

#resolve_type_procObject (readonly)

Returns the value of attribute resolve_type_proc.


267
268
269
# File 'lib/graphql/schema.rb', line 267

def resolve_type_proc
  @resolve_type_proc
end

#static_validatorObject (readonly)

Returns the value of attribute static_validator.


267
268
269
# File 'lib/graphql/schema.rb', line 267

def static_validator
  @static_validator
end

#subscriptionObject

Returns the value of attribute subscription.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def subscription
  @subscription
end

#subscription_execution_strategyObject

Returns the value of attribute subscription_execution_strategy.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def subscription_execution_strategy
  @subscription_execution_strategy
end

#subscriptionsGraphQL::Subscriptions

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


219
220
221
# File 'lib/graphql/schema.rb', line 219

def subscriptions
  @subscriptions
end

#tracersArray<#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

263
264
265
# File 'lib/graphql/schema.rb', line 263

def tracers
  @tracers
end

#validate_max_errorsObject

Returns the value of attribute validate_max_errors.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def validate_max_errors
  @validate_max_errors
end

#validate_timeoutObject

Returns the value of attribute validate_timeout.


202
203
204
# File 'lib/graphql/schema.rb', line 202

def validate_timeout
  @validate_timeout
end

Class Method Details

.accessible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean)

1552
1553
1554
# File 'lib/graphql/schema.rb', line 1552

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

.add_subscription_extension_if_necessaryObject

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.


1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
# File 'lib/graphql/schema.rb', line 1767

def add_subscription_extension_if_necessary
  if interpreter? && !defined?(@subscription_extension_added) && subscription && self.subscriptions
    @subscription_extension_added = true
    if subscription.singleton_class.ancestors.include?(Subscriptions::SubscriptionRoot)
      GraphQL::Deprecation.warn("`extend Subscriptions::SubscriptionRoot` is no longer required; you may remove it from #{self}'s `subscription` root type (#{subscription}).")
    else
      subscription.all_field_definitions.each do |field|
        field.extension(Subscriptions::DefaultSubscriptionResolveExtension)
      end
    end
  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


876
877
878
# File 'lib/graphql/schema.rb', line 876

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

.context_class(new_context_class = nil) ⇒ Object


1486
1487
1488
1489
1490
1491
1492
# File 'lib/graphql/schema.rb', line 1486

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


1286
1287
1288
1289
1290
1291
# File 'lib/graphql/schema.rb', line 1286

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

.default_analysis_engineObject


1478
1479
1480
1481
1482
1483
1484
# File 'lib/graphql/schema.rb', line 1478

def default_analysis_engine
  if superclass <= GraphQL::Schema
    superclass.default_analysis_engine
  else
    @default_analysis_engine ||= GraphQL::Analysis::AST
  end
end

.default_directivesObject


1657
1658
1659
1660
1661
1662
1663
# File 'lib/graphql/schema.rb', line 1657

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

.default_filterObject


914
915
916
# File 'lib/graphql/schema.rb', line 914

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

.default_mask(new_mask = nil) ⇒ Object


918
919
920
921
922
923
924
# File 'lib/graphql/schema.rb', line 918

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


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

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

.deprecated_graphql_definitionObject


857
858
859
# File 'lib/graphql/schema.rb', line 857

def deprecated_graphql_definition
  graphql_definition(silence_deprecation_warning: true)
end

.directive(new_directive) ⇒ Object

Attach a single directive to this schema

Parameters:

  • new_directive (Class)

Returns:

  • void


1653
1654
1655
# File 'lib/graphql/schema.rb', line 1653

def directive(new_directive)
  add_type_and_traverse(new_directive, root: false)
end

.directives(*new_directives) ⇒ Object

Add several directives at once

Parameters:

  • new_directives (Class)

1642
1643
1644
1645
1646
1647
1648
# File 'lib/graphql/schema.rb', line 1642

def directives(*new_directives)
  if new_directives.any?
    new_directives.flatten.each { |d| directive(d) }
  end

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

.disable_introspection_entry_pointsObject


1418
1419
1420
1421
1422
# File 'lib/graphql/schema.rb', line 1418

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)

1436
1437
1438
1439
1440
1441
1442
# File 'lib/graphql/schema.rb', line 1436

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_pointObject


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

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)

1444
1445
1446
1447
1448
1449
1450
# File 'lib/graphql/schema.rb', line 1444

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_pointObject


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

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)

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

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

.error_handlerGraphQL::Execution::Errors


1618
1619
1620
# File 'lib/graphql/schema.rb', line 1618

def error_handler
  @error_handler ||= GraphQL::Execution::Errors.new(self)
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.

1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
# File 'lib/graphql/schema.rb', line 1713

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


895
896
897
898
899
900
901
# File 'lib/graphql/schema.rb', line 895

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: nil, parser: GraphQL.default_parser, 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: nil)

    A callable for handling field resolution

  • parser (Object) (defaults to: GraphQL.default_parser)

    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)

Returns:

  • (Class)

    the schema described by document


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
# File 'lib/graphql/schema.rb', line 780

def self.from_definition(definition_or_path, default_resolve: nil, parser: GraphQL.default_parser, using: {})
  # If the file ends in `.graphql`, treat it like a filepath
  if definition_or_path.end_with?(".graphql")
    GraphQL::Schema::BuildFromDefinition.from_definition_path(
      definition_or_path,
      default_resolve: default_resolve,
      parser: parser,
      using: using,
    )
  else
    GraphQL::Schema::BuildFromDefinition.from_definition(
      definition_or_path,
      default_resolve: default_resolve,
      parser: parser,
      using: using,
    )
  end
end

.from_introspection(introspection_result) ⇒ GraphQL::Schema

Create schema with the result of an introspection query.

Parameters:

Returns:


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

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

.get_field(type_or_name, field_name, context = GraphQL::Query::NullContext) ⇒ Object


1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
# File 'lib/graphql/schema.rb', line 1241

def get_field(type_or_name, field_name, context = GraphQL::Query::NullContext)
  parent_type = case type_or_name
  when LateBoundType
    get_type(type_or_name.name, context)
  when String
    get_type(type_or_name, context)
  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, context))
    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, context = GraphQL::Query::NullContext) ⇒ Object


1264
1265
1266
# File 'lib/graphql/schema.rb', line 1264

def get_fields(type, context = GraphQL::Query::NullContext)
  type.fields(context)
end

.get_type(type_name, context = GraphQL::Query::NullContext) ⇒ 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


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
# File 'lib/graphql/schema.rb', line 1038

def get_type(type_name, context = GraphQL::Query::NullContext)
  local_entry = own_types[type_name]
  type_defn = case local_entry
  when nil
    nil
  when Array
    visible_t = nil
    warden = Warden.from_context(context)
    local_entry.each do |t|
      if warden.visible_type?(t, context)
        if visible_t.nil?
          visible_t = t
        else
          raise DuplicateNamesError, "Found two visible type definitions for `#{type_name}`: #{visible_t.inspect}, #{t.inspect}"
        end
      end
    end
    visible_t
  when Module
    local_entry
  else
    raise "Invariant: unexpected own_types[#{type_name.inspect}]: #{local_entry.inspect}"
  end

  type_defn ||
    introspection_system.types[type_name] || # todo context-specific introspection?
    (superclass.respond_to?(:get_type) ? superclass.get_type(type_name, context) : nil)
end

.graphql_definition(silence_deprecation_warning: false) ⇒ Object


903
904
905
906
907
908
909
910
911
912
# File 'lib/graphql/schema.rb', line 903

def graphql_definition(silence_deprecation_warning: false)
  @graphql_definition ||= begin
    unless silence_deprecation_warning
      message = "Legacy `.graphql_definition` objects are deprecated and will be removed in GraphQL-Ruby 2.0. Use a class-based definition instead."
      caller_message = "\n\nCalled on #{self.inspect} from:\n #{caller(1, 25).map { |l| "  #{l}" }.join("\n")}"
      GraphQL::Deprecation.warn(message + caller_message)
    end
    to_graphql(silence_deprecation_warning: silence_deprecation_warning)
  end
end

.id_from_object(object, type, ctx) ⇒ Object


1544
1545
1546
# File 'lib/graphql/schema.rb', line 1544

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:


1564
1565
1566
# File 'lib/graphql/schema.rb', line 1564

def inaccessible_fields(error)
  error
end

.inherited(child_class) ⇒ Object

rubocop:enable Lint/DuplicateMethods


1532
1533
1534
1535
1536
1537
1538
# File 'lib/graphql/schema.rb', line 1532

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


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
# File 'lib/graphql/schema.rb', line 1626

def instrument(instrument_step, instrumenter, options = {})
  if instrument_step == :field
    GraphQL::Deprecation.warn "Field instrumentation (#{instrumenter.inspect}) will be removed in GraphQL-Ruby 2.0, please upgrade to field extensions: https://graphql-ruby.org/type_definitions/field_extensions.html"
  end

  step = if instrument_step == :field && options[:after_built_ins]
    :field_after_built_ins
  else
    instrument_step
  end

  own_instrumenters[step] << instrumenter
end

.instrumentersObject


1759
1760
1761
1762
1763
1764
# File 'lib/graphql/schema.rb', line 1759

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)

1388
1389
1390
1391
1392
# File 'lib/graphql/schema.rb', line 1388

def interpreter?
  query_execution_strategy == GraphQL::Execution::Interpreter &&
    mutation_execution_strategy == GraphQL::Execution::Interpreter &&
    subscription_execution_strategy == GraphQL::Execution::Interpreter
end

.introspection(new_introspection_namespace = nil) ⇒ Object


1268
1269
1270
1271
1272
1273
1274
1275
1276
# File 'lib/graphql/schema.rb', line 1268

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_systemObject


1278
1279
1280
1281
1282
1283
1284
# File 'lib/graphql/schema.rb', line 1278

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

.lazy_resolve(lazy_class, value_method) ⇒ Object


1622
1623
1624
# File 'lib/graphql/schema.rb', line 1622

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

.middleware(new_middleware = nil) ⇒ Object


1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'lib/graphql/schema.rb', line 1684

def middleware(new_middleware = nil)
  if new_middleware
    GraphQL::Deprecation.warn "Middleware will be removed in GraphQL-Ruby 2.0, please upgrade to Field Extensions: https://graphql-ruby.org/type_definitions/field_extensions.html"
    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

1750
1751
1752
1753
1754
1755
1756
1757
# File 'lib/graphql/schema.rb', line 1750

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


1694
1695
1696
# File 'lib/graphql/schema.rb', line 1694

def multiplex_analyzer(new_analyzer)
  own_multiplex_analyzers << new_analyzer
end

.multiplex_analyzersObject


1698
1699
1700
# File 'lib/graphql/schema.rb', line 1698

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

.mutation(new_mutation_object = nil) ⇒ Object


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'lib/graphql/schema.rb', line 1104

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


1309
1310
1311
1312
1313
1314
1315
# File 'lib/graphql/schema.rb', line 1309

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)

1086
1087
1088
# File 'lib/graphql/schema.rb', line 1086

def new_connections?
  !!connections
end

.object_from_id(node_id, ctx) ⇒ Object


1540
1541
1542
# File 'lib/graphql/schema.rb', line 1540

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


1460
1461
1462
1463
1464
1465
1466
1467
1468
# File 'lib/graphql/schema.rb', line 1460

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)
    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


1613
1614
1615
# File 'lib/graphql/schema.rb', line 1613

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

.pluginsObject


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

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.


1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'lib/graphql/schema.rb', line 1155

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
      stored_possible_types = own_possible_types[type.graphql_name]
      visible_possible_types = if stored_possible_types && type.kind.interface?
        stored_possible_types.select do |possible_type|
          # Use `.graphql_name` comparison to match legacy vs class-based types.
          # When we don't need to support legacy `.define` types, use `.include?(type)` instead.
          possible_type.interfaces(context).any? { |interface| interface.graphql_name == type.graphql_name }
        end
      else
        stored_possible_types
      end
      visible_possible_types ||
        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


1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/graphql/schema.rb', line 1090

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


1673
1674
1675
1676
1677
1678
# File 'lib/graphql/schema.rb', line 1673

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

.query_analyzersObject


1680
1681
1682
# File 'lib/graphql/schema.rb', line 1680

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

.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object


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

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

.query_stack_error(query, err) ⇒ Object


1780
1781
1782
# File 'lib/graphql/schema.rb', line 1780

def query_stack_error(query, err)
  query.context.errors.push(GraphQL::ExecutionError.new("This query is too large to execute."))
end

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


1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
# File 'lib/graphql/schema.rb', line 1209

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


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

def rescue_from(*err_classes, &handler_block)
  err_classes.each do |err_class|
    error_handler.rescue_from(err_class, handler_block)
  end
end

.resolve_type(type, obj, ctx) ⇒ Object


1523
1524
1525
1526
1527
1528
1529
# File 'lib/graphql/schema.rb', line 1523

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:

  • Restricted access to root types

1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'lib/graphql/schema.rb', line 1135

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_typesObject


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

def root_types
  @root_types
end

.sanitized_printer(new_sanitized_printer = nil) ⇒ Object


1702
1703
1704
1705
1706
1707
1708
# File 'lib/graphql/schema.rb', line 1702

def sanitized_printer(new_sanitized_printer = nil)
  if new_sanitized_printer
    @own_sanitized_printer = new_sanitized_printer
  else
    @own_sanitized_printer || GraphQL::Language::SanitizedPrinter
  end
end

.static_validatorObject


926
927
928
# File 'lib/graphql/schema.rb', line 926

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

.subscription(new_subscription_object = nil) ⇒ Object


1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'lib/graphql/schema.rb', line 1118

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_subscription_extension_if_necessary
      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


1317
1318
1319
1320
1321
1322
1323
# File 'lib/graphql/schema.rb', line 1317

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

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

885
886
887
# File 'lib/graphql/schema.rb', line 885

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

.to_documentGraphQL::Language::Document

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

Returns:

  • (GraphQL::Language::Document)

891
892
893
# File 'lib/graphql/schema.rb', line 891

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

.to_graphqlObject


944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'lib/graphql/schema.rb', line 944

def to_graphql
  schema_defn = self.new
  schema_defn.raise_definition_error = true
  schema_defn.query = query && query.graphql_definition(silence_deprecation_warning: true)
  schema_defn.mutation = mutation && mutation.graphql_definition(silence_deprecation_warning: true)
  schema_defn.subscription = subscription && subscription.graphql_definition(silence_deprecation_warning: true)
  schema_defn.validate_timeout = validate_timeout
  schema_defn.validate_max_errors = validate_max_errors
  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 { |t| t.graphql_definition(silence_deprecation_warning: true) }
  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.analysis_engine = analysis_engine

  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

  error_handler.each_rescue 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

  if new_connections?
    schema_defn.connections = self.connections
  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}

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

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

.tracer(new_tracer) ⇒ Object


1665
1666
1667
# File 'lib/graphql/schema.rb', line 1665

def tracer(new_tracer)
  own_tracers << new_tracer
end

.tracersObject


1669
1670
1671
# File 'lib/graphql/schema.rb', line 1669

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

.type_error(type_err, ctx) ⇒ Object


1603
1604
1605
# File 'lib/graphql/schema.rb', line 1603

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

.type_from_ast(ast_node, context: nil) ⇒ Object


1236
1237
1238
1239
# File 'lib/graphql/schema.rb', line 1236

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(context = GraphQL::Query::NullContext) ⇒ 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:


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'lib/graphql/schema.rb', line 1013

def types(context = GraphQL::Query::NullContext)
  all_types = non_introspection_types.merge(introspection_system.types)
  visible_types = {}
  all_types.each do |k, v|
    visible_types[k] =if v.is_a?(Array)
      visible_t = nil
      v.each do |t|
        if t.visible?(context)
          if visible_t.nil?
            visible_t = t
          else
            raise DuplicateNamesError, "Found two visible type definitions for `#{k}`: #{visible_t.inspect}, #{t.inspect}"
          end
        end
      end
      visible_t
    else
      v
    end
  end
  visible_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


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

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


1583
1584
1585
# File 'lib/graphql/schema.rb', line 1583

def unauthorized_object(unauthorized_error)
  nil
end

.union_memberships(type = nil) ⇒ Object


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

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


930
931
932
933
934
935
936
937
# File 'lib/graphql/schema.rb', line 930

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)

1384
1385
1386
# File 'lib/graphql/schema.rb', line 1384

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:


1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
# File 'lib/graphql/schema.rb', line 1340

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, timeout: validate_timeout, max_errors: validate_max_errors)
  res[:errors]
end

.visible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean)

1548
1549
1550
# File 'lib/graphql/schema.rb', line 1548

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

Instance Method Details

#accessible?(member, context) ⇒ Boolean

Returns:

  • (Boolean)

730
731
732
# File 'lib/graphql/schema.rb', line 730

def accessible?(member, context)
  call_on_type_class(member, :accessible?, context, default: true)
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


825
826
827
# File 'lib/graphql/schema.rb', line 825

def as_json(only: nil, except: nil, context: {})
  execute(Introspection.query(include_deprecated_args: true), 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?}

708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
# File 'lib/graphql/schema.rb', line 708

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


604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
# File 'lib/graphql/schema.rb', line 604

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

#dataloader_classObject


1906
1907
1908
# File 'lib/graphql/schema.rb', line 1906

def dataloader_class
  self.class.dataloader_class
end

#default_filterObject


257
258
259
# File 'lib/graphql/schema.rb', line 257

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

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


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/graphql/schema.rb', line 361

def deprecated_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)

235
236
237
# File 'lib/graphql/schema.rb', line 235

def disable_introspection_entry_points?
  !!@disable_introspection_entry_points
end

#disable_schema_introspection_entry_point?Boolean

Returns:

  • (Boolean)

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

def disable_schema_introspection_entry_point?
  !!@disable_schema_introspection_entry_point
end

#disable_type_introspection_entry_point?Boolean

Returns:

  • (Boolean)

249
250
251
# File 'lib/graphql/schema.rb', line 249

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.

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/graphql/schema.rb', line 444

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


572
573
574
575
576
577
578
579
580
581
582
583
# File 'lib/graphql/schema.rb', line 572

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

494
495
496
497
# File 'lib/graphql/schema.rb', line 494

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

505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
# File 'lib/graphql/schema.rb', line 505

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:


531
532
533
# File 'lib/graphql/schema.rb', line 531

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

#get_type(type_name) ⇒ Object


409
410
411
# File 'lib/graphql/schema.rb', line 409

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


754
755
756
757
758
759
760
# File 'lib/graphql/schema.rb', line 754

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


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

def id_from_object=(new_proc)
  @id_from_object_proc = new_proc
end

#initialize_copy(other) ⇒ Object


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/graphql/schema.rb', line 318

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

#inspectObject


314
315
316
# File 'lib/graphql/schema.rb', line 314

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

385
386
387
388
389
390
# File 'lib/graphql/schema.rb', line 385

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:


308
309
310
311
312
# File 'lib/graphql/schema.rb', line 308

def interpreter?
  query_execution_strategy == GraphQL::Execution::Interpreter &&
    mutation_execution_strategy == GraphQL::Execution::Interpreter &&
    subscription_execution_strategy == GraphQL::Execution::Interpreter
end

#introspection_systemObject

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.


414
415
416
417
418
419
# File 'lib/graphql/schema.rb', line 414

def introspection_system
  @introspection_system ||= begin
    rebuild_artifacts
    @introspection_system
  end
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

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

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

#new_connections?Boolean

Returns:

  • (Boolean)

836
837
838
# File 'lib/graphql/schema.rb', line 836

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


654
655
656
657
658
659
660
# File 'lib/graphql/schema.rb', line 654

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


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

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.

740
741
742
# File 'lib/graphql/schema.rb', line 740

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


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

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

543
544
545
546
547
548
549
550
551
552
553
554
555
# File 'lib/graphql/schema.rb', line 543

def possible_types(type_defn, context = GraphQL::Query::NullContext)
  if context == GraphQL::Query::NullContext
    @possible_types ||= GraphQL::Schema::PossibleTypes.new(self)
    @possible_types.possible_types(type_defn, context)
  else
    # Use the incoming context to cache this instance --
    # if it were cached on the schema, we'd have a memory leak
    # https://github.com/rmosolgo/graphql-ruby/issues/2878
    ns = context.namespace(:possible_types)
    per_query_possible_types = ns[:possible_types] ||= GraphQL::Schema::PossibleTypes.new(self)
    per_query_possible_types.possible_types(type_defn, context)
  end
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)

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

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


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

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

#rescue_from(*args, &block) ⇒ Object


346
347
348
# File 'lib/graphql/schema.rb', line 346

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

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

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


645
646
647
648
# File 'lib/graphql/schema.rb', line 645

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:

  • Restricted access to root types

559
560
561
562
563
564
565
566
567
568
569
570
# File 'lib/graphql/schema.rb', line 559

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_typesArray<GraphQL::BaseType>

Returns The root types of this schema.

Returns:


393
394
395
396
397
398
# File 'lib/graphql/schema.rb', line 393

def root_types
  @root_types ||= begin
    rebuild_artifacts
    @root_types
  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)

807
808
809
# File 'lib/graphql/schema.rb', line 807

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)

816
817
818
# File 'lib/graphql/schema.rb', line 816

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}

832
833
834
# File 'lib/graphql/schema.rb', line 832

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.

687
688
689
# File 'lib/graphql/schema.rb', line 687

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


692
693
694
# File 'lib/graphql/schema.rb', line 692

def type_error=(new_proc)
  @type_error_proc = new_proc
end

#type_from_ast(ast_node, context:) ⇒ Object


535
536
537
# File 'lib/graphql/schema.rb', line 535

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

#typesGraphQL::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

402
403
404
405
406
407
# File 'lib/graphql/schema.rb', line 402

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:


436
437
438
439
# File 'lib/graphql/schema.rb', line 436

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

#using_ast_analysis?Boolean

Returns:

  • (Boolean)

354
355
356
# File 'lib/graphql/schema.rb', line 354

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

#visible?(member, context) ⇒ Boolean

Returns:

  • (Boolean)

726
727
728
# File 'lib/graphql/schema.rb', line 726

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