Walkthrough

 

Getting started

  1. We support PostgeSQL 9.6 and higher, but we welcome issue reports on earlier versions too (team@pgmustard.com)

  2. We use Google for authentication (with only very basic permissions), so you'll need a (free) Google account attached to the email you want to use 

  3. We currently need plans to be in the JSON format, and work best with the following flags set: EXPLAIN (ANALYZE, BUFFERS, VERBOSE, FORMAT JSON)

 

Authentication

Step one is to navigate to https://app.pgmustard.com/ and sign up with your Google account.

auth.png
 

What's the plan?

Once you're in, all we need from you is a query plan.

If you don’t have a plan in JSON format and just want to see what pgMustard can do, select one of the examples and then Submit.

plan.png
 

The fun bit

Once we have your plan, we'll display it back to you as a tree, a timing bar, a table, and (when we can) a representation of your query.

With the tree, we mirror the indentation of the text plans you may be used to.

The timing bar quickly shows the proportion of time each of the longest operations take.

With the table, we try to display the most relevant information for working out what the performance issues are, and what to do next.

An example tree, query, timing bar, and table in action.

An example tree, query, timing bar, and table in action.

 

Some options from here are:

  1. Click the icons for further info, tips, and blog post links

  2. Each operation node is linked to a table row (and query segment where we can), and clicking one will highlight the others

We hope to save you time and effort understanding query plans and working out what to do next.

We’re regularly releasing improvements based on the feedback we receive (https://www.pgmustard.com/changelog/) so please do get in touch. The best way is via email, we’re team@pgmustard.com

Selecting a row and clicking a tip in action.

Selecting a row and clicking a tip in action.