Skip to content

Commit e396cf1

Browse files
committed
Deploy 20220510_143050
1 parent 0e5c612 commit e396cf1

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

page-data/postgraphile/filtering/page-data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

postgraphile/filtering/index.html

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,20 @@ <h3 id="advanced-filtering"><a href="#advanced-filtering" aria-label="advanced f
7070
<a href="/postgraphile/computed-columns/">computed columns</a> or by using
7171
<a href="/postgraphile/make-extend-schema-plugin/">makeExtendSchemaPlugin</a>.</p>
7272
<p>You can also augment PostGraphile's existing connections using custom
73-
<a href="/postgraphile/extending-raw/">Graphile Engine plugins</a>, such as:</p>
73+
<a href="/postgraphile/extending-raw/">Graphile Engine plugins</a>, such as the following:</p>
7474
<h4 id="filter-plugin"><a href="#filter-plugin" aria-label="filter plugin permalink" class="anchor"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Filter Plugin</h4>
75+
<blockquote>
76+
<p>🚨<strong>BEWARE</strong>🚨: adding powerful generic filtering capabilities to your GraphQL
77+
API is strongly discouraged, not just by Benjie (the maintainer of
78+
PostGraphile) but also
79+
<a href="https://twitter.com/leeb/status/1004655619431731200">by Lee Byron</a> (one of
80+
the inventors of GraphQL) and various other experts in the GraphQL ecosystem.
81+
It is <strong>strongly advised</strong> that you add only very specific filters using one
82+
of the techniques above (and that you make their inputs as simple as possible)
83+
rather than using a generic filtering plugin like this. Not heeding this
84+
advice may lead to very significant performance issues down the line that are
85+
very hard for you to dig your way out of.</p>
86+
</blockquote>
7587
<p>A very popular plugin is Matt Bretl's connection-filter plugin, located at
7688
<a href="https://github.com/graphile-contrib/postgraphile-plugin-connection-filter">https://github.com/graphile-contrib/postgraphile-plugin-connection-filter</a>.
7789
This adds a <code class="language-text">filter</code> argument to connections that enables you to use advanced

0 commit comments

Comments
 (0)