Graphql queries: Difference between revisions
From wikinotes
Line 38: | Line 38: | ||
= With Params = | = With Params = | ||
<blockquote> | <blockquote> | ||
Other times, you may need to use parameters in your query. | Other times, you may need to use parameters in your query.<br> | ||
The value passed to each parameter is provided in a JSON object. | |||
<syntaxhighlight lang="python"> | <syntaxhighlight lang="python"> | ||
# https://tracking-system/projects/1/graphql | # https://tracking-system/projects/1/graphql | ||
Line 49: | Line 50: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="javascript"> | ||
// json object of params | |||
{"name": "clean bathroom"} | {"name": "clean bathroom"} | ||
</syntaxhighlight> | </syntaxhighlight> |
Revision as of 01:18, 3 September 2021
Basics
Graphql objects are arranged in a DAG.
Top-level nodes can be queried directly,
other objects are accessed through fields on top-level items, optionally passing through an arbitrary number of child node-fields.# select id/name fields on Project { Project { # <-- a top-level node id # <-- fields on that node name } }
Without Params
Some fields may be implied by the REST API path, so no params are required.
This URL probably refers to project 1.# https://tracking-system/projects/1/graphql { name createdAt }
With Params
Other times, you may need to use parameters in your query.
The value passed to each parameter is provided in a JSON object.# https://tracking-system/projects/1/graphql { tasks($name: String){ status createdAt } }// json object of params {"name": "clean bathroom"}
Fragments
Fragments are a named group of fields to select on a specific object-type.
Fragments let you:
- Select type-specific fields in heterogenous collections
- Concisely describe a group of fields, DRY out queries
- Concisely describe Recursive/Nested nodes
TODO:
Example schema
named fragments
{ children { ...nodeFields children { ...nodeFields { children { ...nodeFields } } } } } fragment nodeFields on Node { id text colour background-colour }inline fragments
{ rentalInventory { vehicles { wheels # select on both Car and Motorcycle passengers ... on Car { # select on Car items only numSeatbelts numAirbags } ... on Motorcycle { # select on Motorcycle items only numSaddleBags } } } }