<!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 a result set listing the columns and associated metadata for a table</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-column-privileges.html">db2_column_privileges</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-commit.html">db2_commit</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.db2-columns" class="refentry">
<div class="refnamediv">
<h1 class="refname">db2_columns</h1>
<p class="verinfo">(PECL ibm_db2 >= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_columns</span> — <span class="dc-title">
Returns a result set listing the columns and associated metadata for a table
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.db2-columns-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>db2_columns</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">$qualifier</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$schema</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$table-name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$column-name</code></span>
]]]] )</div>
<p class="para rdfs-comment">
Returns a result set listing the columns and associated metadata for a
table.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.db2-columns-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">
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">qualifier</code></em></span>
<dd>
<p class="para">
A qualifier for DB2 databases running on OS/390 or z/OS servers. For
other databases, pass <strong><code>NULL</code></strong> or an empty string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">schema</code></em></span>
<dd>
<p class="para">
The schema which contains the tables. To match all schemas, pass
<em>'%'</em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">table-name</code></em></span>
<dd>
<p class="para">
The name of the table or view. To match all tables in the database,
pass <strong><code>NULL</code></strong> or an empty string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">column-name</code></em></span>
<dd>
<p class="para">
The name of the column. To match all columns in the table, pass <strong><code>NULL</code></strong>
or an empty string.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.db2-columns-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a statement resource with a result set containing rows describing
the columns matching the specified parameters. The rows are composed of
the following columns:
<table class="doctable informaltable">
<thead>
<tr>
<th>Column name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>TABLE_CAT</td>
<td>Name of the catalog. The value is NULL if this table does not
have catalogs.</td>
</tr>
<tr>
<td>TABLE_SCHEM</td>
<td>Name of the schema.</td>
</tr>
<tr>
<td>TABLE_NAME</td>
<td>Name of the table or view.</td>
</tr>
<tr>
<td>COLUMN_NAME</td>
<td>Name of the column.</td>
</tr>
<tr>
<td>DATA_TYPE</td>
<td>The SQL data type for the column represented as an integer value.</td>
</tr>
<tr>
<td>TYPE_NAME</td>
<td>A string representing the data type for the column.</td>
</tr>
<tr>
<td>COLUMN_SIZE</td>
<td>An integer value representing the size of the column.</td>
</tr>
<tr>
<td>BUFFER_LENGTH</td>
<td>
Maximum number of bytes necessary to store data from this column.
</td>
</tr>
<tr>
<td>DECIMAL_DIGITS</td>
<td>
The scale of the column, or <strong><code>NULL</code></strong> where scale is not applicable.
</td>
</tr>
<tr>
<td>NUM_PREC_RADIX</td>
<td>
An integer value of either <em>10</em> (representing
an exact numeric data type), <em>2</em> (representing an
approximate numeric data type), or <strong><code>NULL</code></strong> (representing a data type for
which radix is not applicable).
</td>
</tr>
<tr>
<td>NULLABLE</td>
<td>An integer value representing whether the column is nullable or
not.</td>
</tr>
<tr>
<td>REMARKS</td>
<td>Description of the column.</td>
</tr>
<tr>
<td>COLUMN_DEF</td>
<td>Default value for the column.</td>
</tr>
<tr>
<td>SQL_DATA_TYPE</td>
<td>An integer value representing the size of the column.</td>
</tr>
<tr>
<td>SQL_DATETIME_SUB</td>
<td>
Returns an integer value representing a datetime subtype code,
or <strong><code>NULL</code></strong> for SQL data types to which this does not apply.
</td>
</tr>
<tr>
<td>CHAR_OCTET_LENGTH</td>
<td>
Maximum length in octets for a character data type column, which
matches COLUMN_SIZE for single-byte character set data, or <strong><code>NULL</code></strong> for
non-character data types.
</td>
</tr>
<tr>
<td>ORDINAL_POSITION</td>
<td>The 1-indexed position of the column in the table.</td>
</tr>
<tr>
<td>IS_NULLABLE</td>
<td>
A string value where 'YES' means that the column is nullable and
'NO' means that the column is not nullable.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.db2-columns-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.db2-column-privileges.html" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</span></li>
<li class="member"> <span class="function"><a href="function.db2-foreign-keys.html" class="function" rel="rdfs-seeAlso">db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</span></li>
<li class="member"> <span class="function"><a href="function.db2-primary-keys.html" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a> - Returns a result set listing primary keys for a table</span></li>
<li class="member"> <span class="function"><a href="function.db2-procedure-columns.html" class="function" rel="rdfs-seeAlso">db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</span></li>
<li class="member"> <span class="function"><a href="function.db2-procedures.html" class="function" rel="rdfs-seeAlso">db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</span></li>
<li class="member"> <span class="function"><a href="function.db2-special-columns.html" class="function" rel="rdfs-seeAlso">db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</span></li>
<li class="member"> <span class="function"><a href="function.db2-statistics.html" class="function" rel="rdfs-seeAlso">db2_statistics()</a> - Returns a result set listing the index and statistics for a table</span></li>
<li class="member"> <span class="function"><a href="function.db2-table-privileges.html" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</span></li>
<li class="member"> <span class="function"><a href="function.db2-tables.html" class="function" rel="rdfs-seeAlso">db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</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.db2-column-privileges.html">db2_column_privileges</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-commit.html">db2_commit</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
