ash_graphql/documentation/topics/relay.md
Riccardo Binetti 365b3aedc6
feat: Relay refetching support (#106)
* feat: add support for relay global IDs

* improvement: use the GraphQL type when projecting fields

This allows picking also up fields coming from fragments in queries returning an
interface

* feat: add relay node query

Allow retrieving a resource implementing the Node interface given its Relay
global id.
2024-01-24 14:59:12 -05:00

717 B

Relay

Enabling relay for a resource sets it up to follow the relay specification.

The two changes that are made currently are:

  • the type for the resource will implement the Node interface
  • pagination over that resource will behave as a Connection.

Using with Absinthe.Relay

Use the following option when calling use AshGraphql

use AshGraphql, define_relay_types?: false

Relay Global IDs

Use the following option to generate Relay Global IDs (see here).

use AshGraphql, relay_ids?: true

This allows refetching a node using the node query and passing its global ID.