Add cursor pagination

[karatakis]

PR Info

• Closes Add cursor oriented pagination #19

• Closes Cursor based pagination #58

• Depends Re-export internal dependency instead of leaking it into user package #68

Adds

• Cursor based pagination

Breaking Changes

• Query returned object field 'data' was renamed to 'nodes'

[tyt2y3]

Looks cool! Just a quick question, so instead of :

film(pagination: { limit: 10, page: 0 }, orderBy: { title: ASC }) {

we can now do:

film(cursor: {limit: 5, cursor: "Int[4]:3361"}, orderBy: { title: ASC }) {

am I right?

[karatakis]

@tyt2y3 but what about page pagination ? should we drop it ?

[tyt2y3]

I imagine both cursor and pagination are optional arguments, and that they cannot be specified at the same time.

[karatakis]

@tyt2y3 I found a way to unify both APIs. But we have braking changes because instead of PaginatedResult I return Connection (async_graphql builtin type that is compatible with Relay GraphQL spec https://relay.dev/graphql/connections.htm)

[tyt2y3]

No problem for a breaking change as long as we update all examples and docs.

[karatakis]

Updated documentation also SeaQL/seaql.github.io#58

[tyt2y3]

Very cool!

[phungleson]

Hey peeps, not sure if I understand the code here correctly. I think cursor should be constructed from values of sort by columns, not from PrimaryKey like here.

For example, when you sort by name, price then cursor should be combination of value of name and value of price.

[billy1624]

Hey @phungleson, currently, in seaography, we only support cursor pagination on primary key only.

@karatakis please correct me if I'm get it wrong.