class GraphQL::Relay::Mutation
- give it a name (used for derived inputs & outputs) - declare its inputs - declare its outputs - declare the mutation procedure
`resolve` should return a hash with a key for each of the `return_field`s
Inputs may also contain a `clientMutationId`
@example Updating the name of an item
UpdateNameMutation = GraphQL::Relay::Mutation.define do name "UpdateName" input_field :name, !types.String input_field :itemId, !types.ID return_field :item, ItemType resolve ->(inputs, ctx) { item = Item.find_by_id(inputs[:id]) item.update(name: inputs[:name]) {item: item} } end MutationType = GraphQL::ObjectType.define do # The mutation object exposes a field: field :updateName, field: UpdateNameMutation.field end # Then query it: query_string = %Q| mutation updateName { updateName(input: {itemId: 1, name: "new name", clientMutationId: "1234"}) { item { name } clientMutationId }| GraphQL::Query.new(MySchema, query_string).result # {"data" => { # "updateName" => { # "item" => { "name" => "new name"}, # "clientMutationId" => "1234" # } # }}
@example Using a GraphQL::Function
class UpdateAttributes < GraphQL::Function attr_reader :model, :return_as, :arguments def initialize(model:, return_as:, attributes:) @model = model @arguments = {} attributes.each do |name, type| arg_name = name.to_s @arguments[arg_name] = GraphQL::Argument.define(name: arg_name, type: type) end @arguments["id"] = GraphQL::Argument.define(name: "id", type: !GraphQL::ID_TYPE) @return_as = return_as @attributes = attributes end def type fn = self GraphQL::ObjectType.define do name "Update#{fn.model.name}AttributesResponse" field :clientMutationId, types.ID field fn.return_as.keys[0], fn.return_as.values[0] end end def call(obj, args, ctx) record = @model.find(args[:inputs][:id]) new_values = {} @attributes.each { |a| new_values[a] = args[a] } record.update(new_values) { @return_as => record } end end UpdateNameMutation = GraphQL::Relay::Mutation.define do name "UpdateName" function UpdateAttributes.new(model: Item, return_as: { item: ItemType }, attributes: {name: !types.String}) end
Attributes
arguments[RW]
description[RW]
fields[RW]
input_fields[RW]
name[RW]
return_fields[RW]
return_interfaces[RW]
return_type[RW]
Public Class Methods
new()
click to toggle source
# File lib/graphql/relay/mutation.rb, line 115 def initialize @fields = {} @arguments = {} @has_generated_return_type = false end
Public Instance Methods
field()
click to toggle source
# File lib/graphql/relay/mutation.rb, line 131 def field @field ||= begin relay_mutation = self field_resolve_proc = @resolve_proc GraphQL::Field.define do type(relay_mutation.return_type) description(relay_mutation.description) argument :input, !relay_mutation.input_type resolve(field_resolve_proc) mutation(relay_mutation) end end end
has_generated_return_type?()
click to toggle source
# File lib/graphql/relay/mutation.rb, line 121 def has_generated_return_type? # Trigger the generation of the return type, if it is dynamically generated: return_type @has_generated_return_type end
input_type()
click to toggle source
# File lib/graphql/relay/mutation.rb, line 166 def input_type @input_type ||= begin relay_mutation = self input_object_type = GraphQL::InputObjectType.define do name("#{relay_mutation.name}Input") description("Autogenerated input type of #{relay_mutation.name}") input_field :clientMutationId, types.String, "A unique identifier for the client performing the mutation." mutation(relay_mutation) end input_fields.each do |name, arg| input_object_type.arguments[name] = arg end input_object_type end end
resolve=(new_resolve_proc)
click to toggle source
# File lib/graphql/relay/mutation.rb, line 127 def resolve=(new_resolve_proc) @resolve_proc = new_resolve_proc end
result_class()
click to toggle source
# File lib/graphql/relay/mutation.rb, line 183 def result_class @result_class ||= Result.define_subclass(self) end