Settings View Source Print cheatsheet DSL: AshGraphql.Resource

graphql

Configuration for a given resource in graphql

graphql do
  type :post

  queries do
    get :get_post, :read
    list :list_posts, :read
  end

  mutations do
    create :create_post, :create
    update :update_post, :update
    destroy :destroy_post, :destroy
  end
end

graphql.queries

Queries (read actions) to expose for the resource.

queries do
  get :get_post, :read
  read_one :current_user, :current_user
  list :list_posts, :read
end

graphql.queries.get

get name, action

A query to fetch a record by primary key

get :get_post, :read

graphql.queries.read_one

read_one name, action

A query to fetch a record

read_one :current_user, :current_user

graphql.queries.list

list name, action

A query to fetch a list of records

list :list_posts, :read

list :list_posts_paginated, :read, relay?: true

graphql.queries.action

action name, action

Runs a generic action

action :check_status, :check_status

graphql.mutations

Mutations (create/update/destroy actions) to expose for the resource.

mutations do
  create :create_post, :create
  update :update_post, :update
  destroy :destroy_post, :destroy
end

graphql.mutations.create

create name, action

A mutation to create a record

create :create_post, :create

graphql.mutations.update

update name, action

A mutation to update a record

update :update_post, :update

graphql.mutations.destroy

destroy name, action

A mutation to destroy a record

destroy :destroy_post, :destroy

graphql.mutations.action

action name, action

Runs a generic action

action :check_status, :check_status

graphql.managed_relationships

Generates input objects for manage_relationship arguments on resource actions.

managed_relationships do
  manage_relationship :create_post, :comments
end

graphql.managed_relationships.managed_relationship

managed_relationship action, argument

Instructs ash_graphql that a given argument with a manage_relationship change should have its input objects derived automatically from the potential actions to be called.

For example, given an action like:

actions do
create :create do
argument :comments, {:array, :map}

change manage_relationship(:comments, type: :direct_control) # <- we look for this change with a matching argument name
end
end

You could add the following managed_relationship

graphql do
...

managed_relationships do
managed_relationship :create, :comments
end
end

By default, the {:array, :map} would simply be a json[] type. If the argument name is placed in this list, all of the potential actions that could be called will be combined into a single input object. If there are type conflicts (for example, if the input could create or update a record, and the create and update actions have an argument of the same name but with a different type), a warning is emitted at compile time and the first one is used. If that is insufficient, you will need to do one of the following:

1.) provide the :types option to the managed_relationship constructor (see that option for more) 2.) define a custom type, with a custom input object (see the custom types guide), and use that custom type instead of :map 3.) change your actions to not have overlapping inputs with different types

Since managed relationships can ultimately call multiple actions, there is the possibility of field type conflicts. Use the types option to determine the type of fields and remove the conflict warnings.

For non_null use {:non_null, type}, and for a list, use {:array, type}, for example:

{:non_null, {:array, {:non_null, :string}}} for a non null list of non null strings.

To remove a key from the input object, simply pass nil as the type.