<?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>

Envía una string al servidor 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> envía una string (terminada

por &null;) al servidor PostgreSQL. Esto es necesario en conjunción con

un comando <literal>COPY FROM</literal> de PostgreSQL.

</para>

<para><literal>COPY</literal> es una carga muy rápida de datos

soportada por PostgreSQL. Los datos se pasan sin ser analizados y

en una simple transacción.

</para>

<para>

Una alternativa en lugar de usar el comando bruto

<function>pg_put_line</function> es usar

<function>pg_copy_from</function>. Es una interfaz mucho más simple.

</para>

<note>

<para>

Tenga en cuenta que la aplicación debe agregar explícitamente los dos caracteres

"\." al final de la string para indicar al servidor que ha terminado

de enviar datos, antes de llamar a <function>pg_end_copy</function>.

</para>

</note>

<warning>

<para>

El uso de <function>pg_put_line</function> hace que fallen la mayoría de los

objetos de gran tamaño, incluyendo <function>pg_lo_read</function>

y <function>pg_lo_tell</function>. Puede usar

<function>pg_copy_from</function> y <function>pg_copy_to</function> en su lugar.

</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>

Una línea de texto para enviar directamente al servidor PostgreSQL. Un

carácter de finalización &null; se agrega automáticamente.

</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>Ejemplo con <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>