archived-doc-ru/reference/pgsql/functions/pg-put-line.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-put-line" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_put_line</refname>
  <refpurpose>Передаёт на PostgreSQL сервер строку с завершающим нулём</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pg_put_line</methodname>
   <methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_put_line</function> передаёт на PostgreSQL сервер
   строку с завершающим нулём. Завершение строки значением NULL
   необходимо при её объединении с командой PostgreSQL
   <literal>COPY FROM</literal>.
  </para>
  <para>
   <literal>COPY</literal> является высокоскоростным интерфейсом
   передачи данных, поддерживаемым PostgreSQL. Данные передаются
   одной транзакцией и не разбираются парсером.
  </para>
  <para>
   В качестве альтернативы можно использовать функцию
   <function>pg_copy_from</function>. Она значительно
   проще в использовании.
  </para>
  <note>
   <para>
    Перед запуском функции <function>pg_end_copy</function>
    приложение должно сообщить о серверу о завершении передачи
    данных, добавив в конец последней строки символы "\.".
   </para>
  </note>
  <warning>
   <para>
    Использование <function>pg_put_line</function> может привести к
    отказу операций с большими объектами, включающих функции
    <function>pg_lo_read</function> и <function>pg_lo_tell</function>.
    Для этих целей используйте функции <function>pg_copy_from</function>
    и <function>pg_copy_to</function>.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-unspecified-default;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Текстовая строка для прямой пересылки на сервер. Завершающий
       <literal>NULL</literal> добавляется автоматически.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>pg_put_line</function></title>
    <programlisting role="php">
<![CDATA[
<?php
  $conn = pg_pconnect("dbname=foo");
  pg_query($conn, "create table bar (a int4, b char(16), d float8)");
  pg_query($conn, "copy bar from stdin");
  pg_put_line($conn, "3\thello world\t4.5\n");
  pg_put_line($conn, "4\tgoodbye world\t7.11\n");
  pg_put_line($conn, "\\.\n");
  pg_end_copy($conn);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_end_copy</function></member>
   </simplelist>
  </para>
 </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
-->