aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2024-01-24 16:55:19 +0900
committerMichael Paquier <michael@paquier.xyz>2024-01-24 16:55:19 +0900
commit94edfe250c6a200d2067b0debfe00b4122e9b11e (patch)
treea5b77c29dccee9b6ccc14e448f5802d8f4601d67 /doc/src
parentfaa2b953ba3be0fac9af614ac14e34cf3a0a2c46 (diff)
downloadpostgresql-94edfe250c6a200d2067b0debfe00b4122e9b11e.tar.gz
postgresql-94edfe250c6a200d2067b0debfe00b4122e9b11e.zip
pgbench: Add \syncpipeline
This change adds a new meta-command called \syncpipeline to pgbench, able to send a sync message without flushing using the new libpq function PQsendPipelineSync(). This meta-command is available within a block made of \startpipeline and \endpipeline. Author: Anthonin Bonnefoy Discussion: https://postgr.es/m/CAO6_XqpcNhW6LZHLF-2NpPzdTbyMm4-RVkr3+AP5cOKSm9hrWA@mail.gmail.com
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/pgbench.sgml12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml
index 05d3f81619f..279bb0ad7df 100644
--- a/doc/src/sgml/ref/pgbench.sgml
+++ b/doc/src/sgml/ref/pgbench.sgml
@@ -1386,13 +1386,19 @@ SELECT 4 AS four \; SELECT 5 AS five \aset
<varlistentry id="pgbench-metacommand-pipeline">
<term><literal>\startpipeline</literal></term>
+ <term><literal>\syncpipeline</literal></term>
<term><literal>\endpipeline</literal></term>
<listitem>
<para>
- These commands delimit the start and end of a pipeline of SQL
- statements. In pipeline mode, statements are sent to the server
- without waiting for the results of previous statements. See
+ This group of commands implements pipelining of SQL statements.
+ A pipeline must begin with a <command>\startpipeline</command>
+ and end with an <command>\endpipeline</command>. In between there
+ may be any number of <command>\syncpipeline</command> commands,
+ which sends a <link linkend="protocol-flow-ext-query">sync message</link>
+ without ending the ongoing pipeline and flushing the send buffer.
+ In pipeline mode, statements are sent to the server without waiting
+ for the results of previous statements. See
<xref linkend="libpq-pipeline-mode"/> for more details.
Pipeline mode requires the use of extended query protocol.
</para>