<!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>Returns the name or oid of the tables field</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-field-size.html">pg_field_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-field-type-oid.html">pg_field_type_oid</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-field-table" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_field_table</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">pg_field_table</span> — <span class="dc-title">Returns the name or oid of the tables field</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-field-table-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>pg_field_table</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$field_number</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$oid_only</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>pg_field_table()</strong></span> returns the name of the table that field
belongs to, or the table's oid if <em><code class="parameter">oid_only</code></em> is <strong><code>TRUE</code></strong>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-field-table-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para">
PostgreSQL query result resource, returned by <span class="function"><a href="function.pg-query.html" class="function">pg_query()</a></span>,
<span class="function"><a href="function.pg-query-params.html" class="function">pg_query_params()</a></span> or <span class="function"><a href="function.pg-execute.html" class="function">pg_execute()</a></span>
(among others).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">field_number</code></em></span>
<dd>
<p class="para">
Field number, starting from 0.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">oid_only</code></em></span>
<dd>
<p class="para">
By default the tables name that field belongs to is returned but
if <em><code class="parameter">oid_only</code></em> is set to <strong><code>TRUE</code></strong>, then the
oid will instead be returned.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-field-table-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success either the fields table name or oid. Or, <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-field-table-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2076">
<p><strong>Example #1 Getting table information about a field</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=publisher"</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Could not connect"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT bar FROM foo"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">pg_field_table</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">pg_field_table</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT version()"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">pg_field_table</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
foo
14379580
bool(false)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.pg-field-table-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Returning the oid is much faster than returning the table name because
fetching the table name requires a query to the database system table.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-field-table-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-field-name.html" class="function" rel="rdfs-seeAlso">pg_field_name()</a> - Returns the name of a field</span></li>
<li class="member"> <span class="function"><a href="function.pg-field-type.html" class="function" rel="rdfs-seeAlso">pg_field_type()</a> - Returns the type name for the corresponding field number</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-field-size.html">pg_field_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-field-type-oid.html">pg_field_type_oid</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>
