Class: GraphQL::Schema
- Inherits:
-
Object
- Object
- GraphQL::Schema
- Extended by:
- Forwardable, FindInheritedValue, Member::AcceptsDefinition
- 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/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/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/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.
Defined Under Namespace
Modules: Base64Encoder, BuildFromDefinition, CatchallMiddleware, DefaultParseError, DefaultTypeError, FindInheritedValue, Interface, Loader, MethodWrappers, NullMask, 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, Union, Validation, Warden, Wrapper
Constant Summary collapse
- DYNAMIC_FIELDS =
["__type", "__typename", "__schema"].freeze
- EMPTY_ARRAY =
[].freeze
- EMPTY_HASH =
{}.freeze
- Context =
GraphQL::Query::Context
- BUILT_IN_TYPES =
{ "Int" => INT_TYPE, "String" => STRING_TYPE, "Float" => FLOAT_TYPE, "Boolean" => BOOLEAN_TYPE, "ID" => ID_TYPE, }
Class Attribute Summary collapse
Instance Attribute Summary collapse
-
#analysis_engine ⇒ Object
Returns the value of attribute analysis_engine.
-
#ast_node ⇒ Object
Returns the value of attribute ast_node.
-
#context_class ⇒ Class
Instantiated for each query.
-
#cursor_encoder ⇒ Object
Returns the value of attribute cursor_encoder.
-
#default_mask ⇒ <#call(member, ctx)>
A callable for filtering members of the schema.
-
#default_max_page_size ⇒ Object
Returns the value of attribute default_max_page_size.
-
#directives ⇒ Object
Returns the value of attribute directives.
-
#disable_introspection_entry_points ⇒ Object
[Boolean] True if this object disables the introspection entry point fields.
-
#error_bubbling ⇒ Object
[Boolean] True if this object bubbles validation errors up from a field into its parent InputObject, if there is one.
-
#id_from_object_proc ⇒ Object
readonly
Returns the value of attribute id_from_object_proc.
-
#instrumenters ⇒ Object
Returns the value of attribute instrumenters.
-
#interpreter ⇒ Object
writeonly
private
-
#introspection_namespace ⇒ Object
Returns the value of attribute introspection_namespace.
-
#lazy_methods ⇒ Object
Returns the value of attribute lazy_methods.
-
#max_complexity ⇒ Object
Returns the value of attribute max_complexity.
-
#max_depth ⇒ Object
Returns the value of attribute max_depth.
-
#middleware ⇒ MiddlewareChain
MiddlewareChain which is applied to fields during execution.
-
#multiplex_analyzers ⇒ Object
Returns the value of attribute multiplex_analyzers.
-
#mutation ⇒ Object
Returns the value of attribute mutation.
-
#mutation_execution_strategy ⇒ Object
Returns the value of attribute mutation_execution_strategy.
-
#object_from_id_proc ⇒ Object
readonly
Returns the value of attribute object_from_id_proc.
-
#orphan_types ⇒ Object
Returns the value of attribute orphan_types.
-
#query ⇒ Object
Returns the value of attribute query.
-
#query_analyzers ⇒ Object
Returns the value of attribute query_analyzers.
-
#query_execution_strategy ⇒ Object
Returns the value of attribute query_execution_strategy.
-
#raise_definition_error ⇒ Object
Returns the value of attribute raise_definition_error.
-
#resolve_type_proc ⇒ Object
readonly
Returns the value of attribute resolve_type_proc.
-
#static_validator ⇒ Object
readonly
Returns the value of attribute static_validator.
-
#subscription ⇒ Object
Returns the value of attribute subscription.
-
#subscription_execution_strategy ⇒ Object
Returns the value of attribute subscription_execution_strategy.
-
#subscriptions ⇒ GraphQL::Subscriptions
Single, long-lived instance of the provided subscriptions class, if there is one.
-
#tracers ⇒ Array<#trace(key, data)>
readonly
Tracers applied to every query.
Class Method Summary collapse
-
.accessible?(member, context) ⇒ Boolean
-
.context_class(new_context_class = nil) ⇒ Object
-
.cursor_encoder(new_encoder = nil) ⇒ Object
-
.default_directives ⇒ Object
-
.default_max_page_size(new_default_max_page_size = nil) ⇒ Object
-
.directive(new_directive) ⇒ Object
-
.directives(new_directives = nil) ⇒ Object
-
.disable_introspection_entry_points ⇒ Object
-
.disable_introspection_entry_points? ⇒ Boolean
-
.error_bubbling(new_error_bubbling = nil) ⇒ Object
-
.from_definition(definition_or_path, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) ⇒ GraphQL::Schema
Create schema from an IDL schema or file containing an IDL definition.
-
.from_introspection(introspection_result) ⇒ GraphQL::Schema
Create schema with the result of an introspection query.
-
.graphql_definition ⇒ Object
-
.id_from_object(object, type, ctx) ⇒ Object
-
.inaccessible_fields(error) ⇒ AnalysisError?
This hook is called when a client tries to access one or more fields that fail the
accessible?
check. -
.instrument(instrument_step, instrumenter, options = {}) ⇒ Object
-
.introspection(new_introspection_namespace = nil) ⇒ Object
-
.lazy_resolve(lazy_class, value_method) ⇒ Object
-
.max_complexity(max_complexity = nil) ⇒ Object
-
.max_depth(new_max_depth = nil) ⇒ Object
-
.middleware(new_middleware = nil) ⇒ Object
-
.multiplex_analyzer(new_analyzer) ⇒ Object
-
.multiplex_analyzers ⇒ Object
-
.mutation(new_mutation_object = nil) ⇒ Object
-
.mutation_execution_strategy(new_mutation_execution_strategy = nil) ⇒ Object
-
.object_from_id(node_id, ctx) ⇒ Object
-
.orphan_types(*new_orphan_types) ⇒ Object
-
.plugins ⇒ Object
-
.query(new_query_object = nil) ⇒ Object
-
.query_analyzer(new_analyzer) ⇒ Object
-
.query_analyzers ⇒ Object
-
.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object
-
.rescue_from(*err_classes, &handler_block) ⇒ Object
-
.rescues ⇒ Object
-
.resolve_type(type, obj, ctx) ⇒ Object
-
.subscription(new_subscription_object = nil) ⇒ Object
-
.subscription_execution_strategy(new_subscription_execution_strategy = nil) ⇒ Object
-
.sync_lazy(value) ⇒ Object
Override this method to handle lazy objects in a custom way.
-
.to_graphql ⇒ Object
-
.tracer(new_tracer) ⇒ Object
-
.tracers ⇒ Object
-
.type_error(type_err, ctx) ⇒ Object
-
.unauthorized_field(unauthorized_error) ⇒ Field
This hook is called when a field fails an
authorized?
check. -
.unauthorized_object(unauthorized_error) ⇒ Object
This hook is called when an object fails an
authorized?
check. -
.use(plugin, options = {}) ⇒ Object
-
.visible?(member, context) ⇒ Boolean
Instance Method Summary collapse
-
#after_lazy(value) ⇒ Object
private
Call the given block at the right time, either: - Right away, if
value
is not registered withlazy_resolve
- After resolvingvalue
, if it’s registered withlazy_resolve
(eg,Promise
). -
#as_json(only: nil, except: nil, context: {}) ⇒ Hash
Return the Hash response of Introspection::INTROSPECTION_QUERY.
-
#check_resolved_type(type, object, ctx = :__undefined__) ⇒ Object
private
This is a compatibility hack so that instance-level and class-level methods can get correctness checks without calling one another.
-
#default_filter ⇒ Object
-
#define(**kwargs, &block) ⇒ Object
-
#execute(query_str = nil, **kwargs) ⇒ Hash
Execute a query on itself.
-
#execution_strategy_for_operation(operation) ⇒ Object
-
#find(path) ⇒ GraphQL::BaseType, ...
Search for a schema member using a string path Schema.find(“Ensemble.musicians”).
-
#get_field(parent_type, field_name) ⇒ GraphQL::Field?
Resolve field named
field_name
for typeparent_type
. -
#get_fields(type) ⇒ Hash<String, GraphQL::Field>
Fields for this type, after instrumentation is applied.
-
#id_from_object(object, type, ctx) ⇒ String
Get a unique identifier from this object.
-
#id_from_object=(new_proc) ⇒ Object
-
#initialize ⇒ Schema
constructor
A new instance of Schema.
-
#initialize_copy(other) ⇒ Object
-
#inspect ⇒ Object
-
#instrument(instrumentation_type, instrumenter) ⇒ void
Attach
instrumenter
to this schema for instrumenting events ofinstrumentation_type
. -
#interpreter? ⇒ Boolean
True if using the new Execution::Interpreter.
-
#introspection_system ⇒ Object
private
-
#lazy?(obj) ⇒ Boolean
True if this object should be lazily resolved.
-
#lazy_method_name(obj) ⇒ Symbol?
The method name to lazily resolve
obj
, or nil ifobj
’s class wasn’t registered wtih #lazy_resolve. -
#multiplex(queries, **kwargs) ⇒ Array<Hash>
Execute several queries on itself.
-
#object_from_id(id, ctx) ⇒ Any
Fetch an application object by its unique id.
-
#object_from_id=(new_proc) ⇒ Object
-
#parse_error(err, ctx) ⇒ Object
A function to call when #execute receives an invalid query string.
-
#parse_error=(new_proc) ⇒ Object
-
#possible_types(type_defn) ⇒ Array<GraphQL::ObjectType>
Types which belong to
type_defn
in this schema. -
#references_to(type_name) ⇒ Hash
Returns a list of Arguments and Fields referencing a certain type.
-
#remove_handler(*args, &block) ⇒ Object
-
#rescue_from(*args, &block) ⇒ Object
-
#resolve_type(type, object, ctx = :__undefined__) ⇒ GraphQL::ObjectType
Determine the GraphQL type for a given object.
-
#resolve_type=(new_resolve_type_proc) ⇒ Object
-
#root_type_for_operation(operation) ⇒ GraphQL::ObjectType?
-
#root_types ⇒ Array<GraphQL::BaseType>
The root types of this schema.
-
#sync_lazy(value) ⇒ Object
private
-
#to_definition(only: nil, except: nil, context: {}) ⇒ String
Return the GraphQL IDL for the schema.
-
#to_document ⇒ GraphQL::Language::Document
Return the GraphQL::Language::Document IDL AST for the schema.
-
#to_json(*args) ⇒ String
Returns the JSON response of Introspection::INTROSPECTION_QUERY.
-
#type_error(err, ctx) ⇒ Object
When we encounter a type error during query execution, we call this hook.
-
#type_error=(new_proc) ⇒ Object
-
#type_from_ast(ast_node) ⇒ Object
-
#types ⇒ GraphQL::Schema::TypeMap
{ name => type }
pairs of types in this schema. -
#union_memberships(type) ⇒ Array<GraphQL::UnionType>
Returns a list of Union types in which a type is a member.
-
#using_ast_analysis? ⇒ Boolean
-
#validate(string_or_document, rules: nil, context: nil) ⇒ Array<GraphQL::StaticValidation::Error >
Validate a query string according to this schema.
Methods included from Define::InstanceDefinable
Constructor Details
#initialize ⇒ Schema
Returns a new instance of Schema
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/graphql/schema.rb', line 171 def initialize @tracers = [] @definition_error = nil @orphan_types = [] @directives = self.class.default_directives @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 end |
Class Attribute Details
Instance Attribute Details
#analysis_engine ⇒ Object
Returns the value of attribute analysis_engine
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def analysis_engine @analysis_engine end |
#ast_node ⇒ Object
Returns the value of attribute ast_node
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def ast_node @ast_node end |
#context_class ⇒ Class
Returns Instantiated for each query
148 149 150 |
# File 'lib/graphql/schema.rb', line 148 def context_class @context_class end |
#cursor_encoder ⇒ Object
Returns the value of attribute cursor_encoder
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def cursor_encoder @cursor_encoder end |
#default_mask ⇒ <#call(member, ctx)>
Returns A callable for filtering members of the schema
144 145 146 |
# File 'lib/graphql/schema.rb', line 144 def default_mask @default_mask end |
#default_max_page_size ⇒ Object
Returns the value of attribute default_max_page_size
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def default_max_page_size @default_max_page_size end |
#directives ⇒ Object
Returns the value of attribute directives
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def directives @directives end |
#disable_introspection_entry_points ⇒ Object
[Boolean] True if this object disables the introspection entry point fields
151 152 153 |
# File 'lib/graphql/schema.rb', line 151 def disable_introspection_entry_points @disable_introspection_entry_points end |
#error_bubbling ⇒ Object
[Boolean] True if this object bubbles validation errors up from a field into its parent InputObject, if there is one.
133 134 135 |
# File 'lib/graphql/schema.rb', line 133 def error_bubbling @error_bubbling end |
#id_from_object_proc ⇒ Object (readonly)
Returns the value of attribute id_from_object_proc
169 170 171 |
# File 'lib/graphql/schema.rb', line 169 def id_from_object_proc @id_from_object_proc end |
#instrumenters ⇒ Object
Returns the value of attribute instrumenters
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 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.
210 211 212 |
# File 'lib/graphql/schema.rb', line 210 def interpreter=(value) @interpreter = value end |
#introspection_namespace ⇒ Object
Returns the value of attribute introspection_namespace
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def introspection_namespace @introspection_namespace end |
#lazy_methods ⇒ Object
Returns the value of attribute lazy_methods
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def lazy_methods @lazy_methods end |
#max_complexity ⇒ Object
Returns the value of attribute max_complexity
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def max_complexity @max_complexity end |
#max_depth ⇒ Object
Returns the value of attribute max_depth
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def max_depth @max_depth end |
#middleware ⇒ MiddlewareChain
Returns MiddlewareChain which is applied to fields during execution
140 141 142 |
# File 'lib/graphql/schema.rb', line 140 def middleware @middleware end |
#multiplex_analyzers ⇒ Object
Returns the value of attribute multiplex_analyzers
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def multiplex_analyzers @multiplex_analyzers end |
#mutation ⇒ Object
Returns the value of attribute mutation
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def mutation @mutation end |
#mutation_execution_strategy ⇒ Object
Returns the value of attribute mutation_execution_strategy
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def mutation_execution_strategy @mutation_execution_strategy end |
#object_from_id_proc ⇒ Object (readonly)
Returns the value of attribute object_from_id_proc
169 170 171 |
# File 'lib/graphql/schema.rb', line 169 def object_from_id_proc @object_from_id_proc end |
#orphan_types ⇒ Object
Returns the value of attribute orphan_types
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def orphan_types @orphan_types end |
#query ⇒ Object
Returns the value of attribute query
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def query @query end |
#query_analyzers ⇒ Object
Returns the value of attribute query_analyzers
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def query_analyzers @query_analyzers end |
#query_execution_strategy ⇒ Object
Returns the value of attribute query_execution_strategy
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def query_execution_strategy @query_execution_strategy end |
#raise_definition_error ⇒ Object
Returns the value of attribute raise_definition_error
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def raise_definition_error @raise_definition_error end |
#resolve_type_proc ⇒ Object (readonly)
Returns the value of attribute resolve_type_proc
169 170 171 |
# File 'lib/graphql/schema.rb', line 169 def resolve_type_proc @resolve_type_proc end |
#static_validator ⇒ Object (readonly)
Returns the value of attribute static_validator
169 170 171 |
# File 'lib/graphql/schema.rb', line 169 def static_validator @static_validator end |
#subscription ⇒ Object
Returns the value of attribute subscription
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def subscription @subscription end |
#subscription_execution_strategy ⇒ Object
Returns the value of attribute subscription_execution_strategy
120 121 122 |
# File 'lib/graphql/schema.rb', line 120 def subscription_execution_strategy @subscription_execution_strategy end |
#subscriptions ⇒ GraphQL::Subscriptions
Single, long-lived instance of the provided subscriptions class, if there is one.
137 138 139 |
# File 'lib/graphql/schema.rb', line 137 def subscriptions @subscriptions end |
#tracers ⇒ Array<#trace(key, data)> (readonly)
Returns Tracers applied to every query
163 164 165 |
# File 'lib/graphql/schema.rb', line 163 def tracers @tracers end |
Class Method Details
.accessible?(member, context) ⇒ Boolean
972 973 974 |
# File 'lib/graphql/schema.rb', line 972 def accessible?(member, context) call_on_type_class(member, :accessible?, context, default: true) end |
.context_class(new_context_class = nil) ⇒ Object
934 935 936 937 938 939 940 |
# File 'lib/graphql/schema.rb', line 934 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
843 844 845 846 847 848 |
# File 'lib/graphql/schema.rb', line 843 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
1053 1054 1055 1056 1057 1058 1059 |
# File 'lib/graphql/schema.rb', line 1053 def default_directives { "include" => GraphQL::Directive::IncludeDirective, "skip" => GraphQL::Directive::SkipDirective, "deprecated" => GraphQL::Directive::DeprecatedDirective, } end |
.default_max_page_size(new_default_max_page_size = nil) ⇒ Object
850 851 852 853 854 855 856 |
# File 'lib/graphql/schema.rb', line 850 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
1049 1050 1051 |
# File 'lib/graphql/schema.rb', line 1049 def directive(new_directive) own_directives[new_directive.graphql_name] = new_directive end |
.directives(new_directives = nil) ⇒ Object
1041 1042 1043 1044 1045 1046 1047 |
# File 'lib/graphql/schema.rb', line 1041 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
906 907 908 |
# File 'lib/graphql/schema.rb', line 906 def disable_introspection_entry_points @disable_introspection_entry_points = true end |
.disable_introspection_entry_points? ⇒ Boolean
910 911 912 913 914 915 916 |
# File 'lib/graphql/schema.rb', line 910 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 |
.error_bubbling(new_error_bubbling = nil) ⇒ Object
890 891 892 893 894 895 896 |
# File 'lib/graphql/schema.rb', line 890 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 |
.from_definition(definition_or_path, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) ⇒ GraphQL::Schema
Create schema from an IDL schema or file containing an IDL definition.
643 644 645 646 647 648 649 650 651 |
# File 'lib/graphql/schema.rb', line 643 def self.from_definition(definition_or_path, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) # 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) end |
.from_introspection(introspection_result) ⇒ GraphQL::Schema
Create schema with the result of an introspection query.
634 635 636 |
# File 'lib/graphql/schema.rb', line 634 def self.from_introspection(introspection_result) GraphQL::Schema::Loader.load(introspection_result) end |
.graphql_definition ⇒ Object
731 732 733 |
# File 'lib/graphql/schema.rb', line 731 def graphql_definition @graphql_definition ||= to_graphql end |
.id_from_object(object, type, ctx) ⇒ Object
964 965 966 |
# File 'lib/graphql/schema.rb', line 964 def id_from_object(object, type, ctx) raise NotImplementedError, "#{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.
984 985 986 |
# File 'lib/graphql/schema.rb', line 984 def inaccessible_fields(error) error end |
.instrument(instrument_step, instrumenter, options = {}) ⇒ Object
1031 1032 1033 1034 1035 1036 1037 1038 1039 |
# File 'lib/graphql/schema.rb', line 1031 def instrument(instrument_step, instrumenter, = {}) step = if instrument_step == :field && [:after_built_ins] :field_after_built_ins else instrument_step end own_instrumenters[step] << instrumenter end |
.introspection(new_introspection_namespace = nil) ⇒ Object
835 836 837 838 839 840 841 |
# File 'lib/graphql/schema.rb', line 835 def introspection(new_introspection_namespace = nil) if new_introspection_namespace @introspection = new_introspection_namespace else @introspection || find_inherited_value(:introspection) end end |
.lazy_resolve(lazy_class, value_method) ⇒ Object
1027 1028 1029 |
# File 'lib/graphql/schema.rb', line 1027 def lazy_resolve(lazy_class, value_method) lazy_classes[lazy_class] = value_method end |
.max_complexity(max_complexity = nil) ⇒ Object
882 883 884 885 886 887 888 |
# File 'lib/graphql/schema.rb', line 882 def max_complexity(max_complexity = nil) if max_complexity @max_complexity = max_complexity else @max_complexity || find_inherited_value(:max_complexity) end end |
.max_depth(new_max_depth = nil) ⇒ Object
898 899 900 901 902 903 904 |
# File 'lib/graphql/schema.rb', line 898 def max_depth(new_max_depth = nil) if new_max_depth @max_depth = new_max_depth else @max_depth || find_inherited_value(:max_depth) end end |
.middleware(new_middleware = nil) ⇒ Object
1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/graphql/schema.rb', line 1080 def middleware(new_middleware = nil) if new_middleware own_middleware << new_middleware else graphql_definition.middleware end end |
.multiplex_analyzer(new_analyzer) ⇒ Object
1088 1089 1090 |
# File 'lib/graphql/schema.rb', line 1088 def multiplex_analyzer(new_analyzer) own_multiplex_analyzers << new_analyzer end |
.multiplex_analyzers ⇒ Object
1092 1093 1094 |
# File 'lib/graphql/schema.rb', line 1092 def multiplex_analyzers find_inherited_value(:multiplex_analyzers, EMPTY_ARRAY) + own_multiplex_analyzers end |
.mutation(new_mutation_object = nil) ⇒ Object
817 818 819 820 821 822 823 824 |
# File 'lib/graphql/schema.rb', line 817 def mutation(new_mutation_object = nil) if new_mutation_object @mutation_object = new_mutation_object else mutation_object = @mutation_object || find_inherited_value(:mutation) mutation_object.respond_to?(:graphql_definition) ? mutation_object.graphql_definition : mutation_object end end |
.mutation_execution_strategy(new_mutation_execution_strategy = nil) ⇒ Object
866 867 868 869 870 871 872 |
# File 'lib/graphql/schema.rb', line 866 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 |
.object_from_id(node_id, ctx) ⇒ Object
960 961 962 |
# File 'lib/graphql/schema.rb', line 960 def object_from_id(node_id, ctx) raise NotImplementedError, "#{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
918 919 920 921 922 923 924 |
# File 'lib/graphql/schema.rb', line 918 def orphan_types(*new_orphan_types) if new_orphan_types.any? own_orphan_types.concat(new_orphan_types.flatten) end find_inherited_value(:orphan_types, EMPTY_ARRAY) + own_orphan_types end |
.plugins ⇒ Object
739 740 741 |
# File 'lib/graphql/schema.rb', line 739 def plugins find_inherited_value(:plugins, EMPTY_ARRAY) + own_plugins end |
.query(new_query_object = nil) ⇒ Object
808 809 810 811 812 813 814 815 |
# File 'lib/graphql/schema.rb', line 808 def query(new_query_object = nil) if new_query_object @query_object = new_query_object else query_object = @query_object || find_inherited_value(:query) query_object.respond_to?(:graphql_definition) ? query_object.graphql_definition : query_object end end |
.query_analyzer(new_analyzer) ⇒ Object
1069 1070 1071 1072 1073 1074 |
# File 'lib/graphql/schema.rb', line 1069 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
1076 1077 1078 |
# File 'lib/graphql/schema.rb', line 1076 def query_analyzers find_inherited_value(:query_analyzers, EMPTY_ARRAY) + own_query_analyzers end |
.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object
858 859 860 861 862 863 864 |
# File 'lib/graphql/schema.rb', line 858 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 |
.rescue_from(*err_classes, &handler_block) ⇒ Object
942 943 944 945 946 |
# File 'lib/graphql/schema.rb', line 942 def rescue_from(*err_classes, &handler_block) err_classes.each do |err_class| own_rescues[err_class] = handler_block end end |
.rescues ⇒ Object
948 949 950 |
# File 'lib/graphql/schema.rb', line 948 def rescues find_inherited_value(:rescues, EMPTY_HASH).merge(own_rescues) end |
.resolve_type(type, obj, ctx) ⇒ Object
952 953 954 955 956 957 958 |
# File 'lib/graphql/schema.rb', line 952 def resolve_type(type, obj, ctx) if type.kind.object? type else raise NotImplementedError, "#{self.name}.resolve_type(type, obj, ctx) must be implemented to use Union types or Interface types (tried to resolve: #{type.name})" end end |
.subscription(new_subscription_object = nil) ⇒ Object
826 827 828 829 830 831 832 833 |
# File 'lib/graphql/schema.rb', line 826 def subscription(new_subscription_object = nil) if new_subscription_object @subscription_object = new_subscription_object else subscription_object = @subscription_object || find_inherited_value(:subscription) subscription_object.respond_to?(:graphql_definition) ? subscription_object.graphql_definition : subscription_object end end |
.subscription_execution_strategy(new_subscription_execution_strategy = nil) ⇒ Object
874 875 876 877 878 879 880 |
# File 'lib/graphql/schema.rb', line 874 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.
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 |
# File 'lib/graphql/schema.rb', line 1211 def self.sync_lazy(value) if block_given? # This was already hit by the instance, just give it back yield(value) else # This was called directly on the class, hit the instance # which has the lazy method map self.graphql_definition.sync_lazy(value) end end |
.to_graphql ⇒ Object
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
# File 'lib/graphql/schema.rb', line 743 def to_graphql schema_defn = self.new schema_defn.raise_definition_error = true schema_defn.query = query schema_defn.mutation = mutation schema_defn.subscription = subscription 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 schema_defn.disable_introspection_entry_points = disable_introspection_entry_points? 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 all_instrumenters.each do |step, insts| insts.each do |inst| schema_defn.instrumenters[step] << inst end end lazy_classes.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 if plugins.any? schema_plugins = plugins # TODO don't depend on .define schema_defn = schema_defn.redefine do schema_plugins.each do |plugin, | if .any? use(plugin, **) else use(plugin) end end end end # Do this after `plugins` since Interpreter is a plugin if schema_defn.query_execution_strategy != GraphQL::Execution::Interpreter schema_defn.instrumenters[:query] << GraphQL::Schema::Member::Instrumentation end schema_defn.send(:rebuild_artifacts) schema_defn end |
.tracer(new_tracer) ⇒ Object
1061 1062 1063 |
# File 'lib/graphql/schema.rb', line 1061 def tracer(new_tracer) own_tracers << new_tracer end |
.tracers ⇒ Object
1065 1066 1067 |
# File 'lib/graphql/schema.rb', line 1065 def tracers find_inherited_value(:tracers, EMPTY_ARRAY) + own_tracers end |
.type_error(type_err, ctx) ⇒ Object
1023 1024 1025 |
# File 'lib/graphql/schema.rb', line 1023 def type_error(type_err, ctx) DefaultTypeError.call(type_err, ctx) 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.
1019 1020 1021 |
# File 'lib/graphql/schema.rb', line 1019 def () () 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.
1003 1004 1005 |
# File 'lib/graphql/schema.rb', line 1003 def () nil end |
.use(plugin, options = {}) ⇒ Object
735 736 737 |
# File 'lib/graphql/schema.rb', line 735 def use(plugin, = {}) own_plugins << [plugin, ] end |
.visible?(member, context) ⇒ Boolean
968 969 970 |
# File 'lib/graphql/schema.rb', line 968 def visible?(member, context) call_on_type_class(member, :visible?, context, default: true) end |
Instance Method Details
#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
)
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 |
# File 'lib/graphql/schema.rb', line 1193 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.
686 687 688 |
# File 'lib/graphql/schema.rb', line 686 def as_json(only: nil, except: nil, context: {}) execute(Introspection::INTROSPECTION_QUERY, only: only, except: except, context: context).to_h 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
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/graphql/schema.rb', line 501 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
157 158 159 |
# File 'lib/graphql/schema.rb', line 157 def default_filter GraphQL::Filter.new(except: default_mask) end |
#define(**kwargs, &block) ⇒ Object
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/graphql/schema.rb', line 276 def define(**kwargs, &block) super ensure_defined # Assert that all necessary configs are present: validation_error = Validation.validate(self) validation_error && raise(NotImplementedError, validation_error) rebuild_artifacts @definition_error = nil nil rescue StandardError => err if @raise_definition_error || err.is_a?(CyclicalDefinitionError) raise else # Raise this error _later_ to avoid messing with Rails constant loading @definition_error = err end nil end |
#execute(query_str = nil, **kwargs) ⇒ Hash
Execute a query on itself. Raises an error if the schema definition is invalid.
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/graphql/schema.rb', line 351 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
469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/graphql/schema.rb', line 469 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”)
401 402 403 404 |
# File 'lib/graphql/schema.rb', line 401 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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/graphql/schema.rb', line 412 def get_field(parent_type, field_name) with_definition_error_check do parent_type_name = case parent_type when GraphQL::BaseType parent_type.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
438 439 440 |
# File 'lib/graphql/schema.rb', line 438 def get_fields(type) @instrumented_field_map[type.graphql_name] end |
#id_from_object(object, type, ctx) ⇒ String
Get a unique identifier from this object
618 619 620 621 622 623 624 |
# File 'lib/graphql/schema.rb', line 618 def id_from_object(object, type, ctx) if @id_from_object_proc.nil? raise(NotImplementedError, "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
627 628 629 |
# File 'lib/graphql/schema.rb', line 627 def id_from_object=(new_proc) @id_from_object_proc = new_proc end |
#initialize_copy(other) ⇒ Object
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/graphql/schema.rb', line 216 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
212 213 214 |
# File 'lib/graphql/schema.rb', line 212 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
.
300 301 302 303 304 305 |
# File 'lib/graphql/schema.rb', line 300 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
205 206 207 |
# File 'lib/graphql/schema.rb', line 205 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.
325 326 327 328 329 330 |
# File 'lib/graphql/schema.rb', line 325 def introspection_system @introspection_system ||= begin rebuild_artifacts @introspection_system end end |
#lazy?(obj) ⇒ Boolean
Returns True if this object should be lazily resolved
662 663 664 |
# File 'lib/graphql/schema.rb', line 662 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.
657 658 659 |
# File 'lib/graphql/schema.rb', line 657 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.
387 388 389 390 391 |
# File 'lib/graphql/schema.rb', line 387 def multiplex(queries, **kwargs) with_definition_error_check { GraphQL::Execution::Multiplex.run_all(self, queries, **kwargs) } end |
#object_from_id(id, ctx) ⇒ Any
Fetch an application object by its unique id
551 552 553 554 555 556 557 |
# File 'lib/graphql/schema.rb', line 551 def object_from_id(id, ctx) if @object_from_id_proc.nil? raise(NotImplementedError, "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
560 561 562 |
# File 'lib/graphql/schema.rb', line 560 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
604 605 606 |
# File 'lib/graphql/schema.rb', line 604 def parse_error(err, ctx) @parse_error_proc.call(err, ctx) end |
#parse_error=(new_proc) ⇒ Object
609 610 611 |
# File 'lib/graphql/schema.rb', line 609 def parse_error=(new_proc) @parse_error_proc = new_proc end |
#possible_types(type_defn) ⇒ Array<GraphQL::ObjectType>
Returns types which belong to type_defn
in this schema
449 450 451 452 |
# File 'lib/graphql/schema.rb', line 449 def possible_types(type_defn) @possible_types ||= GraphQL::Schema::PossibleTypes.new(self) @possible_types.possible_types(type_defn) end |
#references_to(type_name) ⇒ Hash
Returns a list of Arguments and Fields referencing a certain type
335 336 337 338 |
# File 'lib/graphql/schema.rb', line 335 def references_to(type_name) rebuild_artifacts unless defined?(@type_reference_map) @type_reference_map.fetch(type_name, []) end |
#remove_handler(*args, &block) ⇒ Object
248 249 250 |
# File 'lib/graphql/schema.rb', line 248 def remove_handler(*args, &block) rescue_middleware.remove_handler(*args, &block) end |
#rescue_from(*args, &block) ⇒ Object
244 245 246 |
# File 'lib/graphql/schema.rb', line 244 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)
489 490 491 492 493 494 495 496 |
# File 'lib/graphql/schema.rb', line 489 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(NotImplementedError, "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
542 543 544 545 |
# File 'lib/graphql/schema.rb', line 542 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?
456 457 458 459 460 461 462 463 464 465 466 467 |
# File 'lib/graphql/schema.rb', line 456 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
308 309 310 311 312 313 |
# File 'lib/graphql/schema.rb', line 308 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.
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'lib/graphql/schema.rb', line 1224 def sync_lazy(value) self.class.sync_lazy(value) { |v| lazy_method = lazy_method_name(v) if lazy_method synced_value = value.public_send(lazy_method) sync_lazy(synced_value) else v end } end |
#to_definition(only: nil, except: nil, context: {}) ⇒ String
Return the GraphQL IDL for the schema
671 672 673 |
# File 'lib/graphql/schema.rb', line 671 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
677 678 679 |
# File 'lib/graphql/schema.rb', line 677 def to_document GraphQL::Language::DocumentFromSchemaDefinition.new(self).document end |
#to_json(*args) ⇒ String
Returns the JSON response of Introspection::INTROSPECTION_QUERY.
693 694 695 |
# File 'lib/graphql/schema.rb', line 693 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.
584 585 586 |
# File 'lib/graphql/schema.rb', line 584 def type_error(err, ctx) @type_error_proc.call(err, ctx) end |
#type_error=(new_proc) ⇒ Object
589 590 591 |
# File 'lib/graphql/schema.rb', line 589 def type_error=(new_proc) @type_error_proc = new_proc end |
#type_from_ast(ast_node) ⇒ Object
442 443 444 |
# File 'lib/graphql/schema.rb', line 442 def type_from_ast(ast_node) GraphQL::Schema::TypeExpression.build_type(self.types, ast_node) end |
#types ⇒ GraphQL::Schema::TypeMap
Returns { name => type }
pairs of types in this schema
317 318 319 320 321 322 |
# File 'lib/graphql/schema.rb', line 317 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
343 344 345 346 |
# File 'lib/graphql/schema.rb', line 343 def union_memberships(type) rebuild_artifacts unless defined?(@union_memberships) @union_memberships.fetch(type.name, []) end |
#using_ast_analysis? ⇒ Boolean
252 253 254 |
# File 'lib/graphql/schema.rb', line 252 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.
262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/graphql/schema.rb', line 262 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 |