postgresql/doc/src/sgml/ref/drop_database.sgml

135 lines
3.3 KiB
Plaintext
Raw Normal View History

<!--
2003-08-31 19:32:24 +02:00
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.17 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refentry id="SQL-DROPDATABASE">
<refmeta>
<refentrytitle id="SQL-DROPDATABASE-TITLE">DROP DATABASE</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
2003-05-04 04:23:16 +02:00
<refnamediv>
2003-05-04 04:23:16 +02:00
<refname>DROP DATABASE</refname>
<refpurpose>remove a database</refpurpose>
</refnamediv>
2003-05-04 04:23:16 +02:00
2003-08-31 19:32:24 +02:00
<indexterm zone="sql-dropdatabase">
<primary>DROP DATABASE</primary>
</indexterm>
<refsynopsisdiv>
2003-05-04 04:23:16 +02:00
<synopsis>
DROP DATABASE <replaceable class="PARAMETER">name</replaceable>
2003-05-04 04:23:16 +02:00
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
2003-05-04 04:23:16 +02:00
<para>
<command>DROP DATABASE</command> drops a database. It removes the
catalog entries for the database and deletes the directory
containing the data. It can only be executed by the database owner.
</para>
2003-05-04 04:23:16 +02:00
<para>
<command>DROP DATABASE</command> cannot be undone. Use it with care!
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><replaceable class="PARAMETER">name</replaceable></term>
<listitem>
<para>
The name of the database to remove.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<variablelist>
<varlistentry>
<term><computeroutput>DROP DATABASE</computeroutput></term>
<listitem>
<para>
2003-05-04 04:23:16 +02:00
This message is returned if the command was successful.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>DROP DATABASE: cannot be executed on the currently open database</computeroutput></term>
<listitem>
<para>
You cannot be connected to the database you are about to remove.
Instead, connect to <literal>template1</literal> or any other
database and run this command again.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>DROP DATABASE: may not be called in a transaction block</computeroutput></term>
<listitem>
<para>
You must finish the transaction in progress before you can call this command.
</para>
</listitem>
</varlistentry>
</variablelist>
2003-05-04 04:23:16 +02:00
</refsect1>
<refsect1>
<title>Notes</title>
<para>
2003-05-04 04:23:16 +02:00
This command cannot be executed while connected to the target
database. Thus, it might be more convenient to use the program
<xref linkend="app-dropdb" endterm="app-dropdb-title"> instead,
which is a wrapper around this command.
</para>
2003-05-04 04:23:16 +02:00
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
2003-05-04 04:23:16 +02:00
The is no <command>DROP DATABASE</command> statement in the SQL standard.
</para>
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-createdatabase" endterm="sql-createdatabase-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->