mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix a typo and some doc indentation related to libpq pipeline functions

Browse Source 
Noticed while reviewing the area for a different patch.  This is
cosmetic, so no backpatch is done.
This commit is contained in:
Michael Paquier 2024-01-16 09:17:51 +09:00
parent 237d01139b
commit 83eb244e41
2 changed files with 19 additions and 19 deletions
doc/src/sgml
libpq.sgml
src/interfaces/libpq
fe-exec.c

36
doc/src/sgml/libpq.sgml

@ -5813,28 +5813,28 @@ int PQpipelineSync(PGconn *conn);
<varlistentry id="libpq-PQsendFlushRequest">
<term><function>PQsendFlushRequest</function><indexterm><primary>PQsendFlushRequest</primary></indexterm></term>
<listitem>
<para>
Sends a request for the server to flush its output buffer.
<listitem>
<para>
Sends a request for the server to flush its output buffer.
<synopsis>
int PQsendFlushRequest(PGconn *conn);
</synopsis>
</para>
</para>
<para>
Returns 1 for success. Returns 0 on any failure.
</para>
<para>
The server flushes its output buffer automatically as a result of
<function>PQpipelineSync</function> being called, or
on any request when not in pipeline mode; this function is useful
to cause the server to flush its output buffer in pipeline mode
without establishing a synchronization point.
Note that the request is not itself flushed to the server automatically;
use <function>PQflush</function> if necessary.
</para>
</listitem>
</varlistentry>
<para>
Returns 1 for success. Returns 0 on any failure.
</para>
<para>
The server flushes its output buffer automatically as a result of
<function>PQpipelineSync</function> being called, or
on any request when not in pipeline mode; this function is useful
to cause the server to flush its output buffer in pipeline mode
without establishing a synchronization point.
Note that the request is not itself flushed to the server automatically;
use <function>PQflush</function> if necessary.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>

2
src/interfaces/libpq/fe-exec.c

@ -3235,7 +3235,7 @@ pqPipelineProcessQueue(PGconn *conn)
* error, a PGresult with PGRES_PIPELINE_SYNC is produced.
*
* Queries can already have been sent before PQpipelineSync is called, but
* PQpipelineSync need to be called before retrieving command results.
* PQpipelineSync needs to be called before retrieving command results.
*
* The connection will remain in pipeline mode and unavailable for new
* synchronous command execution functions until all results from the pipeline