<?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-statistics.php',
    1 => 'db2_statistics',
    2 => 'インデックスの情報およびテーブルの統計情報を含む結果セットを返す',
  ),
  'up' => 
  array (
    0 => 'ref.ibm-db2.php',
    1 => 'IBM DB2 関数',
  ),
  'prev' => 
  array (
    0 => 'function.db2-special-columns.php',
    1 => 'db2_special_columns',
  ),
  'next' => 
  array (
    0 => 'function.db2-stmt-error.php',
    1 => 'db2_stmt_error',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ibm_db2/functions/db2-statistics.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.db2-statistics" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_statistics</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_statistics</span> &mdash; <span class="dc-title">
   インデックスの情報およびテーブルの統計情報を含む結果セットを返す
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-statistics-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_statistics</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>,<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$table_name</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$unique</code></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-statistics-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">
      対象となるテーブルを含むスキーマ。
      このパラメータを <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> にすると、現在のユーザーのスキーマについての
      統計およびインデックスが返されます。
     </span>
    </dd>
    
   
    <dt><code class="parameter">table_name</code></dt>
    <dd>
     <span class="simpara">
      テーブルの名前。
     </span>
    </dd>
    
   
    <dt><code class="parameter">unique</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">unique</code> が <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合、
      テーブルのすべてのインデックス情報を返します。
      そうでない場合、
      テーブルのユニークインデックスに関する情報だけを返します。
     </span>
    </dd>
    
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-statistics-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>
        テーブルを含むカタログの名前。テーブルがカタログを保持していない場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>TABLE_SCHEM</td>
       <td>テーブルを含むスキーマの名前。</td>
      </tr>

      <tr>
       <td>TABLE_NAME</td>
       <td>テーブルの名前。</td>
      </tr>

      <tr>
       <td>NON_UNIQUE</td>
       <td>
        <p class="para">
         インデックスが一意でなければならないかどうか、
         あるいはその行がテーブルの統計情報であるかどうかを表す整数値。
         <table class="doctable informaltable">
          
           <thead>
            <tr>
             <th>戻り値</th>
             <th>パラメータの型</th>
            </tr>

           </thead>

           <tbody class="tbody">
            <tr>
             <td>0 (SQL_FALSE)</td>
             <td>インデックスは、重複した値をとることができます。</td>
            </tr>

            <tr>
             <td>1 (SQL_TRUE)</td>
             <td>インデックスは、一意でなければなりません。</td>
            </tr>

            <tr>
             <td><strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></td>
             <td>この行は、テーブル自身についての統計情報です。</td>
            </tr>

           </tbody>
          
         </table>

        </p>
       </td>
      </tr>

      <tr>
       <td>INDEX_QUALIFIER</td>
       <td>
        インデックスの資格を満たすため、INDEX_NAME
        の先頭に付加しなければならない修飾子を表す文字列。
       </td>
      </tr>

      <tr>
       <td>INDEX_NAME</td>
       <td>インデックスの名前を表す文字列。</td>
      </tr>

      <tr>
       <td>TYPE</td>
       <td>
        <p class="para">
         結果セットのこの行に含まれる情報の型を表す整数値。
         <table class="doctable informaltable">
          
           <thead>
            <tr>
             <th>戻り値</th>
             <th>パラメータの型</th>
            </tr>

           </thead>

           <tbody class="tbody">
            <tr>
             <td>0 (SQL_TABLE_STAT)</td>
             <td>この行は、テーブル自身の統計情報を含みます。</td>
            </tr>

            <tr>
             <td>1 (SQL_INDEX_CLUSTERED)</td>
             <td>この行は、クラスタ化インデックスについての情報を含みます。</td>
            </tr>

            <tr>
             <td>2 (SQL_INDEX_HASH)</td>
             <td>この行は、ハッシュインデックスについての情報を含みます。</td>
            </tr>

            <tr>
             <td>3 (SQL_INDEX_OTHER)</td>
             <td>
              この行は、クラスタ化もハッシュも行われていない
              インデックスについての情報を含みます。
             </td>
            </tr>

           </tbody>
          
         </table>

        </p>
       </td>
      </tr>

      <tr>
       <td>ORDINAL_POSITION</td>
       <td>
        インデックス内の、1 から始まるカラムの位置。
        その行がテーブル自身についての統計情報を含んでいる場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>COLUMN_NAME</td>
       <td>
        インデックス内のカラムの名前。
        その行がテーブル自身についての統計情報を含んでいる場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>ASC_OR_DESC</td>
       <td>
        カラムの並び順が昇順の場合は <code class="literal">A</code>、
        降順の場合は <code class="literal">D</code>、
        その行がテーブル自身についての統計情報を含んでいる場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>CARDINALITY</td>
       <td>
        <span class="simpara">
         その行がインデックスの情報を含んでいる場合、このカラムには
         インデックス内の一意な値の数を表す整数値が含まれます。
        </span>
        <span class="simpara">
         その行がテーブル自身についての情報を含んでいる場合、
         このカラムにはテーブルの行数を表す整数値が含まれます。
        </span>
       </td>
      </tr>

      <tr>
       <td>PAGES</td>
       <td>
        <span class="simpara">
         その行がインデックスの情報を含んでいる場合、このカラムには
         インデックスを保存するために使用しているページ数を表す整数値が含まれます。
        </span>
        <span class="simpara">
         その行がテーブル自身についての情報を含んでいる場合、このカラムには
         テーブルを保存するために使用しているページ数を表す整数値が含まれます。
        </span>
       </td>
      </tr>

      <tr>
       <td>FILTER_CONDITION</td>
       <td>常に <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。</td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 

 <div class="refsect1 seealso" id="refsect1-function.db2-statistics-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-columns.php" class="function" rel="rdfs-seeAlso">db2_columns()</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-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); ?>