Vendure's list queries follow a set pattern which allows for pagination, filtering & sorting. This guide will demonstrate how to implement your own paginated list queries.
Let's start with defining the GraphQL schema for our query. In this example, we'll image that we have defined a custom entity to
represent a ProductReview. We want to be able to query a list of reviews in the Admin API. Here's how the schema definition
would look:
Note that we need to follow these conventions:
Node interface, i.e. it must have an id: ID! field.<EntityName>List and must implement the PaginatedList interface.<EntityName>ListOptions.Given this schema, at runtime Vendure will automatically generate the ProductReviewListOptions input type, including all the
filtering & sorting fields. This means that we don't need to define the input type ourselves.
Next, we need to define the resolver for the query.
Finally, we need to implement the findAll() method on the ProductReviewService. Here we will use the
ListQueryBuilder to build the list query. The
ListQueryBuilder will take care of
Given the above parts of the plugin, we can now query the list of reviews in the Admin API:
In the above example, we are querying the first 10 reviews, sorted by createdAt in descending order, and filtered to only
include reviews with a rating between 3 and 5.
Vendure v2.2.0 introduced the ability to construct complex nested filters on any PaginatedList query. For example, we could filter the above query to only include reviews for products with a name starting with "Smartphone":
In the example above, we are filtering for reviews of products with the word "phone" and a rating of 4 or more,
or a rating of 0. The _and and _or operators can be nested to any depth, allowing for arbitrarily complex filters.
By default, the ListQueryBuilder will only allow filtering by properties which are defined on the entity itself.
So in the case of the ProductReview, we can filter by rating and text etc., but not by product.name.
However, it is possible to extend your GraphQL type to allow filtering by custom properties. Let's implement filtering
but the product.name property. First, we need to manually add the productName field to
the ProductReviewFilterParameter type:
Next we need to update our ProductReviewService to be able to handle filtering on this new field using the
customPropertyMap option:
Upon restarting your server, you should now be able to filter by productName:
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team