graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2025-02-21 14:02:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated Relay Pagination example (markdown)

Denys Vitali 2020-08-28 12:07:54 +02:00
parent 6eeafa9cd0
commit 28ab85d0eb
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Relay-Pagination-example.md

@ -4,7 +4,7 @@ For this example, we're going to assume a basic understanding of what `startCurs
In a nutshell, `pagination` is implemented via graphene relay's `Connection` and `ConnectionField` pairing. With these in place, you'll see `pageInfo` available within your queries. It looks something like this: In a nutshell, `pagination` is implemented via graphene relay's `Connection` and `ConnectionField` pairing. With these in place, you'll see `pageInfo` available within your queries. It looks something like this:
``` ```json
"pageInfo": { "pageInfo": {
"startCursor": "YXJyYXljb25uZWN0aW9uOjQx", "startCursor": "YXJyYXljb25uZWN0aW9uOjQx",
"endCursor": "YXJyYXljb25uZWN0aW9uOjQz", "endCursor": "YXJyYXljb25uZWN0aW9uOjQz",
@ -14,7 +14,7 @@ In a nutshell, `pagination` is implemented via graphene relay's `Connection` and
``` ```
In addition to a `cursor` element within `edges` that will show you the cursor id for each element, like so: In addition to a `cursor` element within `edges` that will show you the cursor id for each element, like so:
``` ```graphql
edges { edges {
cursor cursor
node { node {
@ -25,7 +25,7 @@ In addition to a `cursor` element within `edges` that will show you the cursor i
The basic implementation below provides the elements for cursor-based pagination that you'll need to do your thing in your code. Hope this helps. The basic implementation below provides the elements for cursor-based pagination that you'll need to do your thing in your code. Hope this helps.
``` ```python
from graphene import Connection, ConnectionField, Node, Int from graphene import Connection, ConnectionField, Node, Int
from graphene_django import DjangoObjectType from graphene_django import DjangoObjectType
from <wherever your models exist> import Place from <wherever your models exist> import Place
@ -52,7 +52,7 @@ class Query(object):
return Place.objects.all() return Place.objects.all()
``` ```
The following query, (the pageInfo element is included for illustration, but isn't necessary for the query to resolve): The following query, (the pageInfo element is included for illustration, but isn't necessary for the query to resolve):
``` ```graphql
{ {
places(first: 3, after: "YXJyYXljb25uZWN0aW9uOjQx") { places(first: 3, after: "YXJyYXljb25uZWN0aW9uOjQx") {
pageInfo { pageInfo {
@ -73,7 +73,7 @@ The following query, (the pageInfo element is included for illustration, but isn
``` ```
Gives us: Gives us:
``` ```json
{ {
"data": { "data": {
"places": { "places": {