Skip to content

Commit d56ed97

Browse files
authored
Don't recommend ignoreIndexes: false
1 parent 9649f33 commit d56ed97

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

src/pages/postgraphile/usage-library.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -242,19 +242,13 @@ We recommend you install the `@graphile-contrib/pg-simplify-inflector` plugin.
242242

243243
#### For Development
244244

245-
**NOTE**: if something you're expecting to see doesn't appear, try removing
246-
`ignoreRBAC: false` and/or `ignoreIndexes: false`, this should give you a hint
247-
as to what you need to fix in your database (you should only expose fields
248-
through GraphQL that are inexpensive for users to use).
249-
250245
```js
251246
const postgraphileOptions = {
252247
subscriptions: true,
253248
watchPg: true,
254249
dynamicJson: true,
255250
setofFunctionsContainNulls: false,
256251
ignoreRBAC: false,
257-
ignoreIndexes: false,
258252
showErrorStack: "json",
259253
extendedErrors: ["hint", "detail", "errcode"],
260254
appendPlugins: [require("@graphile-contrib/pg-simplify-inflector")],
@@ -282,7 +276,6 @@ const postgraphileOptions = {
282276
dynamicJson: true,
283277
setofFunctionsContainNulls: false,
284278
ignoreRBAC: false,
285-
ignoreIndexes: false,
286279
extendedErrors: ["errcode"],
287280
appendPlugins: [require("@graphile-contrib/pg-simplify-inflector")],
288281
graphiql: false,
@@ -365,11 +358,10 @@ which are optional. The below options are valid for
365358
user in connection string and any role they can become); set this option
366359
true to skip these checks and create GraphQL fields and types for
367360
everything. The default is `true`, in v5 the default will change to `false`.
368-
- `ignoreIndexes`: Set false (recommended) to exclude filters, orderBy, and
361+
- `ignoreIndexes`: Set false to exclude filters, orderBy, and
369362
relations that would be expensive to access due to missing indexes. Changing
370-
this from true to false is a breaking change, but false to true is not, so
371-
we recommend you start with it set to `false`. The default is `true`, in v5
372-
the default may change to `false`.
363+
this from true to false is a breaking change, but false to true is not. The
364+
default is `true`.
373365
- `includeExtensionResources`: By default, tables and functions that come from
374366
extensions are excluded from the generated GraphQL schema as general
375367
applications don't need them to be exposed to the end user. You can use this

0 commit comments

Comments
 (0)