mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
b98266d37e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260053 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.8 KiB
XML
130 lines
3.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<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 role="description">
|
|
&reftitle.description;
|
|
<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.
|
|
</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>schema</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The owner.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>table_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The table name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>column_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The column name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
The <parameter>schema</parameter>, <parameter>table_name</parameter>, and
|
|
<parameter>column_name</parameter> accept search patterns ('%' to match
|
|
zero or more characters and '_' to match a single character).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an ODBC result identifier 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>
|
|
<para>
|
|
The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and
|
|
TABLE_NAME.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>odbc_columnprivileges</function> to retrieve associated
|
|
privileges</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:"../../../../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
|
|
-->
|