|
3 | 3 | # postgraphile-plugin-connection-filter |
4 | 4 | This plugin adds a `filter` argument for advanced filtering of list types. |
5 | 5 |
|
6 | | -> **Warning:** Use of this plugin (particularly with the default options) may make it **astoundingly trivial** for a malicious actor (or a well-intentioned application that generates complex GraphQL queries) to overwhelm your database with expensive queries. See the Performance and Security section for details. |
7 | | -
|
8 | | -## Compatibility |
9 | | - |
10 | | -| PostGraphile version | Plugin version | |
11 | | -| --- | --- | |
12 | | -| 4.0.0-beta.0 - 4.0.0-beta.7 | 1.0.0-beta.0 - 1.0.0-beta.6 | |
13 | | -| 4.0.0-beta.8 - 4.0.0-rc.3 | 1.0.0-beta.7 - 1.0.0-beta.14 | |
14 | | -| 4.0.0-rc.4 or later | 1.0.0-beta.15 or later | |
15 | | - |
16 | | -## Breaking Changes |
17 | | - |
18 | | -#### beta.15 |
19 | | - |
20 | | -The v1.0.0-beta.15 release of this plugin relies on the `pgOmit` function introduced in PostGraphile v4.0.0-rc.2 and the `inet` type support introduced in PostGraphile v4.0.0-rc.4. As a result, the PostGraphile peer dependency was bumped to v4.0.0-rc.4 or later. |
21 | | - |
22 | | -#### beta.9 |
23 | | - |
24 | | -The deprecated `is` and `null` operators were removed. Use the `isNull` operator instead. |
25 | | - |
26 | | -#### beta.7 |
27 | | - |
28 | | -The v1.0.0-beta.7 release of this plugin uses the pluggable inflector and [smart comments](https://www.graphile.org/postgraphile/smart-comments/) functionality introduced in PostGraphile v4.0.0-beta.8. As a result, the PostGraphile peer dependency was bumped to v4.0.0-beta.8 or later. |
29 | | - |
30 | | -#### beta.4 |
31 | | - |
32 | | -The `contains` string comparison operator was renamed to `includes` to make room for JSONB operators `contains` and `containedBy`. To maintain the old names, you can specify the following in `graphileBuildOptions`: |
33 | | - |
34 | | -```js |
35 | | -connectionFilterOperatorNames: { |
36 | | - includes: "contains", |
37 | | - includesInsensitive: "containsInsensitive", |
38 | | - notIncludes: "notContains", |
39 | | - notIncludesInsensitive: "notContainsInsensitive", |
40 | | - contains: "jsonbContains", |
41 | | - containedBy: "jsonbContainedBy" |
42 | | -} |
43 | | -``` |
| 6 | +> **Warning:** Use of this plugin (particularly with the default options) may make it **astoundingly trivial** for a malicious actor (or a well-intentioned application that generates complex GraphQL queries) to overwhelm your database with expensive queries. See the Performance and Security section below for details. |
44 | 7 |
|
45 | 8 | ## Performance and Security |
46 | 9 |
|
|
0 commit comments