<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>List MySQL table fields</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysql-list-dbs.html">mysql_list_dbs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mysql-list-processes.html">mysql_list_processes</a></div>
<div class="up"><a href="ref.mysql.html">MySQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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> — <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 extension is deprecated as of PHP 5.5.0, and will be removed in the future.
Instead, the <a href="book.mysqli.html" class="link">MySQLi</a> or <a href="ref.pdo-mysql.html" class="link">PDO_MySQL</a> extension should be used.
See also <a href="mysqlinfo.api.choosing.html" class="link">MySQL: choosing an API</a> guide and
<a href="faq.databases.html#faq.databases.mysql.deprecated" class="link">related FAQ</a> for more information.
Alternatives to this function include:</p>
<ul class="simplelist">
<li class="member">SQL Query: <em>SHOW COLUMNS FROM sometable</em></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="type">resource</span> <span class="methodname"><strong>mysql_list_fields</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$database_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$table_name</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code><span class="initializer"> = NULL</span></span>
] )</div>
<p class="para rdfs-comment">
Retrieves information about the given table name.
</p>
<p class="para">
This function is deprecated. It is preferable to use
<span class="function"><a href="function.mysql-query.html" class="function">mysql_query()</a></span> to issue an SQL <em>SHOW COLUMNS FROM
table [LIKE 'name']</em> statement instead.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mysql-list-fields-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">database_name</code></em></span>
<dd>
<p class="para">
The name of the database that's being queried.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">table_name</code></em></span>
<dd>
<p class="para">
The name of the table that's being queried.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">
link_identifier</code></em></span><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.html" 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.html" class="function">mysql_connect()</a></span> was called
with no arguments. If no connection is found or established, an
<strong><code>E_WARNING</code></strong> level error is generated.</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mysql-list-fields-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A result pointer <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> on success, or <strong><code>FALSE</code></strong> on
failure.
</p>
<p class="para">
The returned result can be used with <span class="function"><a href="function.mysql-field-flags.html" class="function">mysql_field_flags()</a></span>,
<span class="function"><a href="function.mysql-field-len.html" class="function">mysql_field_len()</a></span>,
<span class="function"><a href="function.mysql-field-name.html" class="function">mysql_field_name()</a></span> and
<span class="function"><a href="function.mysql-field-type.html" 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>
<p class="para">
<div class="example" id="example-1602">
<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"><?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">) > </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">?></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="cdata"><pre>
Array
(
[Field] => id
[Type] => int(7)
[Null] =>
[Key] => PRI
[Default] =>
[Extra] => auto_increment
)
Array
(
[Field] => email
[Type] => varchar(100)
[Null] =>
[Key] =>
[Default] =>
[Extra] =>
)
</pre></div>
</div>
</div>
</p>
</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>:
<p class="para">
For backward compatibility, the following
deprecated alias may be used:
<span class="function"><strong>mysql_listfields()</strong></span>
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.mysql-list-fields-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mysql-field-flags.html" class="function" rel="rdfs-seeAlso">mysql_field_flags()</a> - Get the flags associated with the specified field in a result</span></li>
<li class="member"> <span class="function"><a href="function.mysql-info.html" class="function" rel="rdfs-seeAlso">mysql_info()</a> - Get information about the most recent query</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysql-list-dbs.html">mysql_list_dbs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mysql-list-processes.html">mysql_list_processes</a></div>
<div class="up"><a href="ref.mysql.html">MySQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
