aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/drop_database.sgml
blob: fb77f53c67ce4d7bc05247ff835a0cacad9ff476 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.16 2003/05/04 02:23:16 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-DROPDATABASE">
 <refmeta>
  <refentrytitle id="SQL-DROPDATABASE-TITLE">DROP DATABASE</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>DROP DATABASE</refname>
  <refpurpose>remove a database</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
DROP DATABASE <replaceable class="PARAMETER">name</replaceable>
</synopsis>
 </refsynopsisdiv>
 
 <refsect1>
  <title>Description</title>

  <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>

  <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>
        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>
 </refsect1>

 <refsect1>
  <title>Notes</title>

  <para>
   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>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>

  <para>
   The is no <command>DROP DATABASE</command> statement in the SQL standard.
  </para>
 </refsect1>

 <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:
-->