enhancement: add filtering, sorting, and pagination to GraphQL queries #763
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
ra0x3
added
documentation
deekerno
changed the title
ra0x3
force-pushed
the
feature/the-graphql-update
branch
2 times, most recently
from
d0c8176
to
1d43beb
Compare
0xmovses
previously approved these changes
Apr 21, 2023
Add filtering functionality to GraphQL API; add E2E tests
…ueries (#755) * Add comments; rename to clearer variables * Add sorting and offset-based pagination
* Add PageInfo object to queries with a limit * Adjust tests * Change API response to snake_case
* Add docs for GraphQL filtering and pagination * Move QueryResponse to models module * Address rvmelkonian feedback * Address ra0x3 feedback
deekerno
force-pushed
the
feature/the-graphql-update
branch
2 times, most recently
from
fada863
to
f378267
Compare
deekerno
force-pushed
the
feature/the-graphql-update
branch
from
f378267
to
1a96d25
Compare
|
@deekerno Just need to fix these conflicts, then this is good to go in. |
Closed
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.
This is deekerno speaking as ra0x3. 😉
Closes #637, #656.
Changelog
argumentsmodule for turning query arguments into the newQueryParamsstruct--
id: select a record by its ID--
and/or: combine two filters together--
not: negate the behavior of a filter--
has: select records that have non-null values for columns in list--
in: select records that have a value matching an element in set--
gt/gte/lt/lte(greater than, etc.): select records whose value satisfies the comparison condition--
between: select records whose value falls between the bounds of the comparison conditionfuel-indexer-graphqlandfuel-indexer-graphql-parserpackagesTesting Plan
I've added extensive testing (15 new tests in total) for filtering and pagination, and unit tests have been adjusted where necessary. CI should pass.
Manual Testing
Feel free to peruse changes from the documentation PR for example queries that you can use for the block explorer indexer; there are pages for filtering and pagination as well as this page that contains a fully-featured example of all of the GraphQL querying functionality being used together (nested entities, sorting, pagination, and filtering).