Skip to content

Commit

Permalink
Update text filter API table (keystonejs#6330)
Browse files Browse the repository at this point in the history
  • Loading branch information
timleslie authored and Nikitoring committed Sep 14, 2021
1 parent 2c4299f commit 3eae878
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/pages/docs/apis/filters.mdx
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

0 comments on commit 3eae878

Please sign in to comment.