pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Nathan Bossart <nathan@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Add note about how to use pg_overexplain.
Date: Thu, 17 Jul 2025 15:27:18 +0000
Message-ID: <E1ucQVx-006mGr-2s@gemulon.postgresql.org> (raw)

doc: Add note about how to use pg_overexplain.

This commit adds a note to the pg_overexplain page that describes
how to use it (LOAD, session_preload_libraries, or
shared_preload_libraries).  The new text is mostly lifted from the
auto_explain page.  We should probably consider centralizing this
information in the future.

While at it, add a missing "module" to the opening sentence.

Reviewed-by: "David G. Johnston" <david.g.johnston@gmail.com>
Reviewed-by: Robert Treat <rob@xzilla.net>
Reviewed-by: Dean Rasheed <dean.a.rasheed@gmail.com>
Discussion: https://postgr.es/m/aHVWKM8l8kLlZzgv%40nathan
Backpatch-through: 18

Branch
------
REL_18_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/c4b5cd095675d9a7df121429f8bcb7ddb5d6d996

Modified Files
--------------
doc/src/sgml/pgoverexplain.sgml | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)



view thread (2+ messages)

Message-ID: <E1ucQVx-006mGr-2s@gemulon.postgresql.org>
Permalink:  ../E1ucQVx-006mGr-2s@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1ucQVx-006mGr-2s@gemulon.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-committers@postgresql.org
  Cc: nathan@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Add note about how to use pg_overexplain.
  In-Reply-To: <E1ucQVx-006mGr-2s@gemulon.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