<!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>Escape a identifier for insertion into a text field</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-escape-bytea.html">pg_escape_bytea</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-escape-literal.html">pg_escape_literal</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-escape-identifier" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_escape_identifier</h1>
<p class="verinfo">(PHP 5 >= 5.4.4)</p><p class="refpurpose"><span class="refname">pg_escape_identifier</span> — <span class="dc-title">
Escape a identifier for insertion into a text field
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-escape-identifier-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>pg_escape_identifier</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_escape_identifier()</strong></span> escapes a identifier
(e.g. table, field names) for quering the database. It returns an
escaped identifier string for PostgreSQL
server. <span class="function"><strong>pg_escape_identifier()</strong></span> adds double
quotes before and after data. Users should not add double
quotes. Use of this function is recommended for identifier
parameters in query. For SQL literals (i.e. parameters except
bytea), <span class="function"><a href="function.pg-escape-literal.html" class="function">pg_escape_literal()</a></span>
or <span class="function"><a href="function.pg-escape-string.html" class="function">pg_escape_string()</a></span> muse be used. For bytea
type fields, <span class="function"><a href="function.pg-escape-bytea.html" class="function">pg_escape_bytea()</a></span> must be used
instead.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function has internal escape code and can also be used with
PostgreSQL 8.4 or less.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-escape-identifier-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 <span class="type"><a href="language.types.string.html" class="type string">string</a></span> containing text to be escaped.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-escape-identifier-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A <span class="type"><a href="language.types.string.html" class="type string">string</a></span> containing the escaped data.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-escape-identifier-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2060">
<p><strong>Example #1 <span class="function"><strong>pg_escape_identifier()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php <br /> </span><span style="color: #FF8000">// Connect to the database<br /> </span><span style="color: #0000BB">$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'dbname=foo'</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">// Escape the table name data<br /> </span><span style="color: #0000BB">$escaped </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_escape_identifier</span><span style="color: #007700">(</span><span style="color: #0000BB">$table_name</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">// Select rows from $table_name<br /> </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT * FROM </span><span style="color: #007700">{</span><span style="color: #0000BB">$escaped</span><span style="color: #007700">}</span><span style="color: #DD0000">;"</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-escape-identifier-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-escape-literal.html" class="function" rel="rdfs-seeAlso">pg_escape_literal()</a> - Escape a literal for insertion into a text field</span></li>
<li class="member"> <span class="function"><a href="function.pg-escape-bytea.html" class="function" rel="rdfs-seeAlso">pg_escape_bytea()</a> - Escape a string for insertion into a bytea field</span></li>
<li class="member"> <span class="function"><a href="function.pg-escape-string.html" class="function" rel="rdfs-seeAlso">pg_escape_string()</a> - Escape a string for query</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-escape-bytea.html">pg_escape_bytea</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-escape-literal.html">pg_escape_literal</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>
