API Reference - Mutation

Insert/Upsert syntax

mutation [<mutation-name>] {
  <mutation-field-name> (
    [<input-object>!]
    [conflict-clause]
  )
  [mutation-response!]
}
Key Required Schema Description
mutation-name false Value Name mutation for observability
mutation-field-name true Value name of the auto-generated mutation field. E.g. insert_author
input-object true InputObject name of the auto-generated mutation field
mutation-response true MutationResponse Object to be returned after mutation succeeds.
on-conflict false ConflictClause Converts insert to upsert by handling conflict

E.g. INSERT:

mutation insert_article {
  insert_article(
    objects: [
      {
        title: "Software is gluttonous",
        content: "Something happened in HP",
        author_id: 3
      }
    ]
  ) {
    returning {
      id
      title
    }
  }
}

E.g. UPSERT:

mutation upsert_author {
  insert_author (
    objects: [
      {
        name: "John",
        id:12
      }
    ],
    on_conflict: {
      constraint: author_name_key,
      update_columns: [name, id]
    }
  ) {
    affected_rows
  }
}

Update syntax

mutation [<mutation-name>] {
  <mutation-field-name> (
    [where-argument!],
    [set-argument!]
  )
  [mutation-response!]
}
Key Required Schema Description
mutation-name false Value Name of mutation for observability
mutation-field-name true Value name of the auto-generated update mutation field. E.g. update_author
where-argument true whereArgExp selection criteria for rows to be updated
set-argument false setArgExp Data to be updated in the table
inc-argument false incArgExp Integer value to be incremented to Int columns in the table
append-argument false appendArgExp JSON value to be appended to JSONB columns in the table
prepend-argument false prependArgExp JSON value to be prepended to JSONB columns in the table
delete-key-argument false deleteKeyArgExp key to be deleted in the value of JSONB columns in the table
delete-elem-argument false deleteElemArgExp array element to be deleted in the value of JSONB columns in the table
delete-at-path-argument false deleteAtPathArgExp element at path to be deleted in the value of JSONB columns in the table
mutation-response true MutationResponse Object to be returned after mutation succeeds.

E.g. UPDATE:

mutation update_author{
  update_author(
    where: {id: {_eq: 3}},
    _set: {name: "Jane"}
  ) {
    affected_rows
  }
}

Delete syntax

mutation [<mutation-name>] {
  <mutation-field-name> (
    [where-argument!]
  )
  [mutation-response!]
}
Key Required Schema Description
mutation-name false Value Name of mutation for observability
mutation-field-name true Value name of the auto-generated delete mutation field. E.g. delete_author
where-argument true whereArgExp selection criteria for rows to delete
mutation-response true MutationResponse Object to be returned after mutation succeeds.

E.g. DELETE:

mutation delete_articles {
  delete_article(
    where: {author: {id: {_eq: 7}}}
  ) {
    affected_rows
    returning {
      id
    }
  }
}

Note

For more examples and details of usage, please see this.

Syntax definitions

Mutation Response

{
  affected_rows
  returning {
    response-field1
    response-field2
    ..
  }
}

E.g.:

{
  affected_rows
  returning {
    id
    author_id
  }
}

objects argument

objects: [
  {
    field1: value,
    field2: value,
    <object-rel-name>: {
      data: <Input-Object>!,
      on_conflict: <Conflict-Clause>
    },
    <array-rel-name>: {
      data: [<Input-Object>!]!,
      on_conflict: <Conflict-Clause>
    }
    ..
  },
  ..
]
# no nested objects

E.g.:

objects: [
  {
    title: "Software is eating the world",
    content: "This week, Hewlett-Packard...",
    author: {
      data: {
        id: 1,
        name: "Sydney"
      }
    }
  }
]

on_conflict argument

Conflict clause is used to convert an insert query to an upsert query. Upsert respects the table’s update permissions before editing an existing row in case of a conflict. Hence the conflict clause is permitted only if a table has update permissions defined.

on_conflict: {
  constraint: table_constraint!
  update_columns: [table_update_column!]!
}

E.g.:

on_conflict: {
  constraint: author_name_key
  update_columns: [name]
}

where argument

where: BoolExp

BoolExp

AndExp | OrExp | NotExp | TrueExp | ColumnExp
AndExp
{
  _and: [BoolExp]
}
OrExp
{
  _or: [BoolExp]
}
NotExp
{
  _not: BoolExp
}
TrueExp
{}
ColumnExp
{
  field-name: {Operator: Value }
}
Operator

Generic operators (all column types except json, jsonb):

  • _eq
  • _ne
  • _in
  • _nin
  • _gt
  • _lt
  • _gte
  • _lte

Operators for comparing columns (all column types except json, jsonb):

  • _ceq
  • _cneq
  • _cgt
  • _clt
  • _cgte
  • _cnlte

Text related operators:

  • _like
  • _nlike
  • _ilike
  • _nilike
  • _similar
  • _nsimilar

Checking for NULL values:

  • _is_null (takes true/false as values)

_set argument

_set: {
  field-name-1 : value,
  field-name-2 : value,
  ..
}

_inc argument

_inc: {
  field-name-1 : int-value,
  field-name-2 : int-value,
  ..
}

_append argument

_append: {
  field-name-1 : $json-variable-1,
  field-name-2 : $json-variable-1,
  ..
}

E.g.

{
  "json-variable-1": "value",
  "json-variable-2": "value"
}

_prepend argument

_prepend: {
  field-name-1 : $json-variable-1,
  field-name-2 : $json-variable-1,
  ..
}

E.g.

{
  "json-variable-1": "value",
  "json-variable-2": "value"
}

_delete_key argument

_delete_key: {
  field-name-1 : "key",
  field-name-2 : "key",
  ..
}

_delete_elem argument

_delete_elem: {
  field-name-1 : int-index,
  field-name-2 : int-index,
  ..
}

_delete_at_path argument

_delete_at_path: {
  field-name-1 : ["path-array"],
  field-name-2 : ["path-array"],
  ..
}