Source of: /manual/en/function.mysql-drop-db.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-drop-db.php',
1 => 'mysql_drop_db',
),
'up' =>
array (
0 => 'ref.mysql.php',
1 => 'MySQL Functions',
),
'prev' =>
array (
0 => 'function.mysql-db-query.php',
1 => 'mysql_db_query',
),
'next' =>
array (
0 => 'function.mysql-errno.php',
1 => 'mysql_errno',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mysql-drop-db" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysql_drop_db</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_drop_db</span> — <span class="dc-title">Drop (delete) a MySQL database</span></p>
</div>
<a name="function.mysql-drop-db.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>mysql_drop_db</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$database_name</tt></span>
[, <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>mysql_drop_db()</b> attempts to drop (remove) an
entire database from the server associated with the specified
link identifier. This function is deprecated, it is preferable to use
<a href="function.mysql-query.php" class="function">mysql_query()</a> to issue a sql
<i>DROP DATABASE</i> statement instead.
</p>
</div>
<a name="function.mysql-drop-db.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">database_name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The name of the database that will be deleted.
</p>
</dd>
<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-drop-db.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.mysql-drop-db.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mysql_drop_db()</b> alternative 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 />if (!</span><span style="color: #0000BB">$link</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Could not connect: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">'DROP DATABASE my_db'</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">mysql_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">, </span><span style="color: #0000BB">$link</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Database my_db was successfully dropped\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'Error dropping database: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</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><p>
</p>
</div>
<a name="function.mysql-drop-db.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<div class="warning"><b class="warning">Warning</b>
<p class="para">
This function will not be available if the MySQL extension was built
against a MySQL 4.x client library.
</p>
</div>
<blockquote><p><b class="note">Note</b>:
For backward compatibility, the following
deprecated alias may be used:
<b>mysql_dropdb()</b>
<br />
</p></blockquote>
</div>
<a name="function.mysql-drop-db.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-query.php" class="function" rel="rdfs-seeAlso">mysql_query()</a> - Send a MySQL query</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
