Skip to content

Commit

Permalink
update grafast plan diagram doc to include grafast.explain option
Browse files Browse the repository at this point in the history
  • Loading branch information
jcgsville committed Jan 6, 2025
1 parent 00d79e6 commit efc6e95
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions grafast/website/grafast/plan-diagrams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -254,5 +254,18 @@ or you can render it directly from the JSON response. You can convert the plan
JSON into mermaid format via the `planToMermaid` function so you can load them
into the [mermaid live editor][].

Use the `grafast.explain` option in your preset to expose plans from your
server:

```ts title="graphile.config.mjs"
export default {
grafast: {
explain: ["plan"],
// Setting explain: true will expose all explain types
// explain: true,
}
}
```

[ruru]: /ruru
[mermaid live editor]: https://mermaid-js.github.io/mermaid-live-editor/edit

0 comments on commit efc6e95

Please sign in to comment.