class GraphQL::Schema::Field

Field definitions are the primary way to expose data from an object type. Keep field-specific behavior and examples here; the guide is only an entry point for the broader fields documentation.

Object fields expose data about that object or connect the object to other objects. You can add fields to your object types with the field(...) class method, for example:

field :name, String, "The unique name of this list", null: false

Objects and Interfaces have fields.

The different elements of field definition are addressed below:

Field Names

A field’s name is provided as the first argument or as the name: option:

field :team_captain, ...
# or:
field ..., name: :team_captain

Under the hood, GraphQL-Ruby camelizes field names, so field :team_captain, ... would be { teamCaptain } in GraphQL. You can disable this behavior by adding camelize: false to your field definition or to the default field options.

The field’s name is also used as the basis of field resolution.

Field Return Type

The second argument to field(...) is the return type. This can be:

Nullability is expressed with the null: keyword:

Additionally, list types maybe nullable by adding [..., null: true] to the definition.

Here are some examples:

field :name, String # `String`, may return a `String` or `nil`
field :id, ID, null: false # `ID!`, always returns an `ID`, never `nil`
field :teammates, [Types::User], null: false # `[User!]!`, always returns a list containing `User`s
field :scores, [Integer, null: true] # `[Int]`, may return a list or `nil`, the list may contain a mix of `Integer`s and `nil`s

Field Documentation

Fields may be documented with a description, comment and may be deprecated.

Descriptions can be added with the field(...) method as a positional argument, a keyword argument, or inside the block:

# 3rd positional argument
field :name, String, "The name of this thing", null: false

# `description:` keyword
field :name, String, null: false,
  description: "The name of this thing"

# inside the block
field :name, String, null: false do
  description "The name of this thing"
end

Comments can be added with the field(...) method as a keyword argument, or inside the block:

# `comment:` keyword
field :name, String, null: false, comment: "Rename to full name"

# inside the block
field :name, String, null: false do
  comment "Rename to full name"
end

Generates field name with comment above “Rename to full name” above.

type Foo {
    # Rename to full name
    name: String!
}

Deprecated fields can be marked by adding a deprecation_reason: keyword argument:

field :email, String,
  deprecation_reason: "Users may have multiple emails, use `User.emails` instead."

Fields with a deprecation_reason: will appear as “deprecated” in GraphiQL.

Field Resolution

In general, fields return Ruby values corresponding to their GraphQL return types. For example, a field with the return type String should return a Ruby string, and a field with the return type [User!]! should return a Ruby array with zero or more User objects in it.

By default, fields return values by:

The method name or hash key corresponds to the field name, so in this example:

field :top_score, Integer, null: false

The default behavior is to look for a #top_score method, or lookup a Hash key, :top_score (symbol) or "top_score" (string).

You can override the method name with the method: keyword, or override the hash key(s) with the hash_key: or dig: keyword, for example:

# Use the `#best_score` method to resolve this field
field :top_score, Integer, null: false,
  method: :best_score

# Lookup `hash["allPlayers"]` to resolve this field
field :players, [User], null: false,
  hash_key: "allPlayers"

# Use the `#dig` method on the hash with `:nested` and `:movies` keys
field :movies, [Movie], null: false,
  dig: [:nested, :movies]

To pass-through the underlying object without calling a method on it, you can use method: :itself:

field :player, User, null: false,
  method: :itself

This is equivalent to:

field :player, User, null: false

def player
  object
end

If you don’t want to delegate to the underlying object, you can define a method for each field:

# Use the custom method below to resolve this field
field :total_games_played, Integer, null: false

def total_games_played
  object.games.count
end

Inside the method, you can access some helper methods:

Additionally, when you define arguments (see below), they’re passed to the method definition, for example:

# Call the custom method with incoming arguments
field :current_winning_streak, Integer, null: false do
  argument :include_ties, Boolean, required: false, default_value: false
end

def current_winning_streak(include_ties:)
  # Business logic goes here
end

As the examples above show, by default the custom method name must match the field name. If you want to use a different custom method, the resolver_method option is available:

# Use the custom method with a non-default name below to resolve this field
field :total_games_played, Integer, null: false, resolver_method: :games_played

def games_played
  object.games.count
end

resolver_method has two main use cases:

  1. resolver re-use between multiple fields

  2. dealing with method conflicts (specifically if you have fields named context or object)

Note that resolver_method cannot be used in combination with method or hash_key.

Field Arguments

Arguments allow fields to take input to their resolution. For example:

Read more in the Arguments guide

Extra Field Metadata

Inside a field method, you can access some low-level objects from the GraphQL-Ruby runtime. Be warned, these APIs are subject to change, so check the changelog when updating.

A few extras are available:

To inject them into your field method, first, add the extras: option to the field definition:

field :my_field, String, null: false, extras: [:ast_node]

Then add ast_node: keyword to the method signature:

def my_field(ast_node:)
  # ...
end

At runtime, the requested runtime object will be passed to the field.

Custom extras are also possible. Any method on your field class can be passed to extras: [...], and the value will be injected into the method. For example, extras: [:owner] will inject the object type who owns the field. Any new methods on your custom field class may be used, too.

Field Parameter Default Values

The field method requires you to pass null: keyword argument to determine whether the field is nullable or not. For another field you may want to override camelize, which is true by default. You can override this behavior by adding a custom field with overwritten camelize option, which is true by default.

class CustomField < GraphQL::Schema::Field
  # Add `null: false` and `camelize: false` which provide default values
  # in case the caller doesn't pass anything for those arguments.
  # **kwargs is a catch-all that will get everything else
  def initialize(*args, null: false, camelize: false, **kwargs, &block)
    # Then, call super _without_ any args, where Ruby will take
    # _all_ the args originally passed to this method and pass it to the super method.
    super
  end
end

To use CustomField in your Objects and Interfaces, you’ll need to register it as a field_class on those classes. See Customizing Fields for more information on how to do so.

Attributes