Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit f8a5e57

Browse files
committed
Docs: explain contrib/pg_stat_statements' handling of GC failure.
Failure to perform garbage collection now has a user-visible effect, so explain that and explain that reducing pgss_max is the way to prevent it. Per gripe from Andrew Dunstan.
1 parent 9e36c91 commit f8a5e57

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

doc/src/sgml/pgstatstatements.sgml

+16-2
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@
270270
</para>
271271

272272
<para>
273-
Consumers of <literal>pg_stat_statements</> may wish to use
273+
Consumers of <structname>pg_stat_statements</> may wish to use
274274
<structfield>queryid</> (perhaps in combination with
275275
<structfield>dbid</> and <structfield>userid</>) as a more stable
276276
and reliable identifier for each entry than its query text.
@@ -280,7 +280,7 @@
280280
post-parse-analysis tree, its value is a function of, among other
281281
things, the internal object identifiers appearing in this representation.
282282
This has some counterintuitive implications. For example,
283-
<literal>pg_stat_statements</> will consider two apparently-identical
283+
<filename>pg_stat_statements</> will consider two apparently-identical
284284
queries to be distinct, if they reference a table that was dropped
285285
and recreated between the executions of the two queries.
286286
The hashing process is also sensitive to differences in
@@ -300,6 +300,20 @@
300300
not be a useful identifier for accumulating costs across a set of logical
301301
replicas. If in doubt, direct testing is recommended.
302302
</para>
303+
304+
<para>
305+
The representative query texts are kept in an external disk file, and do
306+
not consume shared memory. Therefore, even very lengthy query texts can
307+
be stored successfully. However, if many long query texts are
308+
accumulated, the external file might grow unmanageably large. As a
309+
recovery method if that happens, <filename>pg_stat_statements</> may
310+
choose to discard the query texts, whereupon all existing entries in
311+
the <structname>pg_stat_statements</> view will show
312+
null <structfield>query</> fields, though the statistics associated with
313+
each <structfield>queryid</> are preserved. If this happens, consider
314+
reducing <varname>pg_stat_statements.max</varname> to prevent
315+
recurrences.
316+
</para>
303317
</sect2>
304318

305319
<sect2>

0 commit comments

Comments
 (0)