diff options
Diffstat (limited to 'doc/src/sgml/ref/alter_tsdictionary.sgml')
-rw-r--r-- | doc/src/sgml/ref/alter_tsdictionary.sgml | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/alter_tsdictionary.sgml b/doc/src/sgml/ref/alter_tsdictionary.sgml new file mode 100644 index 00000000000..59c33666557 --- /dev/null +++ b/doc/src/sgml/ref/alter_tsdictionary.sgml @@ -0,0 +1,118 @@ +<!-- +$PostgreSQL: pgsql/doc/src/sgml/ref/alter_tsdictionary.sgml,v 1.1 2007/08/21 21:08:47 tgl Exp $ +PostgreSQL documentation +--> + +<refentry id="SQL-ALTERTSDICTIONARY"> + <refmeta> + <refentrytitle id="SQL-ALTERTSDICTIONARY-TITLE">ALTER TEXT SEARCH DICTIONARY</refentrytitle> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>ALTER TEXT SEARCH DICTIONARY</refname> + <refpurpose>change the definition of a text search dictionary</refpurpose> + </refnamediv> + + <indexterm zone="sql-altertsdictionary"> + <primary>ALTER TEXT SEARCH DICTIONARY</primary> + </indexterm> + + <refsynopsisdiv> +<synopsis> +ALTER TEXT SEARCH DICTIONARY <replaceable>name</replaceable> ( OPTION = <replaceable class="parameter">init_options</replaceable> ) +ALTER TEXT SEARCH DICTIONARY <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable> +ALTER TEXT SEARCH DICTIONARY <replaceable>name</replaceable> OWNER TO <replaceable>newowner</replaceable> +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <command>ALTER TEXT SEARCH DICTIONARY</command> changes the definition of + a text search dictionary. You can change the dictionary's initialization + options, or change the dictionary's name or owner. + </para> + + <para> + You must be the owner of the dictionary to use + <command>ALTER TEXT SEARCH DICTIONARY</>. + </para> + </refsect1> + + <refsect1> + <title>Parameters</title> + + <variablelist> + <varlistentry> + <term><replaceable class="parameter">name</replaceable></term> + <listitem> + <para> + The name (optionally schema-qualified) of an existing text search + dictionary. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">init_options</replaceable></term> + <listitem> + <para> + A new list of initialization options, or <literal>NULL</> to + remove all options. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">newname</replaceable></term> + <listitem> + <para> + The new name of the text search dictionary. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">newowner</replaceable></term> + <listitem> + <para> + The new owner of the text search dictionary. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + + <para> + The following example command sets the language and stopword list + for a Snowball-based dictionary. + </para> + +<programlisting> +ALTER TEXT SEARCH DICTIONARY my_russian ( option = 'Language=russian, StopWords=my_russian' ); +</programlisting> + </refsect1> + + <refsect1> + <title>Compatibility</title> + + <para> + There is no <command>ALTER TEXT SEARCH DICTIONARY</command> statement in + the SQL standard. + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <simplelist type="inline"> + <member><xref linkend="sql-createtsdictionary" endterm="sql-createtsdictionary-title"></member> + <member><xref linkend="sql-droptsdictionary" endterm="sql-droptsdictionary-title"></member> + </simplelist> + </refsect1> +</refentry> |