public inbox for [email protected]  

help / color / mirror / Atom feed

From: Ryo Matsumura (Fujitsu) <[email protected]>
To: PostgreSQL-development <[email protected]>
Subject: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
Date: Fri, 13 Mar 2026 08:38:35 +0000
Message-ID: <TYRPR01MB13457D31085CB5B246DBBA1AFE845A@TYRPR01MB13457.jpnprd01.prod.outlook.com> (raw)

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.

Best Regards
Ryo Matsumura


Attachments:

  [application/octet-stream] v1-0001-Docs-clarify-default-values-in-EXPLAIN-documentat.patch (1.2K, 3-v1-0001-Docs-clarify-default-values-in-EXPLAIN-documentat.patch)
  download | inline diff:
From 8f98d5cb1c195b3ff3fced763a547486c4b73cb0 Mon Sep 17 00:00:00 2001
From: Ryo Matsumura <[email protected]>
Date: Fri, 13 Mar 2026 10:59:25 +0900
Subject: [PATCH v1] Docs: clarify default values in EXPLAIN documentation.

---
 doc/src/sgml/ref/explain.sgml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
index 7dee77fd366..0073a68b6e6 100644
--- a/doc/src/sgml/ref/explain.sgml
+++ b/doc/src/sgml/ref/explain.sgml
@@ -203,6 +203,7 @@ ROLLBACK;
       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.
+      It defaults to <literal>FALSE</literal>.
      </para>
     </listitem>
    </varlistentry>
@@ -231,6 +232,7 @@ ROLLBACK;
       Serialization may only be enabled when <literal>ANALYZE</literal> is
       also enabled.  If <literal>SERIALIZE</literal> is written without an
       argument, <literal>TEXT</literal> is assumed.
+      It defaults to <literal>FALSE</literal>.
      </para>
     </listitem>
    </varlistentry>
-- 
2.47.3

view thread (8+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
  In-Reply-To: <TYRPR01MB13457D31085CB5B246DBBA1AFE845A@TYRPR01MB13457.jpnprd01.prod.outlook.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox