doc/src/sgml/ref/drop_collation.sgml - master - githubmirror/postgres

doc/src/sgml/ref/drop_collation.sgml
114 строк3 KB
Bruce Momjian
doc: make ref/*.sgml file header comment layout consistent
15 май 2020, 15:52
15 май 2020, 15:528d4b23f
<!--
doc/src/sgml/ref/drop_collation.sgml
PostgreSQL documentation
-->

<refentry id="sql-dropcollation">
 <indexterm zone="sql-dropcollation">
  <primary>DROP COLLATION</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>DROP COLLATION</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>DROP COLLATION</refname>
  <refpurpose>remove a collation</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
DROP COLLATION [ IF EXISTS ] <replaceable>name</replaceable> [ CASCADE | RESTRICT ]
</synopsis>
 </refsynopsisdiv>

 <refsect1 id="sql-dropcollation-description">
  <title>Description</title>

  <para>
   <command>DROP COLLATION</command> removes a previously defined collation.
   To be able to drop a collation, you must own the collation.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

   <variablelist>
    <varlistentry>
     <term><literal>IF EXISTS</literal></term>
     <listitem>
      <para>
       Do not throw an error if the collation does not exist.
       A notice is issued in this case.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><replaceable>name</replaceable></term>

     <listitem>
      <para>
       The name of the collation. The collation name can be
       schema-qualified.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>CASCADE</literal></term>
     <listitem>
      <para>
       Automatically drop objects that depend on the collation,
       and in turn all objects that depend on those objects
       (see <xref linkend="ddl-depend"/>).
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>RESTRICT</literal></term>
     <listitem>
      <para>
       Refuse to drop the collation if any objects depend on it.  This
       is the default.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>

 <refsect1 id="sql-dropcollation-examples">
  <title>Examples</title>

  <para>
   To drop the collation named <literal>german</literal>:
<programlisting>
DROP COLLATION german;
</programlisting></para>
 </refsect1>

 <refsect1 id="sql-dropcollation-compat">
  <title>Compatibility</title>

  <para>
   The <command>DROP COLLATION</command> command conforms to the
   <acronym>SQL</acronym> standard, apart from the <literal>IF
   EXISTS</literal> option, which is a <productname>PostgreSQL</productname> extension.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-altercollation"/></member>
   <member><xref linkend="sql-createcollation"/></member>
  </simplelist>
 </refsect1>

</refentry>