diff options
Diffstat (limited to 'doc/src/sgml/ref/dropdb.sgml')
| -rw-r--r-- | doc/src/sgml/ref/dropdb.sgml | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml new file mode 100644 index 00000000000..f0fd44a35f7 --- /dev/null +++ b/doc/src/sgml/ref/dropdb.sgml @@ -0,0 +1,232 @@ +<!-- +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.1 1999/12/04 04:53:15 momjian Exp $ +Postgres documentation +--> + +<refentry id="APP-DROPDB"> + <refmeta> + <refentrytitle id="APP-DROPDB-TITLE"> + <application>dropdb</application> + </refentrytitle> + <refmiscinfo>Application</refmiscinfo> + </refmeta> + <refnamediv> + <refname> + <application>dropdb</application> + </refname> + <refpurpose> + Remove an existing <productname>PostgreSQL</productname> database + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <refsynopsisdivinfo> + <date>1999-11-07</date> + </refsynopsisdivinfo> + <synopsis> +dropdb [ <replaceable class="parameter">options</replaceable> ] <replaceable class="parameter">dbname</replaceable> + </synopsis> + + <refsect2 id="R2-APP-DROPDB-1"> + <refsect2info> + <date>1999-11-07</date> + </refsect2info> + <title> + Inputs + </title> + <para> + + <variablelist> + <varlistentry> + <term>-h, --host <replaceable class="parameter">host</replaceable></term> + <listitem> + <para> + Specifies the hostname of the machine on which the + <application>postmaster</application> + is running. + </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 + extension on which the <application>postmaster</application> + is listening for connections. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-U, --username <replaceable class="parameter">username</replaceable></term> + <listitem> + <para> + Username to connect as. + </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 + and sends to the backend. + </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 + must be one of the existing <productname>PostgreSQL</productname> databases + 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 + <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. + </para> + </refsect2> + + + <refsect2 id="R2-APP-DROPDB-2"> + <refsect2info> + <date>1998-10-02</date> + </refsect2info> + <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"> + and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities. + </para> + </refsect2> + </refsynopsisdiv> + + + <refsect1 id="R1-APP-DROPDB-1"> + <refsect1info> + <date>1998-10-02</date> + </refsect1info> + <title> + Description + </title> + <para> + <application>dropdb</application> destroys an existing + <productname>PostgreSQL</productname> database. + 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 + the <productname>PostgreSQL</productname> interactive terminal + <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing + 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"> + <refsect1info> + <date>1999-11-07</date> + </refsect1info> + <title> + Usage + </title> + <para> + To destroy the database <literal>demo</literal> + on the default database server: + <programlisting> +$ <userinput>dropdb demo</userinput> +DROP DATABASE + </programlisting> + </para> + <para> + To destroy the database <literal>demo</literal> + using the postmaster on host eden, port 5000, with verification + and a peek at the underlying query: + <programlisting> +$ <userinput>dropdb -p 5000 -h eden -i -e demo</userinput> +Database "demo" will be permanently deleted. +Are you sure? (y/n) <userinput>y</userinput> +QUERY: DROP DATABASE "demo" +DROP DATABASE + </programlisting> + </para> + </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: +--> |