<?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 => 'de',
  ),
  'this' => 
  array (
    0 => 'function.db2-special-columns.php',
    1 => 'db2_special_columns',
    2 => 'Returns a result set listing the unique row identifier columns for a table',
  ),
  'up' => 
  array (
    0 => 'ref.ibm-db2.php',
    1 => 'IBM DB2 Funktionen',
  ),
  'prev' => 
  array (
    0 => 'function.db2-set-option.php',
    1 => 'db2_set_option',
  ),
  'next' => 
  array (
    0 => 'function.db2-statistics.php',
    1 => 'db2_statistics',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ibm_db2/functions/db2-special-columns.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.db2-special-columns" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_special_columns</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_special_columns</span> &mdash; <span class="dc-title">
   Returns a result set listing the unique row identifier columns for a table
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-special-columns-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_special_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>,<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">$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.integer.php" class="type int">int</a></span> <code class="parameter">$scope</code></span><br>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>


  <p class="simpara">
   Returns a result set listing the unique row identifier columns for a table.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.db2-special-columns-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <dl>
   
    <dt><code class="parameter">connection</code></dt>
    <dd>
     <span class="simpara">
      A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
     </span>
    </dd>
   
   
    <dt><code class="parameter">qualifier</code></dt>
    <dd>
     <span class="simpara">
      A qualifier for DB2 databases running on OS/390 or z/OS servers. For
      other databases, pass <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> or an empty string.
     </span>
    </dd>
   
   
    <dt><code class="parameter">schema</code></dt>
    <dd>
     <span class="simpara">
      The schema which contains the tables.
     </span>
    </dd>
   
   
    <dt><code class="parameter">table_name</code></dt>
    <dd>
     <span class="simpara">
      The name of the table.
     </span>
    </dd>
   
   
    <dt><code class="parameter">scope</code></dt>
    <dd>
     <p class="para">
      Integer value representing the minimum duration for which the
      unique row identifier is valid. This can be one of the following
      values:
      <table class="doctable informaltable">
       
        <thead>
         <tr>
          <th>Integer value</th>
          <th>SQL constant</th>
          <th>Description</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>0</td>
          <td>SQL_SCOPE_CURROW</td>
          <td>Row identifier is valid only while the cursor is positioned
          on the row.</td>
         </tr>

         <tr>
          <td>1</td>
          <td>SQL_SCOPE_TRANSACTION</td>
          <td>Row identifier is valid for the duration of the
           transaction.</td>
         </tr>

         <tr>
          <td>2</td>
          <td>SQL_SCOPE_SESSION</td>
          <td>Row identifier is valid for the duration of the
           connection.</td>
         </tr>

        </tbody>
       
      </table>

     </p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-special-columns-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   Returns a statement resource with a result set containing rows with unique
   row identifier information for a table. The rows are composed of the
   following columns:
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Column name</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>SCOPE</td>
       <td>
        <table class="doctable informaltable">
         
          <thead>
           <tr>
            <th>Integer value</th>
            <th>SQL constant</th>
            <th>Description</th>
           </tr>

          </thead>

          <tbody class="tbody">
           <tr>
            <td>0</td>
            <td>SQL_SCOPE_CURROW</td>
            <td>Row identifier is valid only while the cursor is positioned
            on the row.</td>
           </tr>

           <tr>
            <td>1</td>
            <td>SQL_SCOPE_TRANSACTION</td>
            <td>Row identifier is valid for the duration of the
             transaction.</td>
           </tr>

           <tr>
            <td>2</td>
            <td>SQL_SCOPE_SESSION</td>
            <td>Row identifier is valid for the duration of the
             connection.</td>
           </tr>

          </tbody>
         
        </table>

       </td>
      </tr>

      <tr>
       <td>COLUMN_NAME</td>
       <td>Name of the unique column.</td>
      </tr>

      <tr>
       <td>DATA_TYPE</td>
       <td>SQL data type for the column.</td>
      </tr>

      <tr>
       <td>TYPE_NAME</td>
       <td>Character string representation of the SQL data type for the
       column.</td>
      </tr>

      <tr>
       <td>COLUMN_SIZE</td>
       <td>An integer value representing the size of the column.</td>
      </tr>

      <tr>
       <td>BUFFER_LENGTH</td>
       <td>
        Maximum number of bytes necessary to store data from this column.
       </td>
      </tr>

      <tr>
       <td>DECIMAL_DIGITS</td>
       <td>
        The scale of the column, or <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> where scale is not applicable.
       </td>
      </tr>

      <tr>
       <td>NUM_PREC_RADIX</td>
       <td>
        An integer value of either <code class="literal">10</code> (representing
        an exact numeric data type), <code class="literal">2</code> (representing an
        approximate numeric data type), or <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> (representing a data type for
        which radix is not applicable).
       </td>
      </tr>

      <tr>
       <td>PSEUDO_COLUMN</td>
       <td>Always returns 1.</td>
      </tr>

     </tbody>
    
   </table>


  </p>
 </div>


 

 <div class="refsect1 seealso" id="refsect1-function.db2-special-columns-seealso">
  <h3 class="title">Siehe auch</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.db2-column-privileges.php" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</span></li>
   <li><span class="function"><a href="function.db2-columns.php" class="function" rel="rdfs-seeAlso">db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</span></li>
   <li><span class="function"><a href="function.db2-foreign-keys.php" class="function" rel="rdfs-seeAlso">db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</span></li>
   <li><span class="function"><a href="function.db2-primary-keys.php" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a> - Returns a result set listing primary keys for a table</span></li>
   <li><span class="function"><a href="function.db2-procedure-columns.php" class="function" rel="rdfs-seeAlso">db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</span></li>
   <li><span class="function"><a href="function.db2-procedures.php" class="function" rel="rdfs-seeAlso">db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</span></li>
   <li><span class="function"><a href="function.db2-statistics.php" class="function" rel="rdfs-seeAlso">db2_statistics()</a> - Returns a result set listing the index and statistics for a table</span></li>
   <li><span class="function"><a href="function.db2-table-privileges.php" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</span></li>
   <li><span class="function"><a href="function.db2-tables.php" class="function" rel="rdfs-seeAlso">db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</span></li>
  </ul>
 </div>


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