Add example for cursor based pagination #45
Merged
Conversation
This file contains 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
ddebrunner
reviewed
May 14, 2024
ddebrunner
reviewed
May 14, 2024
ddebrunner
reviewed
May 14, 2024
ddebrunner
reviewed
May 14, 2024
ddebrunner
approved these changes
May 18, 2024
|
|
||
| StepZen supports pagination through the standard [GraphQL Cursor Connection Specification](https://relay.dev/graphql/connections.htm). | ||
|
|
||
| This allows clients consuming a StepZen GraphQL endpoint to page through resultsmregardless of the originating backend type (e.g. GraphQL endpoint, database, REST API). |
There was a problem hiding this comment.
typo:"resultsmregardless"
|
|
||
| To retrieve the first page of a result, the operation is called with `after` omitted or set to the empty string (`""`), and `first` is set to the number of results to return in a page. | ||
|
|
||
| Subsequent pages can then be retrieved by setting `after` to the value of `endCursor` from `pageInfo` from the previous request. `first` should be set to the value used in the first request. |
There was a problem hiding this comment.
As an FYI - this is not true:
first should be set to the value used in the first request
Typically it is, but there's no requirement for that to be true.
ddebrunner
reviewed
May 18, 2024
| @@ -83,6 +83,14 @@ These are available in `/sequence`: | |||
| - `/transformsInMaterializer` shows how connecting two subgraphs can invoke transformations in between. For example, the `city` of a customer can be fed into a `weather` that takes `lat,lon` by calling some geocoding in the sequence | |||
| - `/useOfJSON` shows how, in long sequences, a new type does not have to created for every step--treat everything as JSON up to the last step, and your type system stays clean. | |||
|
|
|||
| ## @dbquery | |||
|
|
|||
| View the documentation for the [`@dbquery` custom directive](https://www.ibm.com/docs/en/api-connect/ace/saas?topic=directives-directive-dbquery) in the documentation. | |||
There was a problem hiding this comment.
Love the link to the newly generated documentation.
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.
On request by Timil, who couldn't find example source code for cursor based pagination. I noticed we do have an example in this repo under
/restbut it doesn't show how to implement for DBs. The testing turned out to be more of an integration test because of the database. I could also move this example to theexamplesrepo if you think that's a better fit.