summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/ref/create_tsdictionary.sgml
blob: 0608104821074d10dd7fef7a79c7a3b178a7569b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!--
doc/src/sgml/ref/create_tsdictionary.sgml
PostgreSQL documentation
-->

<refentry id="sql-createtsdictionary">
 <indexterm zone="sql-createtsdictionary">
  <primary>CREATE TEXT SEARCH DICTIONARY</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>CREATE TEXT SEARCH DICTIONARY</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>CREATE TEXT SEARCH DICTIONARY</refname>
  <refpurpose>define a new text search dictionary</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
CREATE TEXT SEARCH DICTIONARY <replaceable class="parameter">name</replaceable> (
    TEMPLATE = <replaceable class="parameter">template</replaceable>
    [, <replaceable class="parameter">option</replaceable> = <replaceable class="parameter">value</replaceable> [, ... ]]
)
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>CREATE TEXT SEARCH DICTIONARY</command> creates a new text search
   dictionary.  A text search dictionary specifies a way of recognizing
   interesting or uninteresting words for searching.  A dictionary depends
   on a text search template, which specifies the functions that actually
   perform the work.  Typically the dictionary provides some options that
   control the detailed behavior of the template's functions.
  </para>

  <para>
   If a schema name is given then the text search dictionary is created in the
   specified schema.  Otherwise it is created in the current schema.
  </para>

  <para>
   The user who defines a text search dictionary becomes its owner.
  </para>

  <para>
   Refer to <xref linkend="textsearch"/> for further information.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><replaceable class="parameter">name</replaceable></term>
    <listitem>
     <para>
      The name of the text search dictionary to be created.  The name can be
      schema-qualified.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">template</replaceable></term>
    <listitem>
     <para>
      The name of the text search template that will define the basic
      behavior of this dictionary.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">option</replaceable></term>
    <listitem>
     <para>
      The name of a template-specific option to be set for this dictionary.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">value</replaceable></term>
    <listitem>
     <para>
      The value to use for a template-specific option.  If the value
      is not a simple identifier or number, it must be quoted (but you can
      always quote it, if you wish).
     </para>
    </listitem>
   </varlistentry>
  </variablelist>

  <para>
   The options can appear in any order.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   The following example command creates a Snowball-based dictionary
   with a nonstandard list of stop words.
  </para>

<programlisting>
CREATE TEXT SEARCH DICTIONARY my_russian (
    template = snowball,
    language = russian,
    stopwords = myrussian
);
</programlisting>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>

  <para>
   There is no <command>CREATE TEXT SEARCH DICTIONARY</command> statement in
   the SQL standard.
  </para>
 </refsect1>

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

  <simplelist type="inline">
   <member><xref linkend="sql-altertsdictionary"/></member>
   <member><xref linkend="sql-droptsdictionary"/></member>
  </simplelist>
 </refsect1>
</refentry>