php-doc-en/reference/uodbc/functions/odbc-tables.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-tables" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_tables</refname>
  <refpurpose>Get the list of table names stored in a specific data source</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>odbc_tables</methodname>
   <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>types</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lists all tables in the requested range.
  </para>
  <para>
   To support enumeration of qualifiers, owners, and table types,
   the following special semantics for the
   <parameter>qualifier</parameter>, <parameter>owner</parameter>,
   <parameter>name</parameter>, and
   <parameter>table_type</parameter> are available:
   <itemizedlist>
    <listitem>
     <simpara>
      If <parameter>qualifier</parameter> is a single percent
      character (%) and <parameter>owner</parameter> and
      <parameter>name</parameter> 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.)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      If <parameter>owner</parameter> is a single percent character
      (%) and <parameter>qualifier</parameter> and
      <parameter>name</parameter> 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.)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      If <parameter>table_type</parameter> is a single percent
      character (%) and <parameter>qualifier</parameter>,
      <parameter>owner</parameter> and <parameter>name</parameter>
      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.)
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_id</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       The qualifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>owner</parameter></term>
     <listitem>
      <para>
       The owner. Accepts search patterns ('%' to match zero or more
       characters and '_' to match a single character).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       The name. Accepts search patterns ('%' to match zero or more
       characters and '_' to match a single character).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>types</parameter></term>
     <listitem>
      <para>
       If <parameter>table_type</parameter> 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,
       <function>odbc_tables</function> does not return any results for
       that type.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ODBC result identifier containing the information 
  &return.falseforfailure;.
  </para>
  <para>
   The result set has the following columns:
   <itemizedlist>
    <listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
    <listitem><simpara>TABLE_OWNER</simpara></listitem>
    <listitem><simpara>TABLE_NAME</simpara></listitem>
    <listitem><simpara>TABLE_TYPE</simpara></listitem>
    <listitem><simpara>REMARKS</simpara></listitem>
   </itemizedlist>
  </para>
  <simpara>
   The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER,
   TABLE_OWNER and TABLE_NAME.
  </simpara>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>odbc_tableprivileges</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->