public inbox for [email protected]
help / color / mirror / Atom feedFrom: Fujii Masao <[email protected]>
To: Matsumura, Ryo/松村 量 <[email protected]>
Cc: PostgreSQL-development <[email protected]>
Subject: Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
Date: Wed, 18 Mar 2026 00:34:26 +0900
Message-ID: <CAHGQGwFW984Jsx52tNgOn7tpa7OEkqoA90O2HdzOMs7mBEmGUQ@mail.gmail.com> (raw)
In-Reply-To: <TYRPR01MB134577510E2A2EB3947E821BEE841A@TYRPR01MB13457.jpnprd01.prod.outlook.com>
References: <TYRPR01MB13457D31085CB5B246DBBA1AFE845A@TYRPR01MB13457.jpnprd01.prod.outlook.com>
<CAHGQGwFpmEg2WgjgLLNbDBimmZ23krS2Q4FHR=0NJU2CZxvF_Q@mail.gmail.com>
<TYRPR01MB134578C74066239A8281B9308E840A@TYRPR01MB13457.jpnprd01.prod.outlook.com>
<CAHGQGwHEHX8n_SPK2fy8FdVtEJsAtQBZypsBiucPcAAaNYqEog@mail.gmail.com>
<TYRPR01MB134577510E2A2EB3947E821BEE841A@TYRPR01MB13457.jpnprd01.prod.outlook.com>
On Tue, Mar 17, 2026 at 7:26 PM Matsumura, Ryo/松村 量
<[email protected]> wrote:
>
> On Mon, Mar 16, 2026 at 10:30:00 +0000, Fujii Masao <[email protected]> wrote:
> > Isn't the existing description "In text format, only non-zero values
> > are printed." sufficient?
>
> This description is sufficient. It was a careless mistake on my part. Sorry about that.
>
> I’ve attached a revised patch.
Thanks for updating the patch!
Since the docs already state that buffer usage is automatically included
when ANALYZE is used, the focus here seems to be clarifying the behavior
of BUFFERS without ANALYZE. From that perspective, it might be better to
explicitly describe what happens when BUFFERS is TRUE without ANALYZE.
I've updated the patch accordingly. Patch attached. Thought?
Regards,
--
Fujii Masao
Attachments:
[application/octet-stream] v4-0001-doc-Clarify-BUFFERS-behavior-without-ANALYZE-in-E.patch (1.5K, 2-v4-0001-doc-Clarify-BUFFERS-behavior-without-ANALYZE-in-E.patch)
download | inline diff:
From 77f16a7f5f6348e80411b2b7a4421b094be95434 Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Tue, 17 Mar 2026 23:17:49 +0900
Subject: [PATCH v4] doc: Clarify BUFFERS behavior without ANALYZE in EXPLAIN
This commit clarifies the documentation for the BUFFERS option of EXPLAIN
by explicitly describing its behavior when ANALYZE is not specified.
Author: Ryo Matsumura <[email protected]>
Reviewed-by: Fujii Masao <[email protected]>
Discussion: https://postgr.es/m/TYRPR01MB13457D31085CB5B246DBBA1AFE845A@TYRPR01MB13457.jpnprd01.prod.outlook.com
---
doc/src/sgml/ref/explain.sgml | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
index 7dee77fd366..5b8b521802e 100644
--- a/doc/src/sgml/ref/explain.sgml
+++ b/doc/src/sgml/ref/explain.sgml
@@ -202,7 +202,10 @@ ROLLBACK;
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.
+ included by default when <literal>ANALYZE</literal> is used but
+ otherwise is not included by default. When this parameter is
+ <literal>TRUE</literal> without <literal>ANALYZE</literal>,
+ only buffer usage during the query planning phase is reported.
</para>
</listitem>
</varlistentry>
--
2.51.2
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], [email protected]
Subject: Re: [PATCH] Docs: clarify default values of EXPLAIN BUFFERS and SERIALIZE
In-Reply-To: <CAHGQGwFW984Jsx52tNgOn7tpa7OEkqoA90O2HdzOMs7mBEmGUQ@mail.gmail.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