aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/drop_schema.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/ref/drop_schema.sgml')
-rw-r--r--doc/src/sgml/ref/drop_schema.sgml220
1 files changed, 90 insertions, 130 deletions
diff --git a/doc/src/sgml/ref/drop_schema.sgml b/doc/src/sgml/ref/drop_schema.sgml
index 8c69893ae2f..5411b257991 100644
--- a/doc/src/sgml/ref/drop_schema.sgml
+++ b/doc/src/sgml/ref/drop_schema.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.1 2002/07/18 16:47:22 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.2 2003/05/04 02:23:16 petere Exp $
PostgreSQL documentation
-->
@@ -8,107 +8,23 @@ PostgreSQL documentation
<refentrytitle id="SQL-DROPSCHEMA-TITLE">DROP SCHEMA</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- DROP SCHEMA
- </refname>
- <refpurpose>
- remove a schema
- </refpurpose>
+ <refname>DROP SCHEMA</refname>
+ <refpurpose>remove a schema</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>2002-07-18</date>
- </refsynopsisdivinfo>
- <synopsis>
+<synopsis>
DROP SCHEMA <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
-
- </synopsis>
-
- <refsect2 id="R2-SQL-DROPSCHEMA-1">
- <refsect2info>
- <date>2002-07-18</date>
- </refsect2info>
- <title>
- Inputs
- </title>
- <para>
- <variablelist>
- <varlistentry>
- <term><replaceable class="PARAMETER">name</replaceable></term>
- <listitem>
- <para>
- The name of a schema.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>CASCADE</term>
- <listitem>
- <para>
- Automatically drop objects (tables, functions, etc) that are contained
- in the schema.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>RESTRICT</term>
- <listitem>
- <para>
- Refuse to drop the schema if it contains any objects.
- This is the default.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect2>
-
- <refsect2 id="R2-SQL-DROPSCHEMA-2">
- <refsect2info>
- <date>2002-07-18</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
-
- <variablelist>
- <varlistentry>
- <term><computeroutput>
-DROP SCHEMA
- </computeroutput></term>
- <listitem>
- <para>
- The message returned if the schema is successfully dropped.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><computeroutput>
-ERROR: Schema "<replaceable class="parameter">name</replaceable>" does not exist
- </computeroutput></term>
- <listitem>
- <para>
- This message occurs if the specified schema does not exist.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </para>
- </refsect2>
+</synopsis>
</refsynopsisdiv>
- <refsect1 id="R1-SQL-DROPSCHEMA-1">
- <refsect1info>
- <date>2002-07-18</date>
- </refsect1info>
- <title>
- Description
- </title>
+ <refsect1>
+ <title>Description</title>
+
<para>
- <command>DROP SCHEMA</command> removes schemas from the data base.
+ <command>DROP SCHEMA</command> removes schemas from the database.
</para>
<para>
@@ -116,54 +32,98 @@ ERROR: Schema "<replaceable class="parameter">name</replaceable>" does not exist
the owner can drop the schema (and thereby all contained objects)
even if he does not own some of the objects within the schema.
</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Parameters</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><replaceable class="PARAMETER">name</replaceable></term>
+ <listitem>
+ <para>
+ The name of a schema.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>CASCADE</literal></term>
+ <listitem>
+ <para>
+ Automatically drop objects (tables, functions, etc.) that are
+ contained in the schema.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>RESTRICT</literal></term>
+ <listitem>
+ <para>
+ Refuse to drop the schema if it contains any objects. This is
+ the default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><computeroutput>DROP SCHEMA</computeroutput></term>
+ <listitem>
+ <para>
+ Message returned if the schema was successfully dropped.
+ </para>
+ </listitem>
+ </varlistentry>
- <refsect2 id="R2-SQL-DROPSCHEMA-3">
- <refsect2info>
- <date>2002-07-18</date>
- </refsect2info>
- <title>
- Notes
- </title>
- <para>
- Refer to the <command>CREATE SCHEMA</command> statement for
- information on how to create a schema.
- </para>
- </refsect2>
+ <varlistentry>
+ <term><computeroutput>ERROR: Schema "<replaceable class="parameter">name</replaceable>" does not exist</computeroutput></term>
+ <listitem>
+ <para>
+ This message is returned if the specified schema does not exist.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
- <refsect1 id="R1-SQL-DROPSCHEMA-2">
- <title>
- Usage
- </title>
+ <refsect1>
+ <title>Examples</title>
+
<para>
To remove schema <literal>mystuff</literal> from the database,
along with everything it contains:
- <programlisting>
+<programlisting>
DROP SCHEMA mystuff CASCADE;
- </programlisting>
+</programlisting>
</para>
</refsect1>
- <refsect1 id="R1-SQL-DROPSCHEMA-3">
- <title>
- Compatibility
- </title>
+ <refsect1>
+ <title>Compatibility</title>
- <refsect2 id="R2-SQL-DROPSCHEMA-4">
- <refsect2info>
- <date>2002-07-18</date>
- </refsect2info>
- <title>
- SQL92
- </title>
- <para>
- <command>DROP SCHEMA</command> is fully compatible with
- <acronym>SQL92</acronym>, except that the standard only allows
- one schema to be dropped per command.
- </para>
- </refsect2>
+ <para>
+ <command>DROP SCHEMA</command> is fully conforming with the SQL
+ standard, except that the standard only allows one schema to be
+ dropped per command.
+ </para>
</refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <simplelist type="inline">
+ <member><xref linkend="sql-createschema" endterm="sql-createschema-title"></member>
+ </simplelist>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file