GraphQL Ruby API Documentation

🔍

No recent searches

☰

Pages

Guides
- Authorization
- Changesets
- Dataloader
- Defer
- Development
- Errors
- Execution
  - New Execution Module
  - Migrating to Execution::Next
- Fields
- JavaScript Client
- Language Tools
  - AST Visitor
  - C-based Parser
- Limiters
- Mutations
- Object Cache
- Operation Store
- Pagination
- Pro
- Queries
- Relay
  - RangeAdd helper for mutations
- Schema
- Subscriptions
- Testing
- Type Definitions

Classes and Modules

GraphQL
- Analysis
  - Analyzer
  - FieldUsage
  - MaxQueryComplexity
  - MaxQueryDepth
  - QueryComplexity
    ScopedTypeComplexity
  - QueryDepth
  - TimeoutError
  - Visitor
- AnalysisError
- Autoload
- Backtrace
  - Table
  - TracedError
- CoercionError
- Current
- Dashboard
- Dataloader
  - ActiveRecordAssociationSource
    RECORD_SOURCE_CLASS
  - ActiveRecordSource
  - AsyncDataloader
    Run
  - NullDataloader
  - Request
  - RequestAll
  - Source
- DateEncodingError
- Dig
- DurationEncodingError
- EmptyObjects
- Error
- Execution
  - Errors
  - FieldResolveStep
  - Finalize
  - Finalizer
  - HaltExecution
  - InputValues
  - Interpreter
    ArgumentValue
    Arguments
    ArgumentsCache
    ExecutionErrors
    ListResultFailedError
    RawValue
    Resolve
    Runtime
    CurrentState
    GraphQLResult
    GraphQLResultArray
    GraphQLResultHash
  - Lazy
    LazyMethodMap
    ConcurrentishMap
  - LoadArgumentStep
  - Lookahead
    NullLookahead
  - Next
    SchemaExtension
  - PostProcessor
  - PrepareObjectStep
  - ResolveTypeStep
  - Runner
  - SelectionsStep
- ExecutionError
- FloatDecodingError
- FloatEncodingError
- IntegerDecodingError
- IntegerEncodingError
- Introspection
  - BaseObject
  - DirectiveLocationEnum
  - DirectiveType
  - DynamicFields
  - EntryPoints
  - EnumValueType
  - FieldType
  - InputValueType
  - SchemaType
  - TypeKindEnum
  - TypeType
- InvalidNameError
- InvalidNullError
- InvariantError
- Language
  - BlockString
  - Cache
  - Comment
  - DefinitionSlice
    DependencyVisitor
  - Generation
  - Lexer
    ByteFor
    Punctuation
  - Nodes
    AbstractNode
    DefinitionNode
    Argument
    Directive
    DirectiveDefinition
    DirectiveLocation
    Document
    Enum
    EnumTypeDefinition
    EnumTypeExtension
    EnumValueDefinition
    Field
    FieldDefinition
    FragmentDefinition
    FragmentSpread
    InlineFragment
    InputObject
    InputObjectTypeDefinition
    InputObjectTypeExtension
    InputValueDefinition
    InterfaceTypeDefinition
    InterfaceTypeExtension
    ListType
    NameOnlyNode
    NonNullType
    NullValue
    ObjectTypeDefinition
    ObjectTypeExtension
    OperationDefinition
    ScalarTypeDefinition
    ScalarTypeExtension
    SchemaDefinition
    SchemaExtension
    TypeName
    UnionTypeDefinition
    UnionTypeExtension
    VariableDefinition
    VariableIdentifier
    WrapperType
  - Parser
    SchemaParser
  - Printer
    TruncatableBuffer
    TruncateSizeReached
  - SanitizedPrinter
  - StaticVisitor
  - Visitor
    DeleteNode
- LoadApplicationObjectFailedError
- NameValidator
- Pagination
- ParseError
- Query
  - Context
    ExecutionErrors
    Scoped
    ScopedContext
  - InputValidationResult
  - NullContext
    NullQuery
    NullSchema
  - OperationNameMissingError
  - Partial
    Result
  - Result
  - Runnable
  - VariableValidationError
  - Variables
- Railtie
- RakeTask
  - Validate
- Relay
  - RangeAdd
- RequiredImplementationMissingError
- Rubocop
  - GraphQL
    BaseCop
    DefaultNullTrue
    DefaultRequiredTrue
    FieldTypeInBlock
    RootTypesInBlock
