Data API Reference: select

Syntax

Key Required Schema Description
table true TableName Name of the table
columns true SelectColumn array Return these columns of the selected rows
where false BoolExp Select rows where this condition holds true
order_by false OrderByExp Define the ordering of the returned rows
limit false Integer Limit the result to these number of rows
offset false Integer The offset from which the rows have to be returned

Note

limit and offset only make sense when used with order_by. Otherwise, the result may differ every time the query is run

SelectColumn

ObjRelationship

Key Required Schema Description
name true RelationshipName Name of the relationship
columns true SelectColumn array Return these columns of the relationship

ArrRelationship

Key Required Schema Description
name true RelationshipName Name of the relationship
columns true SelectColumn array Return these columns of the relationship
where false BoolExp Select objects of the relationship where this condition holds true
order_by false OrderByExp Define the ordering of the returned objects
limit false Integer Limit the returned objects to this number
offset false Integer The offset from which the objects have to be returned

OrderByExp

OrderByItem

"+/-" ++ PGColumn

or

{
    "column" : PGColumn,
    "order"  : "asc" | "desc",
    "nulls"  : "first" | "last"
}

Response

An array of Object <Object>. The structure of each object is defined by the columns of the query.
« previous | next »
Want to contribute or report missing content? Check out the github repo for docs.
Powered by Sphinx. Copyright © 2019 Hasura.