<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.pg-put-line" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_put_line</refname>

<refpurpose>NULL で終わる文字列を 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>query</parameter></methodparam>

</methodsynopsis>

<para>

<function>pg_put_line</function> は、NULL で終わる文字列を PostgreSQL

バックエンドサーバーに送信します。これは、PostgreSQL の

<literal>COPY FROM</literal> コマンドとともに使用する場合に必要となります。

</para>

<para><literal>COPY</literal> は、PostgreSQL によってサポートされている

高速なデータ読み込みインターフェイスです。データの内容はパースされず、

一度のトランザクションで実行されます。

</para>

<para>

低レベルな <function>pg_put_line</function> コマンドを用いない別の方法は、

<function>pg_copy_from</function> を使用することです。これは、はるかに

シンプルなインターフェイスです。

</para>

<note>

<para>

<function>pg_end_copy</function> を実行する際には、送信データの最後に

明示的に "\." の 2 文字を送信する必要があります。これによって、

バックエンドに対してデータ送信の終了を通知します。

</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>query</parameter></term>

<listitem>

<para>

PostgreSQL バックエンドに直接送信されるテキストデータ。

最後に <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">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pg_end_copy</function></member>

</simplelist>

</para>

</refsect1>

</refentry>