- RuntimeError
- RuntimeTypeError
- Schema
  - Addition
  - AlwaysVisible
  - Argument
    InvalidDefaultValueError
  - BuildFromDefinition
    Builder
    TypeResolver
    ResolveMap
    DefaultResolve
    NullScalarCoerce
  - Directive
    Deprecated
    Feature
    Flagged
    VisibleByFlag
    Include
    InvalidArgumentError
    OneOf
    IsOneOf
    Skip
    SpecifiedBy
    Transform
    Transformer
  - DuplicateNamesError
  - Enum
    MissingValuesError
    UnresolvedValueError
  - EnumValue
  - Field
    ConnectionExtension
    ExtendedState
    FieldImplementationFailed
    MissingReturnTypeError
    ScopeExtension
  - FieldExtension
  - FindInheritedValue
  - Finder
    MemberNotFoundError
  - HasSingleInputArgument
    ClassMethods
  - InputObject
    ArgumentsAreRequiredError
  - Interface
    DefinitionMethods
  - IntrospectionSystem
  - InvalidDocumentError
  - List
  - Loader
  - Member
    BaseDSLMethods
    ConfigurationExtension
    HasArguments
    ArgumentClassAccessor
    ArgumentObjectLoader
    ClassConfigured
    InheritedArguments
    FieldConfigured
    HasDirectiveArguments
    HasAstNode
    HasAuthorization
    ClassConfigured
    InstanceConfigured
    HasDataloader
    HasDeprecationReason
    ClassMethods
    HasDirectives
    HasFields
    InterfaceMethods
    ObjectMethods
    HasInterfaces
    ClassConfigured
    InheritedInterfaces
    HasPath
    HasUnresolvedTypeError
    HasValidators
    ClassConfigured
    ClassValidators
    RelayShortcuts
    Scoped
    TypeSystemHelpers
    ValidatesInput
  - Mutation
  - NonNull
  - Object
    FieldsAreRequiredError
  - Printer
    IntrospectionPrinter
  - RactorShareable
    SchemaExtension
    FrozenMethods
  - RelayClassicMutation
  - Resolver
    HasPayloadType
  - Scalar
  - SubclassGetReferencesTo
  - Subscription
    EarlyUnsubscribe
  - Timeout
    TimeoutError
    Trace
  - TypeMembership
  - Union
  - UniqueWithinType
  - UnresolvedLateBoundTypeError
  - Validator
    AllValidator
    AllowBlankValidator
    AllowNullValidator
    ExclusionValidator
    FormatValidator
    InclusionValidator
    LengthValidator
    NumericalityValidator
    RequiredValidator
    ValidationFailedError
  - Visibility
    Migration
    RuntimeTypesMismatchError
    Profile
    TypeConfigurationError
    Visit
  - Warden
    NullWarden
    PassThruWarden
    VisibilityProfile
  - Wrapper
- StaticValidation
- StringEncodingError
- Subscriptions
- Testing
  - Helpers
    Error
    FieldNotDefinedError
    FieldNotVisibleError
    ResolutionAssertionContext
    SchemaHelpers
    TypeNotDefinedError
    TypeNotVisibleError
  - MockActionCable
    MockChannel
- Tracing
  - ActiveSupportNotificationsTrace
  - ActiveSupportNotificationsTracing
  - AppOpticsTrace
  - AppOpticsTracing
  - AppsignalTrace
    AppsignalMonitor
    Event
  - AppsignalTracing
  - CallLegacyTracers
  - DataDogTrace
    DatadogMonitor
    Event
  - DataDogTracing
  - DetailedTrace
    ActiveRecordBackend
    GraphqlDetailedTrace
    MemoryBackend
    RedisBackend
    StoredTrace
  - LegacyHooksTrace
    RunHooks
  - LegacyTrace
  - MonitorTrace
    Monitor
    Event
    GraphQLPrefixNames
    GraphQLSuffixNames
  - NewRelicTrace
    NewrelicMonitor
    Event
  - NewRelicTracing
  - NotificationsTrace
    ActiveSupportNotificationsAdapter
    Event
    Adapter
    Event
    DryMonitorAdapter
    Event
  - NotificationsTracing
  - NullTracer
  - PerfettoTrace
    ArgumentsFilter
  - PlatformTrace
    BaseKeyCache
  - PrometheusTrace
    GraphQLCollector
    PrometheusMonitor
    Event
  - PrometheusTracing
    GraphQLCollector
  - ScoutTrace
    ScoutMonitor
    Event
  - ScoutTracing
  - SentryTrace
    SentryMonitor
    Event
  - StatsdTrace
    StatsdMonitor
    Event
  - StatsdTracing
  - Trace
- TypeKinds
  - TypeKind
- Types
  - BigInt
  - Boolean
  - Float
  - ID
  - ISO8601Date
  - ISO8601DateTime
  - ISO8601Duration
  - Int
  - JSON
  - Relay
    BaseConnection
    BaseEdge
    ClassMethods
    ConnectionBehaviors
    ClassMethods
    EdgeBehaviors
    ClassMethods
    HasNodeField
    ExecutionMethods
    HasNodesField
    ExecutionMethods
    Node
    NodeBehaviors
    ClassMethods
    ExecutionMethods
    PageInfo
    PageInfoBehaviors
  - String
- UnauthorizedEnumValueError
- UnauthorizedError
- UnauthorizedFieldError
- UnresolvedTypeError
Graphql
- Dashboard
  - ApplicationController
  - DetailedTraces
    TracesController
  - Installable
  - LandingsController
  - Limiters
    LimitersController
  - OperationStore
    BaseController
    ClientsController
    IndexEntriesController
    OperationsController
  - StaticsController
  - Subscriptions
    BaseController
    SubscriptionsController
    TopicsController
- Generators
  - Core
  - DetailedTraceGenerator
  - EnumGenerator
  - FieldExtractor
  - InputGenerator
  - Install
    MutationRootGenerator
  - InstallGenerator
  - InterfaceGenerator
  - LoaderGenerator
  - MutationCreateGenerator
  - MutationDeleteGenerator
  - MutationGenerator
  - MutationUpdateGenerator
  - ObjectGenerator
  - OrmMutationsBase
  - Relay
  - RelayGenerator
  - ScalarGenerator
  - TypeGeneratorBase
    NormalizedField
  - UnionGenerator

GraphQL-Pro feature This feature ships with GraphQL-Pro and is not included in GraphQL-Ruby OSS.

GraphQL::Pro Home