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

Update text filter API table #6330

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Update text filter API table #6330

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 11 additions & 6 deletions docs/pages/docs/apis/filters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,21 +65,26 @@ The `json` field type does not support filters.

### text

| **Filter name** | **Type** | **Description** | **Notes** |
| --------------- | ---------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| **Filter name** | **Type** | **Description** | **Notes** |
| --------------- | ---------------------------------------- | ----------------------------------------------------- | --------- |
| `equals` | `String` | Equals |
| `lt` | `String` | Less than |
| `lte` | `String` | Less than or equal |
| `gt` | `String` | Greater than |
| `gte` | `String` | Greater than or equal |
| `contains` | `String` | Contains | Will follow the setting of the `mode` on `postgresql` and will be case insensitive but only for ASCII characters on `sqlite` |
| `startsWith` | `String` | Starts with | Will follow the setting of the `mode` on `postgresql` and will be case insensitive but only for ASCII characters on `sqlite` |
| `endsWith` | `String` | Ends with | Will follow the setting of the `mode` on `postgresql` and will be case insensitive but only for ASCII characters on `sqlite` |
| `contains` | `String` | Contains | [1] |
| `startsWith` | `String` | Starts with | [1] |
| `endsWith` | `String` | Ends with | [1] |
| `in` | `[String!]` | Is in the array |
| `notIn` | `[String!]` | Is not in the array |
| `mode` | `QueryMode` (`default` or `insensitive`) | Whether the filters should be case insensitive or not | `postgresql` only |
| `mode` | `QueryMode` (`default` or `insensitive`) | Whether the filters should be case insensitive or not | [2] |
| `not` | `NestedStringNullableFilter` | Does not match the inner filter |

#### Notes

- [1] Will follow the setting of the `mode` on `postgresql` and will be case insensitive but only for ASCII characters on `sqlite`
- [2] `postgresql` only

### timestamp

| **Filter name** | **Type** | **Description** |
Expand Down