doc/src/sgml/ref/drop_tstemplate.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DROPTSTEMPLATE">
   7  <refmeta>
   8   <refentrytitle id="SQL-DROPTSTEMPLATE-TITLE">DROP TEXT SEARCH TEMPLATE</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>DROP TEXT SEARCH TEMPLATE</refname>
  15   <refpurpose>remove a text search template</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-droptstemplate">
  19   <primary>DROP TEXT SEARCH TEMPLATE</primary>
  20  </indexterm>
  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      </para>
  68     </listitem>
  69    </varlistentry>
  70
  71    <varlistentry>
  72     <term><literal>RESTRICT</literal></term>
  73     <listitem>
  74      <para>
  75       Refuse to drop the text search template if any objects depend on it.
  76       This is the default.
  77      </para>
  78     </listitem>
  79    </varlistentry>
  80   </variablelist>
  81  </refsect1>
  82
  83  <refsect1>
  84   <title>Examples</title>
  85
  86   <para>
  87    Remove the text search template <literal>thesaurus</literal>:
  88
  89 <programlisting>
  90 DROP TEXT SEARCH TEMPLATE thesaurus;
  91 </programlisting>
  92
  93    This command will not succeed if there are any existing text search
  94    dictionaries that use the template.  Add <literal>CASCADE</> to
  95    drop such dictionaries along with the template.
  96   </para>
  97  </refsect1>
  98
  99  <refsect1>
 100   <title>Compatibility</title>
 101
 102   <para>
 103    There is no <command>DROP TEXT SEARCH TEMPLATE</command> statement in the
 104    SQL standard.
 105   </para>
 106  </refsect1>
 107
 108  <refsect1>
 109   <title>See Also</title>
 110
 111   <simplelist type="inline">
 112    <member><xref linkend="sql-altertstemplate" endterm="sql-altertstemplate-title"></member>
 113    <member><xref linkend="sql-createtstemplate" endterm="sql-createtstemplate-title"></member>
 114   </simplelist>
 115  </refsect1>
 116
 117 </refentry>