Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE

From: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
To: "Ryo Matsumura (Fujitsu)" <matsumura(dot)ryo(at)fujitsu(dot)com>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
Date: 2026-03-13 14:38:57
Message-ID: CAHGQGwFpmEg2WgjgLLNbDBimmZ23krS2Q4FHR=0NJU2CZxvF_Q@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Mar 13, 2026 at 5:38 PM Ryo Matsumura (Fujitsu)
<matsumura(dot)ryo(at)fujitsu(dot)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 default values 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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2026-03-13 15:00:23 Re: Speed up COPY FROM text/CSV parsing using SIMD
Previous Message Heikki Linnakangas 2026-03-13 14:32:10 Re: Rework SLRU I/O errors handle