doc: Add note about how to use pg_overexplain.
authorNathan Bossart <nathan@postgresql.org>
Thu, 17 Jul 2025 15:25:59 +0000 (10:25 -0500)
committerNathan Bossart <nathan@postgresql.org>
Thu, 17 Jul 2025 15:25:59 +0000 (10:25 -0500)
commit26cc96d4521acb598ddcd886bd64653452c7e887
treef98d41f741e4a72d02a771cbdf85770af21b5ce2
parentafa5c365ec5ad978878e5d26c536d8f865abf1ae
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: http://postgr.es/m/aHVWKM8l8kLlZzgv%40nathan
Backpatch-through: 18
doc/src/sgml/pgoverexplain.sgml