Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitc4b5cd0

Browse files
doc: Add note about how to use pg_overexplain.
This commit adds a note to the pg_overexplain page that describeshow to use it (LOAD, session_preload_libraries, orshared_preload_libraries). The new text is mostly lifted from theauto_explain page. We should probably consider centralizing thisinformation 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%40nathanBackpatch-through: 18
1 parent02d21cf commitc4b5cd0

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

‎doc/src/sgml/pgoverexplain.sgml‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</indexterm>
99

1010
<para>
11-
The <filename>pg_overexplain</filename> extends <command>EXPLAIN</command>
11+
The <filename>pg_overexplain</filename>moduleextends <command>EXPLAIN</command>
1212
with new options that provide additional output. It is mostly intended to
1313
assist with debugging of and development of the planner, rather than for
1414
general use. Since this module displays internal details of planner data
@@ -17,6 +17,21 @@
1717
often as) those data structures change.
1818
</para>
1919

20+
<para>
21+
To use it, simply load it into the server. You can load it into an
22+
individual session:
23+
24+
<programlisting>
25+
LOAD 'pg_overexplain';
26+
</programlisting>
27+
28+
You can also preload it into some or all sessions by including
29+
<literal>pg_overexplain</literal> in
30+
<xref linkend="guc-session-preload-libraries"/> or
31+
<xref linkend="guc-shared-preload-libraries"/> in
32+
<filename>postgresql.conf</filename>.
33+
</para>
34+
2035
<sect2 id="pgoverexplain-debug">
2136
<title>EXPLAIN (DEBUG)</title>
2237

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp