From 2e4679bcafafdf3ace60f771f730a226ee682034 Mon Sep 17 00:00:00 2001 From: Matthias van de Meent Date: Fri, 1 Mar 2024 14:23:06 +0100 Subject: [PATCH v9 2/2] Add EXPLAIN (SERIALIZE) docs --- doc/src/sgml/ref/explain.sgml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index a4b6564bdb..a1524046b9 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -41,6 +41,7 @@ EXPLAIN [ ( option [, ...] ) ] boolean ] GENERIC_PLAN [ boolean ] BUFFERS [ boolean ] + SERIALIZE [ { NONE | TEXT | BINARY } ] WAL [ boolean ] TIMING [ boolean ] SUMMARY [ boolean ] @@ -206,6 +207,34 @@ ROLLBACK; + + SERIALIZE + + + Specifies whether the query's results should be serialized as if the + data was sent to the client using textual or binary representations. + If the value value is NONE we don't process output + tuples, so data from TOASTed values is not accessed + and EXPLAIN timings may be unexpected. If the value is + TEXT or BINARY, + PostgreSQL will measure the size of the + would-be transmitted data after serializing the rows to + DataRow packets, using each column type's + output (for TEXT) or + send (for BINARY) functions for + serializing the column's values. When the TIMING + option is enabled, the output also includes how much time was spent to + serialize the data. When the MEMORY option is + enabled, the output will also show how much memory was used and + allocated during serialization. + This parameter may only be used when ANALYZE is also + enabled. The default value for this parameter is NONE, + but when SERIALIZE is provided without parameters, + TEXT is used instead. + + + + WAL -- 2.40.1