odbc-columns.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.odbc-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_columns</refname>
  <refpurpose>指定したテーブルにあるカラム名のリストを取得する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>odbc_columns</methodname>
   <methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>table</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   指定したテーブルにあるカラム名のリストを取得します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>odbc</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>catalog</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.catalog;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.schema;
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem>
      <para>
       テーブル名。
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column</parameter></term>
     <listitem>
      <para>
       カラム名。
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   ODBC 結果 ID を返します。&return.falseforfailure;。
  </para>
  <para>
   結果セットは以下のカラムを有しています。
   <itemizedlist>
    <listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
    <listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
    <listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
    <listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
    <listitem><simpara><literal>NUM_PREC_RADIX</literal></simpara></listitem>
    <listitem><simpara><literal>NULLABLE</literal></simpara></listitem>
    <listitem><simpara><literal>REMARKS</literal></simpara></listitem>
    <listitem><simpara><literal>COLUMN_DEF</literal></simpara></listitem>
    <listitem><simpara><literal>SQL_DATA_TYPE</literal></simpara></listitem>
    <listitem><simpara><literal>SQL_DATETIME_SUB</literal></simpara></listitem>
    <listitem><simpara><literal>CHAR_OCTET_LENGTH</literal></simpara></listitem>
    <listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
    <listitem><simpara><literal>IS_NULLABLE</literal></simpara></listitem>
   </itemizedlist>
   &odbc.result.driver-specific;
  </para>
  <simpara>
   結果セットは <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
   <literal>TABLE_NAME</literal>, <literal>ORDINAL_POSITION</literal> でソートされます。
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>schema</parameter>, <parameter>table</parameter>,
       <parameter>column</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="odbc-columns.example.basic">
   <title>テーブルのカラム一覧を表示する</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$columns = odbc_columns($conn, 'TutorialDB', 'dbo', 'test', '%');
while (($row = odbc_fetch_array($columns))) {
    print_r($row);
    break; // further rows omitted for brevity
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => TEST
    [COLUMN_NAME] => id
    [DATA_TYPE] => 4
    [TYPE_NAME] => int
    [COLUMN_SIZE] => 10
    [BUFFER_LENGTH] => 4
    [DECIMAL_DIGITS] => 0
    [NUM_PREC_RADIX] => 10
    [NULLABLE] => 0
    [REMARKS] =>
    [COLUMN_DEF] =>
    [SQL_DATA_TYPE] => 4
    [SQL_DATETIME_SUB] =>
    [CHAR_OCTET_LENGTH] =>
    [ORDINAL_POSITION] => 1
    [IS_NULLABLE] => NO
)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>odbc_columnprivileges</function></member>
    <member><function>odbc_procedurecolumns</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
-->