Skip to content

pdo_pgsql: document ATTR_PREFETCH lazy fetch, fix copyFromArray sig #5629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philip merged 3 commits into from
Jun 22, 2026
+37 −3
Merged

pdo_pgsql: document ATTR_PREFETCH lazy fetch, fix copyFromArray sig #5629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
008071a
pdo_pgsql: document ATTR_PREFETCH lazy fetch, fix copyFromArray signa…
philip Jun 21, 2026
0a957a7
Apply suggestion from @lacatoire
philip Jun 22, 2026
6ae42ac
pdo_pgsql: fix ATTR_PREFETCH link and copyFromArray rows whitespace
philip Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions reference/pdo/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,13 @@
setting of the prefetch size. A larger prefetch size results in
increased performance at the cost of higher memory usage.
</simpara>
<simpara>
The PDO_PGSQL driver instead treats this attribute as a toggle: as of
PHP 8.5.0, a value of <literal>0</literal> enables lazy (single-row)
fetching; see the
<link linkend="pdo-pgsql.constants.attr-prefetch">PDO_PGSQL driver docs</link>
for details.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pdo.constants.attr-timeout">
Expand Down
26 changes: 26 additions & 0 deletions reference/pdo_pgsql/pdo-pgsql.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,32 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pdo-pgsql.constants.attr-prefetch">
<term><constant>PDO::ATTR_PREFETCH</constant></term>
<listitem>
<simpara>
As of PHP 8.5.0, setting this attribute to <literal>0</literal> enables
lazy (single-row) fetching: rows are retrieved from the server one at a
time as they are fetched, instead of buffering the whole result set in
memory before the first <methodname>PDOStatement::fetch</methodname>
call. This reduces memory usage for large result sets. Any other value
keeps the default buffered behavior.
</simpara>
<simpara>
It can be set per connection with
<methodname>PDO::setAttribute</methodname>, or per statement via
the <methodname>PDO::prepare</methodname> or
<methodname>PDO::query</methodname> driver options.
</simpara>
<caution>
<simpara>
In lazy mode, a connection can have only one active statement at a
time. Running another statement silently discards any unread rows of
the previous one; no error is raised.
</simpara>
</caution>
</listitem>
</varlistentry>
<varlistentry xml:id="pdo-pgsql.constants.transaction-idle">
<term><constant>Pdo\Pgsql::TRANSACTION_IDLE</constant></term>
<listitem>
Expand Down
7 changes: 4 additions & 3 deletions reference/pdo_pgsql/pdo/pgsql/copyfromarray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type>bool</type><methodname>Pdo\Pgsql::copyFromArray</methodname>
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
<methodparam><type>array</type><parameter>rows</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>Traversable</type></type><parameter>rows</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
Expand All @@ -37,8 +37,9 @@
<term><parameter>rows</parameter></term>
<listitem>
<simpara>
An indexed <type>array</type> of <type>string</type>s with fields
separated by <parameter>separator</parameter>.
An indexed <type>array</type> (or <type>Traversable</type>) of
<type>string</type>s with fields separated by
<parameter>separator</parameter>.
</simpara>
</listitem>
</varlistentry>
Expand Down