docs: cursor-based pagination guide #4391
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | ||
|
|
||
| When a GraphQL API returns a list of data, pagination helps avoid | ||
| fetching too must data at once. Cursor-based pagination fetches items |
There was a problem hiding this comment.
Suggested change
| fetching too must data at once. Cursor-based pagination fetches items | |
| fetching too much data at once. Cursor-based pagination fetches items |
|
|
||
| GraphQL.js doesn't include cursor pagination out of the box, but you can implement | ||
| it using custom types and resolvers. This guide shows how to build a paginated field | ||
| using the connection pattern popularized by Relay. By the end of this guide, you will |
| name: 'PageInfo', | ||
| fields: { | ||
| hasNextPage: { type: new GraphQLNonNull(GraphQLBoolean) }, | ||
| endCursor: { type: GraphQLString }, |
There was a problem hiding this comment.
We are missing startCursor and hasPreviousPage which are mandatory in Relay, no?
| 4. Build the `edges` and `pageInfo` objects. | ||
|
|
||
| The exact logic will vary depending on how your data is stored. The following example uses an | ||
| in-memory list of users. The same logic applies to database queries with indexed data. |
There was a problem hiding this comment.
Should we add a more real life scenario i.e. how to do this in sql.
- requesting first or after + 1
- deriving pageInfo
- translating cursor/... to offset
I guess it could be a lot of code for docs here but might be a useful recipe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a guide on cursor-based pagination