<!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 type ID (OID) for the corresponding field number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-field-table.html">pg_field_table</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-field-type.html">pg_field_type</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-type-oid" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_field_type_oid</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">pg_field_type_oid</span> — <span class="dc-title">
Returns the type ID (OID) for the corresponding field number
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-field-type-oid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pg_field_type_oid</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>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>pg_field_type_oid()</strong></span> returns an integer containing the
OID of the base type of the given <em><code class="parameter">field_number</code></em> in the
given PostgreSQL <em><code class="parameter">result</code></em> resource.
</p>
<p class="para">
You can get more information about the field type by querying PostgreSQL's
<em>pg_type</em> system table using the OID obtained with this function.
The PostgreSQL <span class="function"><strong>format_type()</strong></span> function will convert a
type OID into an SQL standard type name.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If the field uses a PostgreSQL domain (rather than a basic type), it is
the OID of the domain's underlying type that is returned, rather than the OID
of the domain itself.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-field-type-oid-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>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-field-type-oid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The OID of the field's base type. <strong><code>FALSE</code></strong> is returned on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-field-type-oid-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2077">
<p><strong>Example #1 Getting information about fields</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: #FF8000">// Assume 'title' is a varchar type<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 title from authors where author = 'Orwell'"</span><span style="color: #007700">);<br /><br /> echo </span><span style="color: #DD0000">"Title field type OID: "</span><span style="color: #007700">, </span><span style="color: #0000BB">pg_field_type_oid</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Title field type OID: 1043
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-field-type-oid-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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>
<li class="member"> <span class="function"><a href="function.pg-field-prtlen.html" class="function" rel="rdfs-seeAlso">pg_field_prtlen()</a> - Returns the printed length</span></li>
<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>
</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-table.html">pg_field_table</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-field-type.html">pg_field_type</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>
