<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ibm-db2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.db2-columns.php',
    1 => 'db2_columns',
    2 => 'テーブルのカラムおよび関連するメタデータを含む結果セットを返す',
  ),
  'up' => 
  array (
    0 => 'ref.ibm-db2.php',
    1 => 'IBM DB2 関数',
  ),
  'prev' => 
  array (
    0 => 'function.db2-column-privileges.php',
    1 => 'db2_column_privileges',
  ),
  'next' => 
  array (
    0 => 'function.db2-commit.php',
    1 => 'db2_commit',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ibm_db2/functions/db2-columns.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.db2-columns" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_columns</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_columns</span> &mdash; <span class="dc-title">
   テーブルのカラムおよび関連するメタデータを含む結果セットを返す
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-columns-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_columns</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$connection</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$qualifier</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$schema</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$table_name</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$column_name</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>


  <p class="simpara">
   テーブルのカラムおよび関連するメタデータを含む結果セットを返します。
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.db2-columns-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">connection</code></dt>
    <dd>
     <span class="simpara">
      IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
     </span>
    </dd>
   
   
   <dt><code class="parameter">qualifier</code></dt>
    <dd>
     <span class="simpara">
      OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
      その他のデータベースの場合には <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> あるいは空の文字列を渡します。
     </span>
    </dd>
   
   
    <dt><code class="parameter">schema</code></dt>
    <dd>
     <span class="simpara">
      テーブルを含むスキーマ。すべてのスキーマに一致させるには、
      <code class="literal">&#039;%&#039;</code> を渡します。
     </span>
    </dd>
   
   
    <dt><code class="parameter">table_name</code></dt>
    <dd>
     <span class="simpara">
      テーブルあるいはビューの名前。データベース内のすべてのテーブルに一致させるには、
      <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> あるいは空の文字列を渡します。
     </span>
    </dd>
   
   
    <dt><code class="parameter">column_name</code></dt>
    <dd>
     <span class="simpara">
      カラムの名前。テーブル内のすべてのカラムに一致させるには、
      <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> あるいは空の文字列を渡します。
     </span>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-columns-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   指定したパラメータに一致するカラムの情報を含む結果セットの
   ステートメントリソースを返します。
   行の内容は、以下のカラムで構成されています。
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>カラム名</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
       <tr>
        <td>TABLE_CAT</td>
        <td>
         カタログの名前。テーブルがカタログを保持していない場合は NULL。
        </td>
       </tr>

       <tr>
        <td>TABLE_SCHEM</td>
        <td>スキーマの名前。</td>
       </tr>

       <tr>
        <td>TABLE_NAME</td>
        <td>テーブルあるいはビューの名前。</td>
       </tr>

       <tr>
        <td>COLUMN_NAME</td>
        <td>カラムの名前。</td>
       </tr>

       <tr>
        <td>DATA_TYPE</td>
        <td>カラムの SQL データ型を整数値で表したもの。</td>
       </tr>

       <tr>
        <td>TYPE_NAME</td>
        <td>カラムのデータ型を文字列で表したもの。</td>
       </tr>

       <tr>
        <td>COLUMN_SIZE</td>
        <td>カラムのサイズを表す整数値。</td>
       </tr>

       <tr>
        <td>BUFFER_LENGTH</td>
        <td>
         このカラムのデータを保存するために必要な最大のバイト数。
        </td>
       </tr>

       <tr>
        <td>DECIMAL_DIGITS</td>
        <td>
         カラムの位取り。位取りが適用できない場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
        </td>
       </tr>

       <tr>
        <td>NUM_PREC_RADIX</td>
        <td>
         <code class="literal">10</code> (正確な数値データ型を表す)、
         <code class="literal">2</code> (概数データ型を表す)、
         あるいは <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> (基数が適用できないデータ型を表す)
         のいずれか。
        </td>
       </tr>

       <tr>
        <td>NULLABLE</td>
        <td>カラムが null 値をとることができるかどうかを表す整数値。</td>
       </tr>

       <tr>
        <td>REMARKS</td>
        <td>カラムの説明。</td>
       </tr>

       <tr>
        <td>COLUMN_DEF</td>
        <td>カラムのデフォルト値。</td>
       </tr>

       <tr>
        <td>SQL_DATA_TYPE</td>
        <td>カラムのサイズを表す整数値。</td>
       </tr>

       <tr>
        <td>SQL_DATETIME_SUB</td>
        <td>
         datetime 型のコードを表す整数値、
         あるいはこれが適用できない SQL データ型である場合に <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
        </td>
       </tr>

       <tr>
        <td>CHAR_OCTET_LENGTH</td>
        <td>
         文字型のカラムにおける最大のオクテット数。
         シングルバイト文字セットのデータの場合、これは COLUMN_SIZE
         に一致します。文字型でないカラムの場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> となります。
        </td>
       </tr>

       <tr>
        <td>ORDINAL_POSITION</td>
        <td>テーブル内でのカラムの位置を表す、1 から始まるインデックス。</td>
       </tr>

       <tr>
        <td>IS_NULLABLE</td>
        <td>
         カラムが null 値をとることができるかどうかを表す文字列。
         &#039;YES&#039; の場合は null 値をとることができ、
         &#039;NO&#039; の場合はできません。
        </td>
       </tr>

     </tbody>
    
   </table>


  </p>
 </div>


 

 <div class="refsect1 seealso" id="refsect1-function.db2-columns-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.db2-column-privileges.php" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a> - テーブルのカラムおよび関連する権限情報を含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-foreign-keys.php" class="function" rel="rdfs-seeAlso">db2_foreign_keys()</a> - テーブルの外部キーを含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-primary-keys.php" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a> - テーブルの主キーを含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-procedure-columns.php" class="function" rel="rdfs-seeAlso">db2_procedure_columns()</a> - ストアドプロシージャのパラメータを含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-procedures.php" class="function" rel="rdfs-seeAlso">db2_procedures()</a> - データベース内に登録されているストアドプロシージャの一覧を含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-special-columns.php" class="function" rel="rdfs-seeAlso">db2_special_columns()</a> - テーブルのユニーク行 ID カラムを含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-statistics.php" class="function" rel="rdfs-seeAlso">db2_statistics()</a> - インデックスの情報およびテーブルの統計情報を含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-table-privileges.php" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a> - データベース内のテーブルおよび関連する権限情報を含む結果セットを返す</span></li>
   <li><span class="function"><a href="function.db2-tables.php" class="function" rel="rdfs-seeAlso">db2_tables()</a> - データベース内のテーブルおよび関連するメタデータを含む結果セットを返す</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>