GraphQL: Paginate Entries field response

[ffoerster]

Hi everyone,

does anyone know, how/if i could paginate an entries field inside a graphql response?

As a simplified example:

  "data": {
    "entry": {
      "id": "d036a56d-5b1d-4135-930f-cd7ea0e17072",
      "title": "Lorem Ipsum",
      "status": "published",
      "date": "2023-01-05 00:00:00",
      "published": true,
      "related_data": [
        {
          "id": "1",
          "status": "published",
          "published": true
        },
        {
          "id": "1",
          "status": "published",
          "published": true
        },
        ......
        {
          "id": "50",
          "status": "published",
          "published": true
        },        
      ],
    }
  }
}

So, i would like to just return 10 related_data entries instead of an (possibly) ever growing amount X.

Thanks in advance!

[duncanmcclean]

What does your GraphQL query look like?

[ffoerster]

This would be an example for a query:

query InstitutionEntry($slug: String!, $id: String, $filter: JsonArgument) {
    entry(collection: "institutions", slug: $slug, id: $id, filter: $filter) {
        id
        slug
        title
        status
        date
        published
        ... on Entry_Institutions_Institution {
            id
            logo {
                id
                height
                width
                url
                path
                ratio
                folder
            }
            link
            content
            related_data {
                id
                slug
                title
                status
                published
                date
            }
            related_persons {
                id
                slug
                title
            }
        }
    }
}

I want to limit the returned data inside related_data & related_persons.

[jasonvarga]

Those nested entries fields cannot be paginated. Typically, those fields don't have enough items selected to warrant pagination.

If you really want it, you could use a custom entries fieldtype that extends the native one, and just override the toGqlType method.

    public function toGqlType()
    {
        return GraphQL::paginate(GraphQL::type('EntryInterface'));
    }

[ffoerster]

Thanks! That's a good startingpoint for me. Are there any (performance) downsides?

[jasonvarga]

I don't think so. We just made it non-paginated by default so you didn't have to do a nested data key in your query when pagination wouldn't be required most of the time.