Source of: /manual/en/function.mysql-list-dbs.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = 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-dbs.php',
1 => 'mysql_list_dbs',
),
'up' =>
array (
0 => 'ref.mysql.php',
1 => 'MySQL Functions',
),
'prev' =>
array (
0 => 'function.mysql-insert-id.php',
1 => 'mysql_insert_id',
),
'next' =>
array (
0 => 'function.mysql-list-fields.php',
1 => 'mysql_list_fields',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mysql-list-dbs" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysql_list_dbs</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_list_dbs</span> — <span class="dc-title">List databases available on a MySQL server</span></p>
</div>
<a name="function.mysql-list-dbs.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>mysql_list_dbs</b></span>
([ <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span>
] )</div>
<p class="para rdfs-comment">
Returns a result pointer containing the databases available from the
current mysql daemon.
</p>
</div>
<a name="function.mysql-list-dbs.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">
link_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The MySQL connection. If the
link identifier is not specified, the last link opened by
<a href="function.mysql-connect.php" class="function">mysql_connect()</a> is assumed. If no such link is found, it
will try to create one as if <a href="function.mysql-connect.php" class="function">mysql_connect()</a> was called
with no arguments. If no connection is found or established, an
<b><tt class="constant">E_WARNING</tt></b> level error is generated.</p></dd>
</dl>
<p>
</p>
</div>
<a name="function.mysql-list-dbs.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a result pointer <a href="language.types.resource.php" class="type resource">resource</a> on success, or <b><tt class="constant">FALSE</tt></b> on
failure. Use the <a href="function.mysql-tablename.php" class="function">mysql_tablename()</a> function to traverse
this result pointer, or any function for result tables, such as
<a href="function.mysql-fetch-array.php" class="function">mysql_fetch_array()</a>.
</p>
</div>
<a name="function.mysql-list-dbs.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mysql_list_dbs()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_password'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$db_list </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_list_dbs</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$db_list</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">Database </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
database1
database2
database3
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.mysql-list-dbs.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>:
For backward compatibility, the following
deprecated alias may be used:
<b>mysql_listdbs()</b>
<br />
</p></blockquote>
</div>
<a name="function.mysql-list-dbs.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mysql-db-name.php" class="function" rel="rdfs-seeAlso">mysql_db_name()</a> - Get result data</li>
<li class="member"><a href="function.mysql-select-db.php" class="function" rel="rdfs-seeAlso">mysql_select_db()</a> - Select a MySQL database</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
