mysql-fetch-field.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65e697ff671608989432a6e6bf8ae8128b2be2c7 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa -->
<refentry xml:id="function.mysql-fetch-field" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_fetch_field</refname>
  <refpurpose>結果からカラム情報を取得し、オブジェクトとして返す</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_fetch_field</function></member>
    <member><methodname>PDOStatement::getColumnMeta</methodname></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</type><methodname>mysql_fetch_field</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   フィールド情報を含むオブジェクトを返します。特定のクエリー結果の中の
   フィールドに関する情報を得るために使用可能です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
    <varlistentry>
     <term><parameter>field_offset</parameter></term>
     <listitem>
      <para>
       数字で表したフィールドの位置です。もし指定されなければ、
       まだこの関数で情報を取得していないフィールドのうち最初のものが
       選択されます。<parameter>field_offset</parameter> は、
       <literal>0</literal> からはじまります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   フィールド情報を含む<type>object</type>を返します。オブジェクトの
   プロパティは次のとおりです。
  </para>
  <para>
   <itemizedlist>
    <listitem>
     <simpara>
      name - カラム名
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      table - カラムが属しているテーブルの名前。エイリアスを定義している場合はエイリアスの名前
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      max_length - カラムの最大長
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      not_null - カラムが &null; 値をとることができない場合 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      primary_key - カラムが主キーであれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      unique_key - カラムがユニークキーであれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      multiple_key - カラムが非ユニークキーであれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      numeric - カラムが数値(numeric)であれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      blob - カラムがBLOBであれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      type - カラムの型
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      unsigned - カラムが符号無し(unsigned)であれば 1
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      zerofill - カラムがゼロで埋められている(zero-filled)場合に 1
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mysql_fetch_field</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$conn = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$conn) {
    die('Could not connect: ' . mysql_error());
}
mysql_select_db('database');
$result = mysql_query('select * from table');
if (!$result) {
    die('Query failed: ' . mysql_error());
}
/* カラムのメタデータを取得する */
$i = 0;
while ($i < mysql_num_fields($result)) {
    echo "Information for column $i:<br />\n";
    $meta = mysql_fetch_field($result, $i);
    if (!$meta) {
        echo "No information available<br />\n";
    }
    echo "<pre>
blob:         $meta->blob
max_length:   $meta->max_length
multiple_key: $meta->multiple_key
name:         $meta->name
not_null:     $meta->not_null
numeric:      $meta->numeric
primary_key:  $meta->primary_key
table:        $meta->table
type:         $meta->type
unique_key:   $meta->unique_key
unsigned:     $meta->unsigned
zerofill:     $meta->zerofill
</pre>";
    $i++;
}
mysql_free_result($result);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &database.field-case;
  <note>
   <para>
    SQL クエリでフィールド名やテーブル名のエイリアスを設定している場合は、
    エイリアスを返します。本来の名前を取得するには、
    <methodname>mysqli_result::fetch_field</methodname> を使いましょう。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_field_seek</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
-->