db2-procedure-columns.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-procedure-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_procedure_columns</refname>
  <refpurpose>
   ストアドプロシージャのパラメータを含む結果セットを返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_procedure_columns</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>qualifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>procedure</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>parameter</parameter></methodparam>
  </methodsynopsis>

  <para>
   ストアドプロシージャのパラメータを含む結果セットを返します。
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
       その他のデータベースの場合には &null; あるいは空の文字列を渡します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       プロシージャを含むスキーマ。このパラメータでは、ワイルドカードとして
       <literal>_</literal> および <literal>%</literal>
       を含む検索パターンを使用可能です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>procedure</parameter></term>
     <listitem>
      <para>
       プロシージャの名前。このパラメータでは、ワイルドカードとして
       <literal>_</literal> および <literal>%</literal>
       を含む検索パターンを使用可能です。
      </para>
     </listitem>
     </varlistentry>
    <varlistentry>
     <term><parameter>parameter</parameter></term>
     <listitem>
      <para>
       パラメータの名前。このパラメータでは、ワイルドカードとして
       <literal>_</literal> および <literal>%</literal>
       を含む検索パターンを使用可能です。
       このパラメータが &null; の場合、指定したストアドプロシージャの
       すべてのパラメータが返されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定したパラメータに一致するストアドプロシージャのパラメータ情報を含む結果セットの
   ステートメントリソースを返します。
   行の内容は、以下のカラムで構成されています。
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>カラム名</entry>
       <entry>説明</entry>
      </row>
     </thead>
     <tbody>
       <row>
        <entry>PROCEDURE_CAT</entry>
        <entry>
         プロシージャを含むカタログ。テーブルがカタログを保持していない場合は &null;。
        </entry>
       </row>
       <row>
        <entry>PROCEDURE_SCHEM</entry>
        <entry>ストアドプロシージャを含むスキーマの名前。</entry>
       </row>
       <row>
        <entry>PROCEDURE_NAME</entry>
        <entry>プロシージャの名前。</entry>
       </row>
       <row>
        <entry>COLUMN_NAME</entry>
        <entry>パラメータの名前。</entry>
       </row>
       <row>
        <entry>COLUMN_TYPE</entry>
        <entry>
         <para>
          パラメータの型を表す整数値。
          <informaltable>
           <tgroup cols="2">
            <thead>
             <row>
              <entry>返される値</entry>
              <entry>パラメータの型</entry>
             </row>
            </thead>
            <tbody>
             <row>
              <entry>1 (SQL_PARAM_INPUT)</entry>
              <entry>入力 (IN) パラメータ。</entry>
             </row>
             <row>
              <entry>2 (SQL_PARAM_INPUT_OUTPUT)</entry>
              <entry>入力/出力 (INOUT) パラメータ。</entry>
             </row>
             <row>
              <entry>3 (SQL_PARAM_OUTPUT)</entry>
              <entry>出力 (OUT) パラメータ。</entry>
             </row>
            </tbody>
           </tgroup>
          </informaltable>
         </para>
        </entry>
       </row>
       <row>
        <entry>DATA_TYPE</entry>
        <entry>
         パラメータの SQL データ型を表す整数値。
        </entry>
       </row>
       <row>
        <entry>TYPE_NAME</entry>
        <entry>パラメータのデータ型を表す文字列。</entry>
       </row>
       <row>
        <entry>COLUMN_SIZE</entry>
        <entry>パラメータのサイズを表す整数値。</entry>
       </row>
       <row>
        <entry>BUFFER_LENGTH</entry>
        <entry>
         このパラメータのデータを保存するために必要な最大バイト数。
        </entry>
       </row>
       <row>
        <entry>DECIMAL_DIGITS</entry>
        <entry>
         パラメータの位取り。位取りが適用できない場合は &null;。
        </entry>
       </row>
       <row>
        <entry>NUM_PREC_RADIX</entry>
        <entry>
         <literal>10</literal> (正確な数値データ型を表す)、
         <literal>2</literal> (概数データ型を表す)、
         あるいは &null; (基数が適用できないデータ型を表す)
         のいずれか。
        </entry>
       </row>
       <row>
        <entry>NULLABLE</entry>
        <entry>パラメータが null 値をとることができるかどうかを表す整数値。</entry>
       </row>
       <row>
        <entry>REMARKS</entry>
        <entry>パラメータの説明。</entry>
       </row>
       <row>
        <entry>COLUMN_DEF</entry>
        <entry>パラメータのデフォルト値。</entry>
       </row>
       <row>
        <entry>SQL_DATA_TYPE</entry>
        <entry>パラメータのサイズを表す整数値。</entry>
       </row>
       <row>
        <entry>SQL_DATETIME_SUB</entry>
        <entry>
         datetime 型のコードを表す整数値、
         あるいはこれが適用できない SQL データ型である場合に &null;。
        </entry>
       </row>
       <row>
        <entry>CHAR_OCTET_LENGTH</entry>
        <entry>
         文字型のパラメータにおける最大のオクテット数。
         シングルバイト文字セットのデータの場合、これは COLUMN_SIZE
         に一致します。文字型でないカラムの場合は &null; となります。
        </entry>
       </row>
       <row>
        <entry>ORDINAL_POSITION</entry>
        <entry>CALL 文の中でのパラメータの位置を表す、1 から始まるインデックス。</entry>
       </row>
       <row>
        <entry>IS_NULLABLE</entry>
        <entry>
         パラメータが null 値をとることができるかどうかを表す文字列。
         'YES' の場合は null 値をとることができ、
         'NO' の場合はできません。
        </entry>
       </row>
     </tbody>
    </tgroup>
   </informaltable>

  </para>
 </refsect1>

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>db2_procedure_columns</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_column_privileges</function></member>
    <member><function>db2_columns</function></member>
    <member><function>db2_foreign_keys</function></member>
    <member><function>db2_primary_keys</function></member>
    <member><function>db2_procedures</function></member>
    <member><function>db2_special_columns</function></member>
    <member><function>db2_statistics</function></member>
    <member><function>db2_table_privileges</function></member>
    <member><function>db2_tables</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
-->