Source of: /manual/en/function.odbc-tables.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.uodbc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.odbc-tables.php',
1 => 'odbc_tables',
),
'up' =>
array (
0 => 'ref.uodbc.php',
1 => 'ODBC Functions',
),
'prev' =>
array (
0 => 'function.odbc-tableprivileges.php',
1 => 'odbc_tableprivileges',
),
'next' =>
array (
0 => 'book.pdo.php',
1 => 'PDO',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.odbc-tables" class="refentry">
<div class="refnamediv">
<h1 class="refname">odbc_tables</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">odbc_tables</span> — <span class="dc-title">Get the list of table names stored in a specific data source</span></p>
</div>
<a name="function.odbc-tables.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>odbc_tables</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection_id</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$qualifier</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$owner</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$name</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$types</tt></span>
]]]] )</div>
<p class="para rdfs-comment">
Lists all tables in the requested range.
</p>
<p class="para">
To support enumeration of qualifiers, owners, and table types,
the following special semantics for the
<i><tt class="parameter">qualifier</tt></i>
, <i><tt class="parameter">owner</tt></i>
,
<i><tt class="parameter">name</tt></i>
, and
<i><tt class="parameter">table_type</tt></i>
are available:
</p><ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
If <i><tt class="parameter">qualifier</tt></i>
is a single percent
character (%) and <i><tt class="parameter">owner</tt></i>
and
<i><tt class="parameter">name</tt></i>
are empty strings, then the result
set contains a list of valid qualifiers for the data
source. (All columns except the TABLE_QUALIFIER column contain
NULLs.)
</span>
</li>
<li class="listitem">
<span class="simpara">
If <i><tt class="parameter">owner</tt></i>
is a single percent character
(%) and <i><tt class="parameter">qualifier</tt></i>
and
<i><tt class="parameter">name</tt></i>
are empty strings, then the result
set contains a list of valid owners for the data source. (All
columns except the TABLE_OWNER column contain
NULLs.)
</span>
</li>
<li class="listitem">
<span class="simpara">
If <i><tt class="parameter">table_type</tt></i>
is a single percent
character (%) and <i><tt class="parameter">qualifier</tt></i>
,
<i><tt class="parameter">owner</tt></i>
and <i><tt class="parameter">name</tt></i>
are empty strings, then the result set contains a list of
valid table types for the data source. (All columns except the
TABLE_TYPE column contain NULLs.)
</span>
</li>
</ul><p>
</p>
</div>
<a name="function.odbc-tables.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">connection_id</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The ODBC connection identifier,
see <a href="function.odbc-connect.php" class="function">odbc_connect()</a> for details.</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">qualifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The qualifier.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">owner</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The owner. Accepts search patterns ('%' to match zero or more
characters and '_' to match a single character).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The name. Accepts search patterns ('%' to match zero or more
characters and '_' to match a single character).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">types</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If <i><tt class="parameter">table_type</tt></i>
is not an empty string, it
must contain a list of comma-separated values for the types of
interest; each value may be enclosed in single quotes (') or
unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the
data source does not support a specified table type,
<b>odbc_tables()</b> does not return any results for
that type.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.odbc-tables.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ODBC result identifier containing the information
or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
<p class="para">
The result set has the following columns:
</p><ul class="itemizedlist">
<li class="listitem"><span class="simpara">TABLE_QUALIFIER</span></li>
<li class="listitem"><span class="simpara">TABLE_OWNER</span></li>
<li class="listitem"><span class="simpara">TABLE_NAME</span></li>
<li class="listitem"><span class="simpara">TABLE_TYPE</span></li>
<li class="listitem"><span class="simpara">REMARKS</span></li>
</ul><p>
</p>
<p class="simpara">
The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER,
TABLE_OWNER and TABLE_NAME.
</p>
</div>
<a name="function.odbc-tables.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.odbc-tableprivileges.php" class="function" rel="rdfs-seeAlso">odbc_tableprivileges()</a> - Lists tables and the privileges associated with each table</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
