Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update grafast plan diagram doc to include explain option #2300

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update grafast plan diagram doc to include explain option #2300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions grafast/website/grafast/plan-diagrams.mdx
View file
Open in desktop
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
Loading