Data API Reference: delete

Syntax

Key Required Schema Description
table true TableName Name of the table
where true BoolExp Count only the rows where this expression holds true
returning false PGColumn array Return these columns of the deleted rows

Response

Key Always present Schema Description
affected_rows true Integer The number of rows which are affected by the query
returning false Object array An array of objects, one per affected row, containing the columns specified in the returning field

Description

delete deletes rows that satisfy the "where" condition from the specified table.

The optional "returning" key causes delete to return value(s) based on each row actually deleted. However, you cannot request relationships in returning.

You must have delete permission on the table. You must also have select permission on all the columns used in "where" and "returning".

On successful completion, an delete operation returns the number of rows deleted. If the delete operation contains "returning", the result will include a key "returning" whose value will be similar to that of a select operation with the columns in the returning list, over the row(s) deleted by the operation.

Example

Delete all articles with rating less than 1

curl "$HASURADB_URL/v1/query"
  -X POST
  -H "Authorization: auth_code"
  -H "Content-Type: application/json"
  -d '{  "type" : "delete",
         "args" : {
            "table"     : "article",
            "where"     : { "rating" : { "$lt" : 1 } },
            "returning" : ["id"]
         }
      }'

The response looks like:

{
    "affected_rows" : 2,
    "returning" : [
        { "id" : 21 },
        { "id" : 9 }
    ]
}
« previous | next »
Want to contribute or report missing content? Check out the github repo for docs.
Powered by Sphinx. Copyright © 2019 Hasura.