Skip to content

Document child entity filtering #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 27, 2022
Merged

Document child entity filtering #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bead5e9
Document child entity filtering
kamilkisiela Jun 29, 2022
240f6ac
Use "nested" instead of "child"
kamilkisiela Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion pages/en/querying/graphql-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,30 @@ This can be useful if you are looking to fetch only entities which have changed,
}
```

#### Example for nested entity filtering

Filtering on the basis of nested entities is possible in the fields with the `_` suffix.

This can be useful if you are looking to fetch only entities whose child-level entities meet the provided conditions.

```graphql
{
challenges(where: { application_: { id: 1 } }) {
challenger
outcome
application {
id
}
}
}
```

#### All Filters

Full list of parameter suffixes:

```
_
_not
_gt
_lt
Expand All @@ -176,7 +195,7 @@ _not_ends_with
_not_ends_with_nocase
```

> Please note that some suffixes are only supported for specific types. For example, `Boolean` only supports `_not`, `_in`, and `_not_in`.
> Please note that some suffixes are only supported for specific types. For example, `Boolean` only supports `_not`, `_in`, and `_not_in`, but `_` is available only for object and interface types.

In addition, the following global filters are available as part of `where` argument:

Expand Down