Debian Codegraph @

doc/src/sgml/ref/drop_tsdictionary.sgml

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