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

Commit e96b697

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 ffdf2a2 commit e96b697

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

doc/src/sgml/pgstatstatements.sgml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
</para>
243243

244244
<para>
245-
Consumers of <literal>pg_stat_statements</> may wish to use
245+
Consumers of <structname>pg_stat_statements</> may wish to use
246246
<structfield>queryid</> (perhaps in combination with
247247
<structfield>dbid</> and <structfield>userid</>) as a more stable
248248
and reliable identifier for each entry than its query text.
@@ -252,7 +252,7 @@
252252
post-parse-analysis tree, its value is a function of, among other
253253
things, the internal object identifiers appearing in this representation.
254254
This has some counterintuitive implications. For example,
255-
<literal>pg_stat_statements</> will consider two apparently-identical
255+
<filename>pg_stat_statements</> will consider two apparently-identical
256256
queries to be distinct, if they reference a table that was dropped
257257
and recreated between the executions of the two queries.
258258
The hashing process is also sensitive to differences in
@@ -272,6 +272,20 @@
272272
not be a useful identifier for accumulating costs across a set of logical
273273
replicas. If in doubt, direct testing is recommended.
274274
</para>
275+
276+
<para>
277+
The representative query texts are kept in an external disk file, and do
278+
not consume shared memory. Therefore, even very lengthy query texts can
279+
be stored successfully. However, if many long query texts are
280+
accumulated, the external file might grow unmanageably large. As a
281+
recovery method if that happens, <filename>pg_stat_statements</> may
282+
choose to discard the query texts, whereupon all existing entries in
283+
the <structname>pg_stat_statements</> view will show
284+
null <structfield>query</> fields, though the statistics associated with
285+
each <structfield>queryid</> are preserved. If this happens, consider
286+
reducing <varname>pg_stat_statements.max</varname> to prevent
287+
recurrences.
288+
</para>
275289
</sect2>
276290

277291
<sect2>

0 commit comments

Comments
 (0)