Analyze

Prefix an EdgeQL query with analyze to run a performance analysis of that query.

Copy

db> 
... 
... 
... 
... 
... 
... 
... 
... 
...

analyze select Hero {
  name,
  secret_identity,
  villains: {
    name,
    nemesis: {
      name
    }
  }
};

──────────────────────────────────────── Query ────────────────────────────────────────
analyze select ➊  Hero {name, secret_identity, ➋  villains: {name, ➌  nemesis: {name}}};

──────────────────────── Coarse-grained Query Plan ────────────────────────
                  │ Time     Cost Loops Rows Width │ Relations
➊ root            │  0.0 69709.48   1.0  0.0    32 │ Hero
╰──➋ .villains    │  0.0     92.9   0.0  0.0    32 │ Villain, Hero.villains
╰──➌ .nemesis     │  0.0     8.18   0.0  0.0    32 │ Hero

In addition to using the analyze statement in the CLI or UI’s REPL, you may also run performance analysis via our CLI’s analyze command and the UI’s query builder (accessible by running edgedb ui to invoke your instance’s UI) by prepending your query with analyze. This method offers helpful visualizations to to make it easy to understand your query’s performance.

After analyzing a query, you may run the \expand command in the REPL to see more fine-grained performance metrics on the previously analyzed query.

︙

See also

CLI > edgedb analyze

Reference > EdgeQL > analyze

Analyze​

Analyze