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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<refentry xml:id="function.odbc-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_columns</refname>
  <refpurpose>Lists the column names in specified tables</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>resource</type><methodname>odbc_columns</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>schema</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lists all columns in the requested range.  Returns an ODBC result
   identifier containing the information or &false; on failure.
  </para>
  <para>
   The result set has the following columns:
   <itemizedlist>
    <listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
    <listitem><simpara>TABLE_SCHEM</simpara></listitem>
    <listitem><simpara>TABLE_NAME</simpara></listitem>
    <listitem><simpara>COLUMN_NAME</simpara></listitem>
    <listitem><simpara>DATA_TYPE</simpara></listitem>
    <listitem><simpara>TYPE_NAME</simpara></listitem>
    <listitem><simpara>PRECISION</simpara></listitem>
    <listitem><simpara>LENGTH</simpara></listitem>
    <listitem><simpara>SCALE</simpara></listitem>
    <listitem><simpara>RADIX</simpara></listitem>
    <listitem><simpara>NULLABLE</simpara></listitem>
    <listitem><simpara>REMARKS</simpara></listitem>
   </itemizedlist>
  </para>
  <simpara>
   The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and
   TABLE_NAME.
  </simpara>
  <para>
   The <parameter>schema</parameter>,
   <parameter>table_name</parameter> and
   <parameter>column_name</parameter> arguments accept search
   patterns ('%' to match zero or more characters and '_' to match a
   single character).
  </para>
  <simpara>
   See also <function>odbc_columnprivileges</function> to retrieve
   associated privileges.
  </simpara>
 </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:"../../../../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
-->