add pagination guide

[aryaniyaps]

This PR adds a guide on how to implement pagination in GraphQL

Description

This PR adds a guide on how to implement pagination in GraphQL. It discusses about the common ways we would do pagination (whether GraphQL is involved or not), like cursor-based or offset-based pagination before implementing the same in GraphQL.

• added general pagination guide
• added offset pagination implementation
• added cursor pagination implementation
• merged relay connection docs by @Ambro17

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Documentation

Issues Fixed or Closed by This PR

• Add pagination support #175
• Create guides on how to implement common features #764
• Documentation meta issue #328
• Roadmap for v1 #268

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[codecov]

Codecov Report

Merging #1345 (9e87914) into main (7321a43) will increase coverage by 1.31%.
The diff coverage is 100.00%.

❗ Current head 9e87914 differs from pull request most recent head 80f648c. Consider uploading reports for the commit 80f648c to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1345      +/-   ##
==========================================
+ Coverage   96.75%   98.07%   +1.31%     
==========================================
  Files         181      107      -74     
  Lines        7432     3842    -3590     
  Branches     1343      562     -781     
==========================================
- Hits         7191     3768    -3423     
+ Misses        144       41     -103     
+ Partials       97       33      -64     

[BryceBeagle]

I think this looks go to me, other than the request change for strings 👍
Assuming that's changed, I'll let @patrick91 give the final sign off

[aryaniyaps]

I have hopefully responded to/ changed things as requested by code reviews. So, I assume the only other thing to do here is to make a final review/ merge, or suggest changes. pinging @patrick91 to do the same!

[fescobar]

Is there any problem with this PR being merged?

[github-actions]

Hi 👋 You can find a preview of the docs here:

https://strawberry.rocks/docs/pr/1345/types/resolvers
https://strawberry.rocks/docs/pr/1345/guides/pagination
https://strawberry.rocks/docs/pr/1345/integrations/django
https://strawberry.rocks/docs/pr/1345/guides/pagination/connections
https://strawberry.rocks/docs/pr/1345/guides/pagination/cursor-based
https://strawberry.rocks/docs/pr/1345/guides/pagination/offset-based
https://strawberry.rocks/docs/pr/1345/guides/pagination/overview
https://strawberry.rocks/docs/pr/1345/README

[patrick91]

@aryaniyaps apologies for letting this PR get so old! I'll review it today 😊

[patrick91]

This is awesome! Sorry again for letting it sit for so long!

[soraia653]

Hello everyone, I tried to implement the cursor pagination, but it's not working.

[patrick91]

Hello everyone, I tried to implement the cursor pagination, but it's not working.

can you post an issue with what you've tried and what error you get?

[soraia653]

@patrick91
If you just directly copy + paste the code for the Cursor Pagination it results in several errors. I tried fixing a few, for example:

• filtered_data = map(lambda user: user.id > user_id, user_data) -> 'id' is not an attribute, so I replaced with user['id'].

• Also, since we are using map I get the error that a map function is not subscriptable.

• UserType is not defined.

• id field not defined in User class.

This is just some of the errors I found, please do let me know if I'm missing any information on how to properly apply the cursors. It's my first time using Strawberry and I'm loving it 🍓