diff options
Diffstat (limited to 'doc/src/sgml/ref/alter_tsconfig.sgml')
| -rw-r--r-- | doc/src/sgml/ref/alter_tsconfig.sgml | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/alter_tsconfig.sgml b/doc/src/sgml/ref/alter_tsconfig.sgml new file mode 100644 index 0000000..ebe0b94 --- /dev/null +++ b/doc/src/sgml/ref/alter_tsconfig.sgml @@ -0,0 +1,189 @@ +<!-- +doc/src/sgml/ref/alter_tsconfig.sgml +PostgreSQL documentation +--> + +<refentry id="sql-altertsconfig"> + <indexterm zone="sql-altertsconfig"> + <primary>ALTER TEXT SEARCH CONFIGURATION</primary> + </indexterm> + + <refmeta> + <refentrytitle>ALTER TEXT SEARCH CONFIGURATION</refentrytitle> + <manvolnum>7</manvolnum> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>ALTER TEXT SEARCH CONFIGURATION</refname> + <refpurpose>change the definition of a text search configuration</refpurpose> + </refnamediv> + + <refsynopsisdiv> +<synopsis> +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> + ADD MAPPING FOR <replaceable class="parameter">token_type</replaceable> [, ... ] WITH <replaceable class="parameter">dictionary_name</replaceable> [, ... ] +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> + ALTER MAPPING FOR <replaceable class="parameter">token_type</replaceable> [, ... ] WITH <replaceable class="parameter">dictionary_name</replaceable> [, ... ] +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> + ALTER MAPPING REPLACE <replaceable class="parameter">old_dictionary</replaceable> WITH <replaceable class="parameter">new_dictionary</replaceable> +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> + ALTER MAPPING FOR <replaceable class="parameter">token_type</replaceable> [, ... ] REPLACE <replaceable class="parameter">old_dictionary</replaceable> WITH <replaceable class="parameter">new_dictionary</replaceable> +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> + DROP MAPPING [ IF EXISTS ] FOR <replaceable class="parameter">token_type</replaceable> [, ... ] +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable> +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> OWNER TO { <replaceable>new_owner</replaceable> | CURRENT_USER | SESSION_USER } +ALTER TEXT SEARCH CONFIGURATION <replaceable>name</replaceable> SET SCHEMA <replaceable>new_schema</replaceable> +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <command>ALTER TEXT SEARCH CONFIGURATION</command> changes the definition of + a text search configuration. You can modify + its mappings from token types to dictionaries, + or change the configuration's name or owner. + </para> + + <para> + You must be the owner of the configuration to use + <command>ALTER TEXT SEARCH CONFIGURATION</command>. + </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 + configuration. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">token_type</replaceable></term> + <listitem> + <para> + The name of a token type that is emitted by the configuration's + parser. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">dictionary_name</replaceable></term> + <listitem> + <para> + The name of a text search dictionary to be consulted for the + specified token type(s). If multiple dictionaries are listed, + they are consulted in the specified order. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">old_dictionary</replaceable></term> + <listitem> + <para> + The name of a text search dictionary to be replaced in the mapping. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">new_dictionary</replaceable></term> + <listitem> + <para> + The name of a text search dictionary to be substituted for + <replaceable class="parameter">old_dictionary</replaceable>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">new_name</replaceable></term> + <listitem> + <para> + The new name of the text search configuration. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">new_owner</replaceable></term> + <listitem> + <para> + The new owner of the text search configuration. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">new_schema</replaceable></term> + <listitem> + <para> + The new schema for the text search configuration. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + The <literal>ADD MAPPING FOR</literal> form installs a list of dictionaries to be + consulted for the specified token type(s); it is an error if there is + already a mapping for any of the token types. + The <literal>ALTER MAPPING FOR</literal> form does the same, but first removing + any existing mapping for those token types. + The <literal>ALTER MAPPING REPLACE</literal> forms substitute <replaceable + class="parameter">new_dictionary</replaceable> for <replaceable + class="parameter">old_dictionary</replaceable> anywhere the latter appears. + This is done for only the specified token types when <literal>FOR</literal> + appears, or for all mappings of the configuration when it doesn't. + The <literal>DROP MAPPING</literal> form removes all dictionaries for the + specified token type(s), causing tokens of those types to be ignored + by the text search configuration. It is an error if there is no mapping + for the token types, unless <literal>IF EXISTS</literal> appears. + </para> + + </refsect1> + + <refsect1> + <title>Examples</title> + + <para> + The following example replaces the <literal>english</literal> dictionary + with the <literal>swedish</literal> dictionary anywhere that <literal>english</literal> + is used within <literal>my_config</literal>. + </para> + +<programlisting> +ALTER TEXT SEARCH CONFIGURATION my_config + ALTER MAPPING REPLACE english WITH swedish; +</programlisting> + </refsect1> + + <refsect1> + <title>Compatibility</title> + + <para> + There is no <command>ALTER TEXT SEARCH CONFIGURATION</command> statement in + the SQL standard. + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <simplelist type="inline"> + <member><xref linkend="sql-createtsconfig"/></member> + <member><xref linkend="sql-droptsconfig"/></member> + </simplelist> + </refsect1> +</refentry> |