Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up How Queries Work #24256

Merged
merged 8 commits into from
Oct 26, 2020
Merged

Clean up How Queries Work #24256

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0d5f2d8
Clean up How Queries Work
sidharthachatterjee May 20, 2020
ac72090
Update docs/docs/query-behind-the-scenes.md
meganesu Oct 23, 2020
5970bae
Update docs/docs/query-behind-the-scenes.md
meganesu Oct 23, 2020
eccbf70
Update docs/docs/query-behind-the-scenes.md
meganesu Oct 23, 2020
f192329
Update docs/docs/query-behind-the-scenes.md
meganesu Oct 23, 2020
1c9d142
Update docs/docs/query-behind-the-scenes.md
meganesu Oct 23, 2020
2e8a014
Merge branch 'master' into docs/query-behind-the-scenes
meganesu Oct 23, 2020
7eefa57
fix: remove trailing whitespace
meganesu Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/docs/query-behind-the-scenes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
title: How Queries Work
---

As part of Gatsby's data layer, GraphQL queries can be specified as tagged graphql expressions at the bottom of your component source file (e.g. [query for Gatsby frontpage](https://github.com/gatsbyjs/gatsby/blob/master/www/src/pages/index.js#L142)), StaticQueries within your components (e.g. [showcase site details](https://github.com/gatsbyjs/gatsby/blob/master/www/src/components/showcase-details.js#L96)), or fragments created by plugins (e.g. [gatsby-source-contentful](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-contentful/src/fragments.js)).
In Gatsby, GraphQL queries are specified as tagged `graphql` expressions. These can be exported in your page source files, used in the `StaticQuery` component or used in the `useStaticQuery` hook in your React code. Plugins can also define fragments for use in queries.
meganesu marked this conversation as resolved.
Show resolved Hide resolved

Note that this process only applies to queries that are specified directly in components or templates. It doesn't apply to queries involved in the creation of dynamic pages through your site's `gatsby-node.js` file (e.g. on [Gatsby's website](https://github.com/gatsbyjs/gatsby/blob/master/www/src/utils/node/docs.js#L42)).
Note that the process outlined in this section only applies to queries that are specified in components or templates. It does _not_ apply to queries specificed in a `gatsby-node.js` file which are typically used for the creation of dynamic pages.
meganesu marked this conversation as resolved.
Show resolved Hide resolved
meganesu marked this conversation as resolved.
Show resolved Hide resolved

Almost all logic to do with queries is in [src/query](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby/src/query). There are two steps involved in a Query's life time. The first is extracting it, and the second is running it. These are separated into two bootstrap phases.
Most code to do with queries is in [src/query](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby/src/query) directory in the Gatsby monorepo.
meganesu marked this conversation as resolved.
Show resolved Hide resolved

There are two steps involved in the lifetime of a GraphQL query in Gatsby. The first is extracting and validating it, and the second is running it.

1. [Query Extraction](/docs/query-extraction/)
2. [Query Execution](/docs/query-execution/)