Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE - Mailing list pgsql-hackers

From Ryo Matsumura (Fujitsu)
Subject Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
Date
Msg-id TYRPR01MB134578C74066239A8281B9308E840A@TYRPR01MB13457.jpnprd01.prod.outlook.com
Whole thread Raw
In response to Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE  (Fujii Masao <masao.fujii@gmail.com>)
Responses Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
List pgsql-hackers
On Fri, Mar 13, 2026 at 14:38 UTC, Fujii Masao <masao.fujii@gmail.com> wrote:
>        When ANALYZE is used, this parameter defaults to TRUE and buffer usage
>        information is included. Otherwise, it defaults to FALSE.

Thanks for the comment. I hadn’t understood the implementation correctly.
It might also be worth clarifying that even when the BUFFERS(and WAL) is set to TRUE,
values are shown only when there is something to report as follows:

BUFFERS
       The number of blocks shown for an
       upper-level node includes those used by all its child nodes.  In text
-      format, only non-zero values are printed.  Buffers information is
-      automatically included when <literal>ANALYZE</literal> is used.
+      format, only non-zero values are printed.
+      When ANALYZE is used, this parameter defaults to <literal>TRUE</literal>
+      and buffer usage information is included.
+      Otherwise, it defaults to <literal>FALSE</literal>.
+      When the <literal>FORMAT</literal> is <literal>TEXT</literal>,
+      no output is produced unless there is something to report, even if it
+      is set to <literal>TRUE</literal>.

WAL
       In text format, only non-zero values are printed.
       This parameter may only be used when <literal>ANALYZE</literal> is also
       enabled.  It defaults to <literal>FALSE</literal>.
+      When the <literal>FORMAT</literal> is <literal>TEXT</literal>,
+      no output is produced unless there is something to report, even if it
+      is set to <literal>TRUE</literal>.


> Does SERIALIZE actually accept FALSE?

This was entirely my mistake. And the default value was already documented.


Best Regards
Ryo Matsumura

Attachment

pgsql-hackers by date:

Previous
From: Fujii Masao
Date:
Subject: Re: client_connection_check_interval default value
Next
From: Ashutosh Bapat
Date:
Subject: Re: Better shared data structure management and resizable shared data structures