Class GraphqlLoadMethod

A load_* method on a sub-class of either GraphQL::Schema::RelayClassicMutation or GraphQL::Schema::Resolver.

This method takes user input (some kind of ID or specifier) and is intended to resolve the domain object using that ID.

For example:

module Mutation
  class NameAnInstrument < BaseMutation
    argument :instrument_uuid, Types::Uuid,
             required: true,
             loads: ::Instrument,
             as: :instrument,
    argument :name, String, required: true

    # GraphqlLoadMethod
    def load_instrument(uuid)
      ::Instrument.find_by(uuid: uuid)
    end

    def resolve(instrument:, name:)
      instrument.set_name(name)
    end
  end
end

Import path

import codeql.ruby.frameworks.GraphQL

Direct supertypes

Indirect supertypes

Predicates

getARoutedParameter	Gets a parameter that could receive parts of the url when handling incoming requests, if any. These automatically become a `RemoteFlowSource`.
getAnHttpMethod	Gets an HTTP method name, in all caps, that this handler will respond to. Handlers can potentially respond to multiple HTTP methods.
getFramework	Gets a string that identifies the framework used for this request handler.
getMutationClass	Gets the mutation class containing this method.

Inherited predicates

getAChild	Gets a child node of this `AstNode`.	from AstNode
getAChild	Gets a child of this node, which can also be retrieved using a predicate named `pred`.	from MethodBase
getAControlFlowEntryNode	Gets a control-flow entry node for this statement, if any	from Stmt
getAControlFlowNode	Gets a control-flow node for this statement, if any.	from Stmt
getAParameter	Gets a parameter of this callable.	from Callable
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this node belongs.	from Method
getARescue	Gets a rescue clause in this block.	from BodyStmt
getAStmt	Gets a statement in this sequence.	from StmtSequence
getAVariable	Gets a variable declared in this scope.	from Scope
getCfgScope	Gets the control-flow scope of this statement, if any.	from Stmt
getConstantValue	Gets the constant value of this expression, if any.	from Expr
getDesugared	Gets the desugared version of this AST node, if any.	from AstNode
getElse	Gets the `else` clause in this block, if any.	from BodyStmt
getEnclosingCallable	Gets the enclosing callable, if any.	from Stmt
getEnclosingMethod	Gets the enclosing method, if any.	from AstNode
getEnclosingModule	Gets the enclosing module, if any.	from AstNode
getEnclosingToplevel	Gets the enclosing top-level.	from AstNode
getEnsure	Gets the `ensure` clause in this block, if any.	from BodyStmt
getFile	Gets the file of this node.	from AstNode
getLastStmt	Gets the last statement in this sequence, if any.	from StmtSequence
getLocation	Gets the location of this node.	from AstNode
getName	Gets the name of this method.	from Method
getNumberOfParameters	Gets the number of parameters of this callable.	from Callable
getNumberOfStatements	Gets the number of statements in this sequence.	from StmtSequence
getOuterScope	Gets the outer scope, if any.	from Scope
getParameter	Gets the `n`th parameter of this callable.	from Method
getParent	Gets the parent of this `AstNode`, if this node is not a root node.	from AstNode
getPrimaryQlClasses	Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.	from AstNode
getRescue	Gets the `n`th rescue clause in this block.	from BodyStmt
getStmt	Gets the `n`th statement in this sequence.	from BodyStmt
getVariable	Gets the variable named `name` declared in this scope.	from Scope
getVisibility	Gets a string describing the visibility of this method. This is either ‘public’, ‘private’ or ‘protected’.	from Method
hasEnsure	Holds if this block has an `ensure` block.	from BodyStmt
hasName	Holds if the name of this method is `name`.	from MethodBase
isEmpty	Holds if this sequence has no statements.	from StmtSequence
isPrivate	Holds if this method is private. All methods with the name prefix `private` are private below:	from Method
isProtected	Holds if this method is protected.	from MethodBase
isPublic	Holds if this method is public. Methods are public by default.	from MethodBase
isSetter	Holds if this is a setter method, as in the following example: `rb class Person def name=(n) @name = n end end`	from Method
isSynthesized	Holds if this node was synthesized to represent an implicit AST node not present in the source code. In the following example method call, the receiver is an implicit `self` reference, for which there is a synthesized `Self` node.	from AstNode
toString	Gets a textual representation of this node.	from Method

Charpred

GraphqlLoadMethod