Get instant support on our discord server
Update mutation¶
Table of contents
Auto-generated update mutation schema¶
For example, the auto-generated schema for the update mutation field for a table article looks like this:
update_article (
_inc: article_inc_input
_set: article_set_input
where: article_bool_exp!
): article_mutation_response
# response of any mutation on the table "article"
type article_mutation_response {
# number of affected rows by the mutation
affected_rows: Int!
#data of the affected rows by the mutation
returning: [article!]!
}
As you can see from the schema:
- The
whereargument is compulsory to filter rows to be updated. See Filter queries for filtering options. Objects can be updated based on filters on their own fields or those in their nested objects. The{}expression can be used to update all rows. - You can return the number of affected rows and the affected objects (with nested objects) in the response.
See the update mutation API reference for the full specifications.
Note
- At least any one of
_set,_incoperators or the jsonb operators_append,_prepend,_delete_key,_delete_elem,_delete_at_pathis required. - If a table is not in the
publicPostgres schema, the update mutation field will be of the formatupdate_<schema_name>_<table_name>.
Update based on an object’s fields¶
Example: Update the title, content and rating of the article with a given id:
mutation update_article {
update_article(
where: {id: {_eq: 3}},
_set: {
title: "lorem ipsum",
content: "dolor sit amet",
rating: 2
}
) {
affected_rows
returning {
id
title
content
rating
}
}
}
Using variables:
mutation update_article($id: Int, $changes: article_set_input) {
update_article(
where: {id: {_eq: $id}},
_set: $changes
) {
affected_rows
returning {
id
title
content
rating
}
}
}
with variables:
{
"id": 3,
"changes": {
"title": "lorem ipsum",
"content": "dolor sit amet",
"rating": 2
}
}
OR
mutation update_article($id: Int, $title: String, $content: String, $rating: Int) {
update_article(
where: {id: {_eq: $id}},
_set: {
title: $title,
content: $content,
rating: $rating
}
) {
affected_rows
returning {
id
title
content
rating
}
}
}
with variables:
{
"id": 3,
"title": "lorem ipsum",
"content": "dolor sit amet",
"rating": 2
}
Update based on a nested object’s fields¶
Example: Reset the rating of all articles authored by “Sidney”:
mutation update_ratings {
update_article(
where: {author: {name: {_eq: "Sidney"}}},
_set: {rating: null}
) {
affected_rows
}
}
Update all objects¶
You can update all objects in a table using the {} expression as the where argument. {} basically
evaluates to true for all objects.
Example: Reset rating of all articles:
mutation reset_rating {
update_article (
where: {}
_set: { rating: null }
) {
affected_rows
}
}
Increment int columns¶
You can increment an int column with a given value using the _inc operator.
Example: Increment the likes of an article by 2:
mutation update_likes {
update_article(
where: {id: {_eq: 1}},
_inc: {likes: 2} # initial value: 1
) {
affected_rows
returning {
id
likes
}
}
}
Update jsonb columns¶
The currently available jsonb operators are:
| Operator | Postgres equivalent | Function |
|---|---|---|
_append |
|| |
append json value to a jsonb column |
_prepend |
|| |
prepend json value to a jsonb column |
_delete_key |
- |
delete top-level key from jsonb column |
_delete_elem |
- |
delete array element from jsonb column |
_delete_at_path |
#- |
delete element at a path from jsonb column |
Note
You can learn more about Postgres jsonb operators here.
Examples
Append a json to a jsonb column¶
You can append any jsonb column with another json value by using the _append operator.
Since the input is a json value, it should be provided through a variable.
Example: Append the json {"key1": "value1"} to the jsonb column extra_info of the article table:
mutation update_extra_info($value: jsonb) {
update_article(
where: {id: {_eq: 1}},
_append: {extra_info: $value} # initial value: {"key": "value"}
) {
affected_rows
returning {
id
extra_info
}
}
}
with variables:
{
"value": { "key1": "value1" }
}
Prepend a json to a jsonb column¶
You can prepend any jsonb column with another json value by using the _prepend operator.
Since the input is a json value, it should be provided through a variable.
Example: Prepend the json {"key0": "value0"} to the jsonb column extra_info of the article table:
mutation update_extra_info($value: jsonb) {
update_article(
where: {id: {_eq: 1}},
_prepend: {extra_info: $value} # initial value "{"key": "value", "key1": "value1"}"
) {
affected_rows
returning {
id
extra_info
}
}
}
with variables:
{
"value": { "key0": "value0" }
}
Delete a top-level key from a jsonb column¶
You can delete a top-level key of a jsonb column by using the _delete_key operator.
The input value should be a String.
Example: Delete the key key in the jsonb column extra_info of the article table:
mutation update_extra_info {
update_article(
where: {id: {_eq: 1}},
_delete_key: {extra_info: "key"} # initial value "{"key0": "value0, "key": "value", "key1": "value1"}"
) {
affected_rows
returning {
id
extra_info
}
}
}
Delete an element from a jsonb column storing a json array¶
If a jsonb column is storing a json array, you can delete an element from the array using the _delete_elem
operator.
The input value should be an Int.
Example: Delete the element at position 2 in the array value of the jsonb column extra_info
of the article table:
mutation update_extra_info {
update_article(
where: {id: {_eq: 1}},
_delete_elem: {extra_info: 2} # initial value "["a", "b", "c"]"
) {
affected_rows
returning {
id
extra_info
}
}
}
Delete an element at a specific path in a jsonb column¶
You can delete a field or element of a jsonb column at a specified path by using the _delete_at_path operator.
The input value should be a String Array.
Example: Delete element at json path name.last in the jsonb column extra_info of the author table:
mutation update_extra_info {
update_author(
where: {id: {_eq: 1}},
_delete_at_path: {extra_info: ["name", "first"]} # initial value "{"name": {"first": "first_name", "last": "last_name"}}"
) {
affected_rows
returning {
id
extra_info
}
}
}
Replace all nested array objects of an object¶
In order to replace all existing nested array objects of an object, currently it’s required to use two mutations: one to delete all the existing objects and one to add a list of new nested objects.
Example: Replace all articles of an author with a new list:
mutation updateAuthorArticles($author_id: Int!) {
delete_articles(
where: {author_id: {_eq: $author_id}}
) {
affected_rows
}
insert_articles(
objects: [
{
author_id: $author_id,
title: "title",
content: "some content"
},
{
author_id: $author_id,
title: "another title",
content: "some other content"
}
]
) {
affected_rows
}
}
with variables:
{
"author_id": 21
}
