pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: PG Doc comments form <noreply@postgresql.org>
To: pgsql-docs@lists.postgresql.org
Cc: bastienpenava@gmail.com
Subject: Explain Format output specification
Date: Wed, 20 Mar 2024 15:01:45 +0000
Message-ID: <171094690582.7104.14299836970673332180@wrigleys.postgresql.org> (raw)

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/sql-explain.html
Description:

Hello
Regarding the Explain command's documentation:
https://www.postgresql.org/docs/current/sql-explain.html

For non-text format options (JSON, YAML, XML) there is no mention of the
expected output.
How stable are the fields inside these ? Does the name of some field liable
to change from version to version ?
Could it be possible to have at least a high level specifications of some of
the fields ?

I have a script I'm relying on that takes the JSON output of Explain with
Verbose set to true.
It then find the "Output" fields deeply (in each Plans recursively),
use "Relation Name", "Alias" and "Schema" to get the full name of the
columns and collects them all.
How susceptible is this to break in the future ?

Thanks in advance


Message-ID: <171094690582.7104.14299836970673332180@wrigleys.postgresql.org>
Permalink:  ../171094690582.7104.14299836970673332180@wrigleys.postgresql.org/
Also on:    postgresql.org/message-id/171094690582.7104.14299836970673332180@wrigleys.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: noreply@postgresql.org, pgsql-docs@lists.postgresql.org, bastienpenava@gmail.com
  Subject: Re: Explain Format output specification
  In-Reply-To: <171094690582.7104.14299836970673332180@wrigleys.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox