Simple object queries

Introduction

You can fetch a single node or multiple nodes of the same type using a simple object query.

Fetch list of objects

Example: Fetch a list of authors:

query {
  authors {
    id
    name
  }
}
query { authors { id name } }
{ "data": { "authors": [ { "id": 1, "name": "Justin" }, { "id": 2, "name": "Beltran" }, { "id": 3, "name": "Sidney" }, { "id": 4, "name": "Anjela" } ] } }

Fetch an object using its primary key

Example: Fetch an author using their primary key:

query {
  authors_by_pk(id: 1) {
    id
    name
  }
}
query { authors_by_pk(id: 1) { id name } }
{ "data": { "authors_by_pk": { "id": 1, "name": "Justin" } } }

Fetch value from JSON/JSONB column at particular path

Example: Fetch the city and phone number of an author from their JSONB address column:

query {
  authors_by_pk(id: 1) {
    id
    name
    address
    city: address(path: "$.city")
    phone: address(path: "$.phone_numbers.[0]")
  }
}
query { authors_by_pk(id: 1) { id name address city: address(path: "$.city") phone: address(path: "$.phone_numbers.[0]") } }
{ "data": { "authors_by_pk": { "id": 1, "name": "Justin", "address": { "city": "Bengaluru", "phone_numbers": [9090909090, 8080808080] }, "city": "Bengaluru", "phone": 9090909090 } } }

See the API reference for more details.