pg-set-chunked-rows-size.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3c6c95fcfd7d9eaa603df40327693ea8dff89d53 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pg-set-chunked-rows-size" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_set_chunked_rows_size</refname>
  <refpurpose>Définit les résultats de la requête à récupérer en mode chunk</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pg_set_chunked_rows_size</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Définit les résultats de la requête à récupérer en mode chunk.
   La réquête retournée par la suite sera divisée en plusieurs morceaux,
   chacun contenant jusqu'à <parameter>size</parameter> lignes.
   Cette fonction doit être appelée avant de récupérer les résultats avec <function>pg_get_result</function>.
   Cette fonction n'est disponible que lorsque libpq est en version 17 ou supérieure.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <simpara>
       Le nombre de lignes à récupérer dans chaque morceau.
      </simpara>
     </listitem>
    </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   &return.success;
  </simpara>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Si <parameter>size</parameter> est inférieur à <literal>1</literal>,
   une <classname>ValueError</classname> sera lancée.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple de <function>pg_result_memory_size</function></title>
   <programlisting role="php">
<![CDATA[
<?php

$conn = pg_connect($conn_str);

for ($i = 0; $i < 10; $i ++) {
  pg_query($conn, "INSERT INTO users DEFAULT VALUES");
}

pg_send_query($conn, "SELECT * FROM users");
pg_set_chunked_rows_size($conn, 1);

$result = pg_get_result($conn);
var_dump(pg_num_rows($result));

:: Pas d'effet après que le résultat soit récupéré
var_dump(pg_set_chunked_rows_size($conn, 10));
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
int(1)
bool(false)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>pg_get_result</function></member>
   <member><function>pg_result_status</function></member>
  </simplelist>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->