<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Send a NULL-terminated string to PostgreSQL backend</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-prepare.html">pg_prepare</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-query-params.html">pg_query_params</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pg-put-line" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_put_line</h1>
<p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">pg_put_line</span> — <span class="dc-title">Send a NULL-terminated string to PostgreSQL backend</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-put-line-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pg_put_line</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
], <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>pg_put_line()</strong></span> sends a NULL-terminated string
to the PostgreSQL backend server. This is needed in conjunction
with PostgreSQL's <em>COPY FROM</em> command.
</p>
<p class="para"><em>COPY</em> is a high-speed data loading interface
supported by PostgreSQL. Data is passed in without being parsed,
and in a single transaction.
</p>
<p class="para">
An alternative to using raw <span class="function"><strong>pg_put_line()</strong></span> commands
is to use <span class="function"><a href="function.pg-copy-from.html" class="function">pg_copy_from()</a></span>. This is a far simpler
interface.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The application must explicitly send the two characters "\."
on the last line to indicate to the backend that it has finished
sending its data, before issuing <span class="function"><a href="function.pg-end-copy.html" class="function">pg_end_copy()</a></span>.
</p>
</p></blockquote>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
Use of the <span class="function"><strong>pg_put_line()</strong></span> causes most large object
operations, including <span class="function"><a href="function.pg-lo-read.html" class="function">pg_lo_read()</a></span> and
<span class="function"><a href="function.pg-lo-tell.html" class="function">pg_lo_tell()</a></span>, to subsequently fail. You can use
<span class="function"><a href="function.pg-copy-from.html" class="function">pg_copy_from()</a></span> and <span class="function"><a href="function.pg-copy-to.html" class="function">pg_copy_to()</a></span>
instead.
</p>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-put-line-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
PostgreSQL database connection resource. When
<em><code class="parameter">connection</code></em> is not present, the default connection
is used. The default connection is the last connection made by
<span class="function"><a href="function.pg-connect.html" class="function">pg_connect()</a></span> or <span class="function"><a href="function.pg-pconnect.html" class="function">pg_pconnect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">data</code></em></span>
<dd>
<p class="para">
A line of text to be sent directly to the PostgreSQL backend. A <em>NULL</em>
terminator is added automatically.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-put-line-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-put-line-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2108">
<p><strong>Example #1 <span class="function"><strong>pg_put_line()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php <br /> $conn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=foo"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"create table bar (a int4, b char(16), d float8)"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"copy bar from stdin"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_put_line</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"3\thello world\t4.5\n"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_put_line</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"4\tgoodbye world\t7.11\n"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_put_line</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"\\.\n"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">pg_end_copy</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-put-line-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-end-copy.html" class="function" rel="rdfs-seeAlso">pg_end_copy()</a> - Sync with PostgreSQL backend</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-prepare.html">pg_prepare</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-query-params.html">pg_query_params</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
