Class: GraphQL::Schema
- Inherits:
-
Object
- Object
- GraphQL::Schema
- Includes:
- Define::InstanceDefinable
- Defined in:
- lib/graphql/schema.rb,
lib/graphql/schema/loader.rb,
lib/graphql/schema/warden.rb,
lib/graphql/schema/printer.rb,
lib/graphql/schema/null_mask.rb,
lib/graphql/schema/traversal.rb,
lib/graphql/schema/validation.rb,
lib/graphql/schema/possible_types.rb,
lib/graphql/schema/base_64_encoder.rb,
lib/graphql/schema/type_expression.rb,
lib/graphql/schema/middleware_chain.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/build_from_definition.rb,
lib/graphql/schema/build_from_definition/resolve_map.rb,
lib/graphql/schema/build_from_definition/resolve_map/default_resolve.rb
Overview
A GraphQL schema which may be queried with Query.
The Schema contains:
- types for exposing your application
- query analyzers for assessing incoming queries (including max depth & max complexity restrictions)
- execution strategies for running incoming queries
- middleware for interacting with execution
Schemas start with root types, #query, #mutation and #subscription.
The schema will traverse the tree of fields & types, using those as starting points.
Any undiscoverable types may be provided with the types
configuration.
Schemas can restrict large incoming queries with max_depth
and max_complexity
configurations.
(These configurations can be overridden by specific calls to #execute)
Schemas can specify how queries should be executed against them.
query_execution_strategy
, mutation_execution_strategy
and subscription_execution_strategy
each apply to corresponding root types.
A schema accepts a Relay::GlobalNodeIdentification
instance for use with Relay IDs.
Defined Under Namespace
Modules: Base64Encoder, BuildFromDefinition, CatchallMiddleware, DefaultParseError, DefaultTypeError, Loader, NullMask, TypeExpression, UniqueWithinType Classes: CyclicalDefinitionError, InvalidDocumentError, InvalidTypeError, MiddlewareChain, PossibleTypes, Printer, RescueMiddleware, TimeoutMiddleware, Traversal, Validation, Warden
Constant Summary collapse
- BUILT_IN_TYPES =
- DIRECTIVES =
[GraphQL::Directive::IncludeDirective, GraphQL::Directive::SkipDirective, GraphQL::Directive::DeprecatedDirective]
- DYNAMIC_FIELDS =
["__type", "__typename", "__schema"]
Class Attribute Summary collapse
-
.default_execution_strategy ⇒ Object
Returns the value of attribute default_execution_strategy.
Instance Attribute Summary collapse
-
#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.
-
#id_from_object_proc ⇒ Object
readonly
Returns the value of attribute id_from_object_proc.
-
#instrumenters ⇒ Object
Returns the value of attribute instrumenters.
-
#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.
Class Method Summary collapse
-
.from_definition(string, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) ⇒ GraphQL::Schema
Create schema from an IDL schema.
-
.from_introspection(introspection_result) ⇒ GraphQL::Schema
Create schema with the result of an introspection query.
Instance Method Summary collapse
-
#as_json(only: nil, except: nil, context: {}) ⇒ Hash
Return the Hash response of Introspection::INTROSPECTION_QUERY.
- #default_filter ⇒ Object
- #define(**kwargs, &block) ⇒ Object
-
#execute(query_str = nil, **kwargs) ⇒ Hash
Execute a query on itself.
- #execution_strategy_for_operation(operation) ⇒ Object
-
#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
-
#instrument(instrumentation_type, instrumenter) ⇒ void
Attach
instrumenter
to this schema for instrumenting events ofinstrumentation_type
. -
#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. - #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?
-
#to_definition(only: nil, except: nil, context: {}) ⇒ String
Return the GraphQL IDL 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. -
#validate(string_or_document, rules: nil) ⇒ Array<GraphQL::StaticValidation::Message>
Validate a query string according to this schema.
Methods included from Define::InstanceDefinable
Constructor Details
#initialize ⇒ Schema
Returns a new instance of Schema.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/graphql/schema.rb', line 107 def initialize @definition_error = nil @orphan_types = [] @directives = DIRECTIVES.reduce({}) { |m, d| m[d.name] = d; m } @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::Relay::ConnectionResolve::LazyNodesWrapper, :never_called) @cursor_encoder = Base64Encoder # Default to the built-in execution strategy: @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 end |
Class Attribute Details
.default_execution_strategy ⇒ Object
Returns the value of attribute default_execution_strategy.
92 93 94 |
# File 'lib/graphql/schema.rb', line 92 def default_execution_strategy @default_execution_strategy end |
Instance Attribute Details
#cursor_encoder ⇒ Object
Returns the value of attribute cursor_encoder.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def cursor_encoder @cursor_encoder end |
#default_mask ⇒ <#call(member, ctx)>
Returns A callable for filtering members of the schema.
89 90 91 |
# File 'lib/graphql/schema.rb', line 89 def default_mask @default_mask end |
#default_max_page_size ⇒ Object
Returns the value of attribute default_max_page_size.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def default_max_page_size @default_max_page_size end |
#directives ⇒ Object
Returns the value of attribute directives.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def directives @directives end |
#id_from_object_proc ⇒ Object (readonly)
Returns the value of attribute id_from_object_proc.
105 106 107 |
# File 'lib/graphql/schema.rb', line 105 def id_from_object_proc @id_from_object_proc end |
#instrumenters ⇒ Object
Returns the value of attribute instrumenters.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def instrumenters @instrumenters end |
#lazy_methods ⇒ Object
Returns the value of attribute lazy_methods.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def lazy_methods @lazy_methods end |
#max_complexity ⇒ Object
Returns the value of attribute max_complexity.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def max_complexity @max_complexity end |
#max_depth ⇒ Object
Returns the value of attribute max_depth.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def max_depth @max_depth end |
#middleware ⇒ MiddlewareChain
Returns MiddlewareChain which is applied to fields during execution.
85 86 87 |
# File 'lib/graphql/schema.rb', line 85 def middleware @middleware end |
#multiplex_analyzers ⇒ Object
Returns the value of attribute multiplex_analyzers.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def multiplex_analyzers @multiplex_analyzers end |
#mutation ⇒ Object
Returns the value of attribute mutation.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def mutation @mutation end |
#mutation_execution_strategy ⇒ Object
Returns the value of attribute mutation_execution_strategy.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def mutation_execution_strategy @mutation_execution_strategy end |
#object_from_id_proc ⇒ Object (readonly)
Returns the value of attribute object_from_id_proc.
105 106 107 |
# File 'lib/graphql/schema.rb', line 105 def object_from_id_proc @object_from_id_proc end |
#orphan_types ⇒ Object
Returns the value of attribute orphan_types.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def orphan_types @orphan_types end |
#query ⇒ Object
Returns the value of attribute query.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def query @query end |
#query_analyzers ⇒ Object
Returns the value of attribute query_analyzers.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def query_analyzers @query_analyzers end |
#query_execution_strategy ⇒ Object
Returns the value of attribute query_execution_strategy.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def query_execution_strategy @query_execution_strategy end |
#raise_definition_error ⇒ Object
Returns the value of attribute raise_definition_error.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def raise_definition_error @raise_definition_error end |
#resolve_type_proc ⇒ Object (readonly)
Returns the value of attribute resolve_type_proc.
105 106 107 |
# File 'lib/graphql/schema.rb', line 105 def resolve_type_proc @resolve_type_proc end |
#static_validator ⇒ Object (readonly)
Returns the value of attribute static_validator.
105 106 107 |
# File 'lib/graphql/schema.rb', line 105 def static_validator @static_validator end |
#subscription ⇒ Object
Returns the value of attribute subscription.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def subscription @subscription end |
#subscription_execution_strategy ⇒ Object
Returns the value of attribute subscription_execution_strategy.
75 76 77 |
# File 'lib/graphql/schema.rb', line 75 def subscription_execution_strategy @subscription_execution_strategy end |
Class Method Details
.from_definition(string, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) ⇒ GraphQL::Schema
Create schema from an IDL schema.
470 471 472 |
# File 'lib/graphql/schema.rb', line 470 def self.from_definition(string, default_resolve: BuildFromDefinition::DefaultResolve, parser: BuildFromDefinition::DefaultParser) GraphQL::Schema::BuildFromDefinition.from_definition(string, default_resolve: default_resolve, parser: parser) end |
.from_introspection(introspection_result) ⇒ GraphQL::Schema
Create schema with the result of an introspection query.
461 462 463 |
# File 'lib/graphql/schema.rb', line 461 def self.from_introspection(introspection_result) GraphQL::Schema::Loader.load(introspection_result) end |
Instance Method Details
#as_json(only: nil, except: nil, context: {}) ⇒ Hash
Return the Hash response of Introspection::INTROSPECTION_QUERY.
501 502 503 |
# File 'lib/graphql/schema.rb', line 501 def as_json(only: nil, except: nil, context: {}) execute(Introspection::INTROSPECTION_QUERY, only: only, except: except, context: context) end |
#default_filter ⇒ Object
95 96 97 |
# File 'lib/graphql/schema.rb', line 95 def default_filter GraphQL::Filter.new(except: default_mask) end |
#define(**kwargs, &block) ⇒ Object
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 184 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.
227 228 229 230 231 232 233 234 |
# File 'lib/graphql/schema.rb', line 227 def execute(query_str = nil, **kwargs) if query_str kwargs[:query] = query_str end # Since we're running one query, don't run a multiplex-level complexity analyzer all_results = multiplex([kwargs], max_complexity: nil) all_results[0] end |
#execution_strategy_for_operation(operation) ⇒ Object
325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/graphql/schema.rb', line 325 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 |
#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
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/graphql/schema.rb', line 266 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 field_name == "__typename" GraphQL::Introspection::TypenameField elsif field_name == "__schema" && parent_type == query GraphQL::Introspection::SchemaField elsif field_name == "__type" && parent_type == query GraphQL::Introspection::TypeByNameField else nil end end end |
#get_fields(type) ⇒ Hash<String, GraphQL::Field>
Fields for this type, after instrumentation is applied
294 295 296 |
# File 'lib/graphql/schema.rb', line 294 def get_fields(type) @instrumented_field_map[type.name] end |
#id_from_object(object, type, ctx) ⇒ String
Get a unique identifier from this object
445 446 447 448 449 450 451 |
# File 'lib/graphql/schema.rb', line 445 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
454 455 456 |
# File 'lib/graphql/schema.rb', line 454 def id_from_object=(new_proc) @id_from_object_proc = new_proc end |
#initialize_copy(other) ⇒ Object
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/graphql/schema.rb', line 132 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 @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 end |
#instrument(instrumentation_type, instrumenter) ⇒ void
This method returns an undefined value.
Attach instrumenter
to this schema for instrumenting events of instrumentation_type
.
208 209 210 211 212 213 |
# File 'lib/graphql/schema.rb', line 208 def instrument(instrumentation_type, instrumenter) @instrumenters[instrumentation_type] << instrumenter if instrumentation_type == :field rebuild_artifacts end end |
#lazy?(obj) ⇒ Boolean
Returns True if this object should be lazily resolved.
483 484 485 |
# File 'lib/graphql/schema.rb', line 483 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.
478 479 480 |
# File 'lib/graphql/schema.rb', line 478 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.
254 255 256 257 258 |
# File 'lib/graphql/schema.rb', line 254 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
383 384 385 386 387 388 389 |
# File 'lib/graphql/schema.rb', line 383 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
392 393 394 |
# File 'lib/graphql/schema.rb', line 392 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
431 432 433 |
# File 'lib/graphql/schema.rb', line 431 def parse_error(err, ctx) @parse_error_proc.call(err, ctx) end |
#parse_error=(new_proc) ⇒ Object
436 437 438 |
# File 'lib/graphql/schema.rb', line 436 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.
305 306 307 308 |
# File 'lib/graphql/schema.rb', line 305 def possible_types(type_defn) @possible_types ||= GraphQL::Schema::PossibleTypes.new(self) @possible_types.possible_types(type_defn) end |
#remove_handler(*args, &block) ⇒ Object
163 164 165 |
# File 'lib/graphql/schema.rb', line 163 def remove_handler(*args, &block) rescue_middleware.remove_handler(*args, &block) end |
#rescue_from(*args, &block) ⇒ Object
159 160 161 |
# File 'lib/graphql/schema.rb', line 159 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)
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/graphql/schema.rb', line 345 def resolve_type(type, object, ctx = :__undefined__) if ctx == :__undefined__ # Old method signature ctx = object object = type type = nil 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 if @resolve_type_proc.nil? raise(NotImplementedError, "Can't determine GraphQL type for: #{object.inspect}, define `resolve_type (obj, ctx) -> { ... }` inside `Schema.define`.") end @resolve_type_proc.call(type, object, ctx) end if type_result.nil? nil elsif !type_result.is_a?(GraphQL::BaseType) type_str = "#{type_result} (#{type_result.class.name})" raise "resolve_type(#{object}) returned #{type_str}, but it should return a GraphQL type" else type_result end end |
#resolve_type=(new_resolve_type_proc) ⇒ Object
374 375 376 377 |
# File 'lib/graphql/schema.rb', line 374 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?
312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/graphql/schema.rb', line 312 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 |
#to_definition(only: nil, except: nil, context: {}) ⇒ String
Return the GraphQL IDL for the schema
492 493 494 |
# File 'lib/graphql/schema.rb', line 492 def to_definition(only: nil, except: nil, context: {}) GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context) end |
#to_json(*args) ⇒ String
Returns the JSON response of Introspection::INTROSPECTION_QUERY.
508 509 510 |
# File 'lib/graphql/schema.rb', line 508 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.
416 417 418 |
# File 'lib/graphql/schema.rb', line 416 def type_error(err, ctx) @type_error_proc.call(err, ctx) end |
#type_error=(new_proc) ⇒ Object
421 422 423 |
# File 'lib/graphql/schema.rb', line 421 def type_error=(new_proc) @type_error_proc = new_proc end |
#type_from_ast(ast_node) ⇒ Object
298 299 300 |
# File 'lib/graphql/schema.rb', line 298 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.
217 218 219 220 221 222 |
# File 'lib/graphql/schema.rb', line 217 def types @types ||= begin rebuild_artifacts @types end end |
#validate(string_or_document, rules: nil) ⇒ Array<GraphQL::StaticValidation::Message>
Validate a query string according to this schema.
170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/graphql/schema.rb', line 170 def validate(string_or_document, rules: 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) validator_opts = { schema: self } rules && (validator_opts[:rules] = rules) validator = GraphQL::StaticValidation::Validator.new(validator_opts) res = validator.validate(query) res[:errors] end |