1999-12-04 05:53:22 +01:00
|
|
|
<!--
|
2002-04-21 21:02:39 +02:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.15 2002/04/21 19:02:39 thomas Exp $
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-12-04 05:53:22 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
<refentry id="APP-DROPDB">
|
|
|
|
<refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refentrytitle id="APP-DROPDB-TITLE"><application>dropdb</application></refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
1999-12-04 05:53:22 +01:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refname>dropdb</refname>
|
2001-09-03 14:57:50 +02:00
|
|
|
<refpurpose>remove a <productname>PostgreSQL</productname> database</refpurpose>
|
1999-12-04 05:53:22 +01:00
|
|
|
</refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<refsynopsisdiv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>dropdb</command>
|
|
|
|
<arg rep="repeat"><replaceable>options</replaceable></arg>
|
|
|
|
<arg choice="plain"><replaceable>dbname</replaceable></arg>
|
|
|
|
</cmdsynopsis>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
|
|
|
<refsect2 id="R2-APP-DROPDB-1">
|
|
|
|
<title>
|
|
|
|
Inputs
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term>-h, --host <replaceable class="parameter">host</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-11-28 21:49:10 +01:00
|
|
|
Specifies the host name of the machine on which the
|
|
|
|
server
|
2000-11-14 00:57:20 +01:00
|
|
|
is running. If host begins with a slash, it is used
|
2002-01-20 23:19:57 +01:00
|
|
|
as the directory for the Unix domain socket.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-p, --port <replaceable class="parameter">port</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the Internet TCP/IP port or local Unix domain socket file
|
2001-11-28 21:49:10 +01:00
|
|
|
extension on which the server
|
1999-12-04 05:53:22 +01:00
|
|
|
is listening for connections.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-U, --username <replaceable class="parameter">username</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-11-28 21:49:10 +01:00
|
|
|
User name to connect as
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-W, --password</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Force password prompt.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-e, --echo</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Echo the queries that <application>dropdb</application> generates
|
2001-11-28 21:49:10 +01:00
|
|
|
and sends to the server.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-q, --quiet</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Do not display a response.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>-i, --interactive</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Issues a verification prompt before doing anything destructive.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><replaceable class="parameter">dbname</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the name of the database to be removed. The database
|
2001-11-28 21:49:10 +01:00
|
|
|
must be one of the existing <productname>PostgreSQL</productname> databases
|
1999-12-04 05:53:22 +01:00
|
|
|
in this installation.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
|
|
|
|
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
|
2000-12-26 00:15:27 +01:00
|
|
|
<xref linkend="APP-PSQL">.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</refsect2>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect2 id="R2-APP-DROPDB-2">
|
|
|
|
<title>
|
|
|
|
Outputs
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><computeroutput>DROP DATABASE</computeroutput></term>
|
|
|
|
<listitem>
|
|
|
|
<para>The database was successfully removed.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><computeroutput>dropdb: Database removal failed.</computeroutput></term>
|
|
|
|
<listitem>
|
|
|
|
<para>Something didn't work out.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
If there is an error condition, the backend error message will be displayed.
|
|
|
|
See <xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title">
|
2000-12-26 00:15:27 +01:00
|
|
|
and <xref linkend="APP-PSQL"> for possibilities.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</refsect2>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="R1-APP-DROPDB-1">
|
|
|
|
<title>
|
|
|
|
Description
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
<application>dropdb</application> destroys an existing
|
2001-11-28 21:49:10 +01:00
|
|
|
<productname>PostgreSQL</productname> database.
|
1999-12-04 05:53:22 +01:00
|
|
|
The user who executes this command must be a database
|
|
|
|
superuser or the owner of the database.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>dropdb</application> is a shell script wrapper around the
|
|
|
|
<acronym>SQL</acronym> command
|
|
|
|
<xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title"> via
|
2001-11-28 21:49:10 +01:00
|
|
|
the <productname>PostgreSQL</productname> interactive terminal
|
2000-12-26 00:15:27 +01:00
|
|
|
<xref linkend="APP-PSQL">. Thus, there is nothing
|
1999-12-04 05:53:22 +01:00
|
|
|
special about dropping databases via this or other methods. This means
|
|
|
|
that the <application>psql</application> must be found by the script and that
|
|
|
|
a database server is running at the targeted host. Also, any default
|
|
|
|
settings and environment variables available to <application>psql</application>
|
|
|
|
and the <application>libpq</application> front-end library do apply.
|
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="R1-APP-DROPDB-2">
|
2000-11-12 00:01:45 +01:00
|
|
|
<title>Usage</title>
|
|
|
|
|
|
|
|
<informalexample>
|
|
|
|
<para>
|
|
|
|
To destroy the database <literal>demo</literal> on the default
|
|
|
|
database server:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>dropdb demo</userinput>
|
|
|
|
<computeroutput>DROP DATABASE</computeroutput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</informalexample>
|
|
|
|
|
|
|
|
<informalexample>
|
|
|
|
<para>
|
|
|
|
To destroy the database <literal>demo</literal> using the
|
2002-01-20 23:19:57 +01:00
|
|
|
server on host <literal>eden</literal>, port 5000, with verification and a peek
|
2000-11-12 00:01:45 +01:00
|
|
|
at the underlying query:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>dropdb -p 5000 -h eden -i -e demo</userinput>
|
|
|
|
<computeroutput>Database "demo" will be permanently deleted.
|
|
|
|
Are you sure? (y/n) </computeroutput><userinput>y</userinput>
|
|
|
|
<computeroutput>DROP DATABASE "demo"
|
|
|
|
DROP DATABASE</computeroutput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</informalexample>
|
1999-12-04 05:53:22 +01:00
|
|
|
</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:
|
|
|
|
-->
|