PHP 8.4: pgsql: Add pg_set_chunked_rows_size, PGSQL_TUPLES_CHUNK

php/doc-en@3c6c95f

Author: mumumu

reference/pgsql/functions/pg-set-chunked-rows-size.xml

@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 3c6c95fcfd7d9eaa603df40327693ea8dff89d53 Maintainer: mumumu Status: ready -->
+<refentry xml:id="function.pg-set-chunked-rows-size" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>pg_set_chunked_rows_size</refname>
+  <refpurpose>チャンクモードで取得するクエリ結果の行数を設定する</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>
+   チャンクモードで取得するクエリ結果を設定します。
+   後に返されるクエリ結果は、最大<parameter>size</parameter>
+   行が含まれる複数のチャンクに分割されます。
+   この関数は、<function>pg_get_result</function>
+   を使って結果を取得する前にコールしなければいけません。
+   この関数は、libpq のバージョンが 17 以降の場合に利用可能です。
+  </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>
+       チャンクごとに取得する行数
+      </simpara>
+     </listitem>
+    </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   &return.success;
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   <parameter>size</parameter> が <literal>1</literal> より小さい場合、
+   <classname>ValueError</classname> がスローされます。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><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));
+
+// 結果を取得した以降に呼び出しても無意味
+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
+-->