<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mysql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.mysql-list-fields.php',
    1 => 'mysql_list_fields',
    2 => 'List MySQL table fields',
  ),
  'up' => 
  array (
    0 => 'ref.mysql.php',
    1 => 'MySQL Functions',
  ),
  'prev' => 
  array (
    0 => 'function.mysql-list-dbs.php',
    1 => 'mysql_list_dbs',
  ),
  'next' => 
  array (
    0 => 'function.mysql-list-processes.php',
    1 => 'mysql_list_processes',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mysql/functions/mysql-list-fields.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mysql-list-fields" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mysql_list_fields</h1>
  <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_list_fields</span> &mdash; <span class="dc-title">List MySQL table fields</span></p>

 </div>

 <div id="function.mysql-list-fields-refsynopsisdiv">
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">This function was deprecated in PHP 5.4.0, and it
and the entire <a href="book.mysql.php" class="link">original MySQL extension</a> was removed in PHP 7.0.0.
Instead, use either the actively developed <a href="book.mysqli.php" class="link">MySQLi</a> or <a href="ref.pdo-mysql.php" class="link">PDO_MySQL</a> extensions.
See also the <a href="mysqlinfo.api.choosing.php" class="link">MySQL: choosing an API</a> guide.
Alternatives to this function include:</p>
   <ul class="simplelist">
    <li>SQL Query: <code class="literal">SHOW COLUMNS FROM sometable</code></li>
   </ul>
  </div>
 </div>

 <div class="refsect1 description" id="refsect1-function.mysql-list-fields-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>mysql_list_fields</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$database_name</code></span>, <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>, <span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$link_identifier</code><span class="initializer"> = NULL</span></span>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>

  <p class="simpara">
   Retrieves information about the given table name.
  </p>
  <p class="simpara">
   This function is deprecated. It is preferable to use
   <span class="function"><a href="function.mysql-query.php" class="function">mysql_query()</a></span> to issue an SQL <code class="literal">SHOW COLUMNS FROM
   table [LIKE &#039;name&#039;]</code> statement instead.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mysql-list-fields-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">database_name</code></dt>
    <dd>
     <span class="simpara">
      The name of the database that&#039;s being queried.
     </span>
    </dd>
   
   
    <dt><code class="parameter">table_name</code></dt>
    <dd>
     <span class="simpara">
      The name of the table that&#039;s being queried.
     </span>
    </dd>
   
   <dt>
<code class="parameter">link_identifier</code></dt><dd><p class="para">The MySQL connection. If the
link identifier is not specified, the last link opened by
<span class="function"><a href="function.mysql-connect.php" class="function">mysql_connect()</a></span> is assumed. If no such link is found, it
will try to create one as if <span class="function"><a href="function.mysql-connect.php" class="function">mysql_connect()</a></span> had been called
with no arguments. If no connection is found or established, an
<strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> level error is generated.</p></dd>

  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mysql-list-fields-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   A result pointer <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> on success, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on
   failure.
  </p>
  <p class="simpara">
   The returned result can be used with <span class="function"><a href="function.mysql-field-flags.php" class="function">mysql_field_flags()</a></span>,
   <span class="function"><a href="function.mysql-field-len.php" class="function">mysql_field_len()</a></span>,
   <span class="function"><a href="function.mysql-field-name.php" class="function">mysql_field_name()</a></span> and
   <span class="function"><a href="function.mysql-field-type.php" class="function">mysql_field_type()</a></span>.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mysql-list-fields-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 Alternate to deprecated <span class="function"><strong>mysql_list_fields()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SHOW COLUMNS FROM sometable"</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">'Could not run query: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">();<br />    exit;<br />}<br />if (</span><span style="color: #0000BB">mysql_num_rows</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">) &gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br />    while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_fetch_assoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br />        </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$row</span><span style="color: #007700">);<br />    }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [Field] =&gt; id
    [Type] =&gt; int(7)
    [Null] =&gt;
    [Key] =&gt; PRI
    [Default] =&gt;
    [Extra] =&gt; auto_increment
)
Array
(
    [Field] =&gt; email
    [Type] =&gt; varchar(100)
    [Null] =&gt;
    [Key] =&gt;
    [Default] =&gt;
    [Extra] =&gt;
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.mysql-list-fields-notes">
  <h3 class="title">Notes</h3>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    For backward compatibility, the following
deprecated alias may be used: 
    <span class="function"><strong>mysql_listfields()</strong></span>
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.mysql-list-fields-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.mysql-field-flags.php" class="function" rel="rdfs-seeAlso">mysql_field_flags()</a> - Get the flags associated with the specified field in a result</span></li>
   <li><span class="function"><a href="function.mysql-info.php" class="function" rel="rdfs-seeAlso">mysql_info()</a> - Get information about the most recent query</span></li>
  </ul>
 </div>

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