postgresql/doc/src/sgml/ref/drop_tstemplate.sgml

120 lines
2.8 KiB
Plaintext

<!--
doc/src/sgml/ref/drop_tstemplate.sgml
PostgreSQL documentation
-->
<refentry id="sql-droptstemplate">
<indexterm zone="sql-droptstemplate">
<primary>DROP TEXT SEARCH TEMPLATE</primary>
</indexterm>
<refmeta>
<refentrytitle>DROP TEXT SEARCH TEMPLATE</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DROP TEXT SEARCH TEMPLATE</refname>
<refpurpose>remove a text search template</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
DROP TEXT SEARCH TEMPLATE [ IF EXISTS ] <replaceable class="parameter">name</replaceable> [ CASCADE | RESTRICT ]
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>DROP TEXT SEARCH TEMPLATE</command> drops an existing text search
template. You must be a superuser to use this command.
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><literal>IF EXISTS</literal></term>
<listitem>
<para>
Do not throw an error if the text search template does not exist.
A notice is issued in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of an existing text search
template.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>CASCADE</literal></term>
<listitem>
<para>
Automatically drop objects that depend on the text search template,
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 text search template if any objects depend on it.
This is the default.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Remove the text search template <literal>thesaurus</literal>:
<programlisting>
DROP TEXT SEARCH TEMPLATE thesaurus;
</programlisting>
This command will not succeed if there are any existing text search
dictionaries that use the template. Add <literal>CASCADE</literal> to
drop such dictionaries along with the template.
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
There is no <command>DROP TEXT SEARCH TEMPLATE</command> statement in the
SQL standard.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-altertstemplate"/></member>
<member><xref linkend="sql-createtstemplate"/></member>
</simplelist>
</refsect1>
</refentry>