<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdostatement.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'pdostatement.getcolumnmeta.php',
    1 => 'PDOStatement::getColumnMeta',
    2 => '返回结果集中一列的元数据',
  ),
  'up' => 
  array (
    0 => 'class.pdostatement.php',
    1 => 'PDOStatement',
  ),
  'prev' => 
  array (
    0 => 'pdostatement.getattribute.php',
    1 => 'PDOStatement::getAttribute',
  ),
  'next' => 
  array (
    0 => 'pdostatement.getiterator.php',
    1 => 'PDOStatement::getIterator',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/pdo/pdostatement/getcolumnmeta.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pdostatement.getcolumnmeta" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PDOStatement::getColumnMeta</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8, PECL pdo &gt;= 0.2.0)</p><p class="refpurpose"><span class="refname">PDOStatement::getColumnMeta</span> &mdash; <span class="dc-title">
   返回结果集中一列的元数据
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-pdostatement.getcolumnmeta-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PDOStatement::getColumnMeta</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$column</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  
  <p class="para rdfs-comment">
   检索一个在结果集中以0开始索引的列的元数据作为一个关联数组。
  </p>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="simpara">
    一些驱动程序可能没有实现 <span class="methodname"><strong>PDOStatement::getColumnMeta()</strong></span>，因为它是可选的。但是，手册中记录的所有
    <a href="pdo.drivers.php" class="link">PDO 驱动程序</a>都实现了此功能。
   </p>
  </div>

 </div>

 <div class="refsect1 parameters" id="refsect1-pdostatement.getcolumnmeta-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">column</code></dt>
      <dd>
       <p class="para">
        结果集中以0开始索引的列。
       </p>
      </dd>
     
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pdostatement.getcolumnmeta-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
  返回一个关联数组，它包含了下列表示一个单独列的元数据的值：
  </p>
   <table class="doctable table">
    <caption><strong>列的元数据</strong></caption>
    
     <col /> 
     <col /> 
     <thead>
      <tr>
       <th>名称</th>
       <th>值</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">native_type</code></td>
       <td>用于表示列值的 PHP 原生类型。</td>
      </tr>

      <tr>
       <td><code class="literal">driver:decl_type</code></td>
       <td>在数据库中用于表示列值的 SQL 类型。如果结果集中的列是一个函数的结果，则该值不能被 <span class="methodname"><strong>PDOStatement::getColumnMeta()</strong></span> 返回。
       </td>
      </tr>

      <tr>
       <td><code class="literal">flags</code></td>
       <td>任何设置于此列的标记。</td>
      </tr>

      <tr>
       <td><code class="literal">name</code></td>
       <td>通过数据库返回的列名。</td>
      </tr>

      <tr>
       <td><code class="literal">table</code></td>
       <td>通过数据库返回的该列的表名</td>
      </tr>

      <tr>
       <td><code class="literal">len</code></td>
       <td>该列的长度。除浮点小数外通常为 <code class="literal">-1</code></td>
      </tr>

      <tr>
       <td><code class="literal">precision</code></td>
       <td>该列的数值精度。除浮点小数外通常为 <code class="literal">0</code>。</td>
      </tr>

      <tr>
       <td><code class="literal">pdo_type</code></td>
       <td>以 <a href="pdo.constants.php" class="link"><code class="literal">PDO::PARAM_*</code> 常量</a>为代表的列类型。</td> 
      </tr>

     </tbody>
    
   </table>

  <p class="para">
  如果结果集不存在，或者是请求的列在结果集中不存在，则返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 

 <div class="refsect1 examples" id="refsect1-pdostatement.getcolumnmeta-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 检索列的元数据</strong></p>
    <div class="example-contents"><p>
     下面示例展示了在 PDO_SQLITE 中，检索一个通过函数（COUNT）生成单独列的元数据的结果。
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$select </span><span style="color: #007700">= </span><span style="color: #0000BB">$DB</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT COUNT(*) FROM fruit'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$meta </span><span style="color: #007700">= </span><span style="color: #0000BB">$select</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getColumnMeta</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$meta</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>以上示例会输出：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(6) {
  [&quot;native_type&quot;]=&gt;
  string(7) &quot;integer&quot;
  [&quot;flags&quot;]=&gt;
  array(0) {
  }
  [&quot;name&quot;]=&gt;
  string(8) &quot;COUNT(*)&quot;
  [&quot;len&quot;]=&gt;
  int(-1)
  [&quot;precision&quot;]=&gt;
  int(0)
  [&quot;pdo_type&quot;]=&gt;
  int(2)
}</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-pdostatement.getcolumnmeta-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="pdostatement.columncount.php" class="methodname" rel="rdfs-seeAlso">PDOStatement::columnCount()</a> - 返回结果集中的列数</span></li>
    <li><span class="methodname"><a href="pdostatement.rowcount.php" class="methodname" rel="rdfs-seeAlso">PDOStatement::rowCount()</a> - 返回受上一个 SQL 语句影响的行数</span></li>
   </ul>
  </p>
 </div>


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