Skip to content
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

docs: logical operators #308

Merged
merged 2 commits into from
Mar 10, 2023
Merged

docs: logical operators #308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e54a5c
docs: logical operators
saihaj Mar 9, 2023
e7a0b25
Address feedback
saihaj Mar 9, 2023
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
52 changes: 52 additions & 0 deletions website/pages/en/querying/graphql-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,58 @@ This can be useful if you are looking to fetch only entities whose child-level e
}
```

#### Logical operators

As of Graph Node [`v0.30.0`](https://github.com/graphprotocol/graph-node/releases/tag/v0.30.0) you can group multiple parameters in the same `where` argument using the `and` or the `or` operators to filter results based on more than one criteria.

##### `AND` Operator

In the following example, we are filtering for challenges with `outcome` `succeeded` and `number` greater than or equal to `100`.

```graphql
{
challenges(where: { and: [{ number_gte: 100 }, { outcome: "succeeded" }] }) {
challenger
outcome
application {
id
}
}
}
```

> **Syntactic sugar:** You can simplify the above query by removing the `and` operator by passing a sub-expression separated by commas.
>
> ```graphql
> {
> challenges(where: { number_gte: 100, outcome: "succeeded" }) {
> challenger
> outcome
> application {
> id
> }
> }
> }
> ```

##### `OR` Operator

In the following example, we are filtering for challenges with `outcome` `succeeded` or `number` greater than or equal to `100`.

```graphql
{
challenges(where: { or: [{ number_gte: 100 }, { outcome: "succeeded" }] }) {
challenger
outcome
application {
id
}
}
}
```

saihaj marked this conversation as resolved.
Show resolved Hide resolved
> **Note**: When constructing queries, it is important to consider the performance impact of using the `or` operator. While `or` can be a useful tool for broadening search results, it can also have significant costs. One of the main issues with `or` is that it can cause queries to slow down. This is because `or` requires the database to scan through multiple indexes, which can be a time-consuming process. To avoid these issues, it is recommended that developers use and operators instead of or whenever possible. This allows for more precise filtering and can lead to faster, more accurate queries.

#### All Filters

Full list of parameter suffixes:
Expand Down