Node Model
Gatsby exposes its internal data store and query capabilities to GraphQL field resolvers on context.nodeModel.
Example Usage
Methods
Get all nodes in the store, or all nodes of a specified type (optionally with limit/skip). Returns slice of result as iterable and total count of nodes.
You can directly return its entries result in your resolver.
Parameters
argsqueryObjectQuery arguments (e.g.
limitandskip)typestring | GraphQLOutputTypeType
pageDependenciesObjectOptional page dependency information.
pathstringThe path of the page that depends on the retrieved nodes’ data
connectionTypestringMark this dependency as a connection
Return value
Promise<Object>
Object containing { entries: GatsbyIterable, totalCount: () => Promise<number> }
Example
// Get all nodes of a type
const { entries, totalCount } = await findAll({ type: `MyType` })
// Get all nodes of a type while filtering and sorting
const { entries, totalCount } = await findAll({
type: `MyType`,
query: {
sort: { date: `desc` },
filter: { published: { eq: false } },
},
})
// The `entries` return value is a `GatsbyIterable` (check its TypeScript definition for more details) and allows you to execute array like methods like filter, map, slice, forEach. Calling these methods is more performant than first turning the iterable into an array and then calling the array methods.
const { entries, totalCount } = await findAll({ type: `MyType` })
const count = await totalCount()
const filteredEntries = entries.filter(entry => entry.published)
// However, if a method is not available on the `GatsbyIterable` you can turn it into an array first.
const filteredEntries = entries.filter(entry => entry.published)
return Array.from(posts).lengthGet one node in the store. Only returns the first result. When possible, always use this method instead of fetching all nodes and then filtering them. findOne is more performant in that regard.
Parameters
argsqueryObjectQuery arguments (e.g.
filter). Doesn’t supportsort,limit,skip.typestring | GraphQLOutputTypeType
pageDependenciesObjectOptional page dependency information.
pathstringThe path of the page that depends on the retrieved nodes’ data
connectionTypestringMark this dependency as a connection
Return value
Promise<Node>
Example
// Get one node of type `MyType` by its title
const node = await findOne({
type: `MyType`,
query: { filter: { title: { eq: `My Title` } } },
})Finds top most ancestor of node that contains passed Object or Array
Parameters
objObject | ArrayObject/Array belonging to Node object or Node object
predicatenodePredicateOptional callback to check if ancestor meets defined conditions
Return value
Node
Top most ancestor if predicate is not specified or first node that meet predicate conditions if predicate is specified
Utility to get a field value from a node, even when that value needs to be materialized first (e.g. nested field that was connected via @link directive)
Parameters
nodeNodefieldPathstring
Return value
any
Example
// Example: Via schema customization the author ID is linked to the Author type
const blogPostNode = {
author: 'author-id-1',
// Rest of node fields...
}
getFieldValue(blogPostNode, 'author.name')Get a node from the store by ID and optional type.
Parameters
argsObjectidstringID of the requested node
typestring | GraphQLOutputTypeOptional type of the node
pageDependenciesObjectOptional page dependency information.
pathstringThe path of the page that depends on the retrieved nodes’ data
connectionTypestringMark this dependency as a connection
Return value
Node | null
Example
// Using only the id
getNodeById({ id: `123` })
// Using id and type
getNodeById({ id: `123`, type: `MyType` })
// Providing page dependencies
getNodeById({ id: `123` }, { path: `/` })Get nodes from the store by IDs and optional type.
Parameters
argsObjectidsstring[]IDs of the requested nodes
typestring | GraphQLOutputTypeOptional type of the nodes
pageDependenciesObjectOptional page dependency information.
pathstringThe path of the page that depends on the retrieved nodes’ data
connectionTypestringMark this dependency as a connection
Return value
Node[]
Example
// Using only the id
getNodesByIds({ ids: [`123`, `456`] })
// Using id and type
getNodesByIds({ ids: [`123`, `456`], type: `MyType` })
// Providing page dependencies
getNodesByIds({ ids: [`123`, `456`] }, { path: `/` })Replace the cache either with the value passed on (mainly for tests) or an empty new Map.
Parameters
mapundefined | null | FiltersCacheThis cache caches a set of buckets (Sets) of Nodes based on filter and tracks this for each set of types which are actually queried. If the filter targets
iddirectly, only one Node is cached instead of a Set of Nodes. If null, don’t create or use a cache.
Adds link between inline objects/arrays contained in Node object and that Node object.
Parameters
nodeNodeRoot Node
Given a result, that’s either a single node or an array of them, track them using pageDependencies. Defaults to tracking according to current resolver path. Returns the result back.
Parameters
resultNode | Node[]pageDependenciesObjectOptional page dependency information.
pathstringThe path of the page that depends on the retrieved nodes’ data
connectionTypestringMark this dependency as a connection