doc/src/sgml/ref/drop_tstemplate.sgml

   1 <!--
   2 doc/src/sgml/ref/drop_tstemplate.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="sql-droptstemplate">
   7  <indexterm zone="sql-droptstemplate">
   8   <primary>DROP TEXT SEARCH TEMPLATE</primary>
   9  </indexterm>
  10
  11  <refmeta>
  12   <refentrytitle>DROP TEXT SEARCH TEMPLATE</refentrytitle>
  13   <manvolnum>7</manvolnum>
  14   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname>DROP TEXT SEARCH TEMPLATE</refname>
  19   <refpurpose>remove a text search template</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 DROP TEXT SEARCH TEMPLATE [ IF EXISTS ] <replaceable class="parameter">name</replaceable> [ CASCADE | RESTRICT ]
  25 </synopsis>
  26  </refsynopsisdiv>
  27
  28  <refsect1>
  29   <title>Description</title>
  30
  31   <para>
  32    <command>DROP TEXT SEARCH TEMPLATE</command> drops an existing text search
  33    template.  You must be a superuser to use this command.
  34   </para>
  35  </refsect1>
  36
  37  <refsect1>
  38   <title>Parameters</title>
  39
  40   <variablelist>
  41
  42    <varlistentry>
  43     <term><literal>IF EXISTS</literal></term>
  44     <listitem>
  45      <para>
  46       Do not throw an error if the text search template does not exist.
  47       A notice is issued in this case.
  48      </para>
  49     </listitem>
  50    </varlistentry>
  51
  52    <varlistentry>
  53     <term><replaceable class="parameter">name</replaceable></term>
  54     <listitem>
  55      <para>
  56       The name (optionally schema-qualified) of an existing text search
  57       template.
  58      </para>
  59     </listitem>
  60    </varlistentry>
  61
  62    <varlistentry>
  63     <term><literal>CASCADE</literal></term>
  64     <listitem>
  65      <para>
  66       Automatically drop objects that depend on the text search template,
  67       and in turn all objects that depend on those objects
  68       (see <xref linkend="ddl-depend"/>).
  69      </para>
  70     </listitem>
  71    </varlistentry>
  72
  73    <varlistentry>
  74     <term><literal>RESTRICT</literal></term>
  75     <listitem>
  76      <para>
  77       Refuse to drop the text search template if any objects depend on it.
  78       This is the default.
  79      </para>
  80     </listitem>
  81    </varlistentry>
  82   </variablelist>
  83  </refsect1>
  84
  85  <refsect1>
  86   <title>Examples</title>
  87
  88   <para>
  89    Remove the text search template <literal>thesaurus</literal>:
  90
  91 <programlisting>
  92 DROP TEXT SEARCH TEMPLATE thesaurus;
  93 </programlisting>
  94
  95    This command will not succeed if there are any existing text search
  96    dictionaries that use the template.  Add <literal>CASCADE</literal> to
  97    drop such dictionaries along with the template.
  98   </para>
  99  </refsect1>
 100
 101  <refsect1>
 102   <title>Compatibility</title>
 103
 104   <para>
 105    There is no <command>DROP TEXT SEARCH TEMPLATE</command> statement in the
 106    SQL standard.
 107   </para>
 108  </refsect1>
 109
 110  <refsect1>
 111   <title>See Also</title>
 112
 113   <simplelist type="inline">
 114    <member><xref linkend="sql-altertstemplate"/></member>
 115    <member><xref linkend="sql-createtstemplate"/></member>
 116   </simplelist>
 117  </refsect1>
 118
 119 </refentry>