diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 3edbd65e46c..cedccc14129 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -3729,6 +3729,12 @@ testdb=> <userinput>\setenv LESS -imx4F</userinput> </para> <para> + When pipeline mode is active, a dedicated prompt variable is available + to report the pipeline status. + See <xref linkend="app-psql-prompting-p-uc"/> for more details + </para> + + <para> Example: <programlisting> \startpipeline @@ -4502,6 +4508,39 @@ bar </listitem> </varlistentry> + <varlistentry id="app-psql-variables-pipeline-command-count"> + <term><varname>PIPELINE_COMMAND_COUNT</varname></term> + <listitem> + <para> + The number of commands generated by <literal>\bind</literal>, + <literal>\bind_named</literal>, <literal>\close</literal> or + <literal>\parse</literal> queued in an ongoing pipeline. + </para> + </listitem> + </varlistentry> + + <varlistentry id="app-psql-variables-pipeline-result-count"> + <term><varname>PIPELINE_RESULT_COUNT</varname></term> + <listitem> + <para> + The number of commands of an ongoing pipeline that were followed + by either a <command>\flushrequest</command> or a + <command>\syncpipeline</command>, forcing the server to send the + results. These results can be retrieved with + <command>\getresults</command>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="app-psql-variables-pipeline-sync-count"> + <term><varname>PIPELINE_SYNC_COUNT</varname></term> + <listitem> + <para> + The number of sync messages queued in an ongoing pipeline. + </para> + </listitem> + </varlistentry> + <varlistentry id="app-psql-variables-port"> <term><varname>PORT</varname></term> <listitem> @@ -4901,6 +4940,17 @@ testdb=> <userinput>INSERT INTO my_table VALUES (:'content');</userinput> </listitem> </varlistentry> + <varlistentry id="app-psql-prompting-p-uc"> + <term><literal>%P</literal></term> + <listitem> + <para> + Pipeline status: <literal>off</literal> when not in a pipeline, + <literal>on</literal> when in an ongoing pipeline or + <literal>abort</literal> when in an aborted pipeline. + </para> + </listitem> + </varlistentry> + <varlistentry id="app-psql-prompting-r"> <term><literal>%R</literal></term> <listitem> |