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

From Fujii Masao
Subject Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
Date
Msg-id CAHGQGwFpmEg2WgjgLLNbDBimmZ23krS2Q4FHR=0NJU2CZxvF_Q@mail.gmail.com
Whole thread Raw
In response to [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE  ("Ryo Matsumura (Fujitsu)" <matsumura.ryo@fujitsu.com>)
Responses Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
List pgsql-hackers
On Fri, Mar 13, 2026 at 5:38 PM Ryo Matsumura (Fujitsu)
<matsumura.ryo@fujitsu.com> wrote:
>
> Hi Hackers,
>
> It looks like the EXPLAIN documentation is missing an explanation of the default values for the BUFFERS and SERIALIZE
options.
> I've attached a patch that adds this information.
> While the documentation currently notes that these options are implicitly enabled when ANALYZE is specified, the
defaultvalues of the parameters themselves do not appear to be documented. 

+1 to adding a description of the default value.


       format, only non-zero values are printed.  Buffers information is
       automatically included when <literal>ANALYZE</literal> is used.
+      It defaults to <literal>FALSE</literal>.

How about clarifying the default depending on whether ANALYZE is used?
For example:

        When ANALYZE is used, this parameter defaults to TRUE and buffer usage
        information is included. Otherwise, it defaults to FALSE.


       argument, <literal>TEXT</literal> is assumed.
+      It defaults to <literal>FALSE</literal>.

Does SERIALIZE actually accept FALSE?

Regards,

--
Fujii Masao



pgsql-hackers by date:

Previous
From: Heikki Linnakangas
Date:
Subject: Re: Rework SLRU I/O errors handle
Next
From: Nathan Bossart
Date:
Subject: Re: Speed up COPY FROM text/CSV parsing using SIMD