See what's launched

The next gen Gatsby is here Performance, developer velocity, and scaling to meet Enterprise needs - See what’s launched

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.

Parameters

  • args
    • query Object

      Query arguments (e.g. limit and skip)

    • type string | GraphQLOutputType

      Type

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Promise<Object>

Object containing { entries: GatsbyIterable, totalCount: () => Promise<number> }


Get one node in the store. Only returns the first result.

Parameters

  • args
    • query Object

      Query arguments (e.g. filter). Doesn’t support sort, limit, skip.

    • type string | GraphQLOutputType

      Type

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Promise<Node>

Finds top most ancestor of node that contains passed Object or Array

Parameters

  • obj Object | Array

    Object/Array belonging to Node object or Node object

  • predicate nodePredicate

    Optional 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


Get all nodes in the store, or all nodes of a specified type. Note that this adds connectionType tracking by default if type is passed.

Since version 4.0 - Use nodeModel.findAll() instead

Parameters

  • args Object
    • type string | GraphQLOutputType

      Optional type of the nodes

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Node[]

Get a node from the store by ID and optional type.

Parameters

  • args Object
    • id string

      ID of the requested node

    • type string | GraphQLOutputType

      Optional type of the node

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Node | null

Get nodes from the store by IDs and optional type.

Parameters

  • args Object
    • ids string[]

      IDs of the requested nodes

    • type string | GraphQLOutputType

      Optional type of the nodes

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Node[]

Get the names of all node types in the store.

Return value

string[]

Replace the cache either with the value passed on (mainly for tests) or an empty new Map.

Parameters

  • map undefined | null | FiltersCache

    (This cached is used in redux/nodes.js and 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 id directly, only one Node is cached instead of a Set of Nodes. If null, don’t create or use a cache.


Get nodes of a type matching the specified query.

Since version 4.0 - Use nodeModel.findAll() or nodeModel.findOne() instead

Parameters

  • args Object
    • query Object

      Query arguments (filter and sort)

    • type string | GraphQLOutputType

      Type

    • firstOnly boolean

      If true, return only first match

  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Promise<Node[]>

Adds link between inline objects/arrays contained in Node object and that Node object.

Parameters

  • node Node

    Root 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

  • result Node | Node[]
  • pageDependencies Object

    Optional page dependency information.

    • path string

      The path of the page that depends on the retrieved nodes’ data

    • connectionType string

      Mark this dependency as a connection

Return value

Node | Node[]
Edit this page on GitHub
© 2022 Gatsby, Inc.