← Back to branch summary

~ubuntu-branches/ubuntu/precise/postgresql-9.1/precise-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/man7/ALTER_TEXT_SEARCH_CONFIGURATION.7

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/man7/ALTER_TEXT_SEARCH_CONFIGURATION.7
 
1
'\" t
 
2
.\"     Title: ALTER TEXT SEARCH CONFIGURATION
 
3
.\"    Author: The PostgreSQL Global Development Group
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
 
5
.\"      Date: 2011-04-27
 
6
.\"    Manual: PostgreSQL 9.1beta1 Documentation
 
7
.\"    Source: PostgreSQL 9.1beta1
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "ALTER TEXT SEARCH CONFIGURATION" "7" "2011-04-27" "PostgreSQL 9.1beta1" "PostgreSQL 9.1beta1 Documentation"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
 
22
ALTER_TEXT_SEARCH_CONFIGURATION \- change the definition of a text search configuration
 
23
.\" ALTER TEXT SEARCH CONFIGURATION
 
24
.SH "SYNOPSIS"
 
25
.sp
 
26
.nf
 
27
ALTER TEXT SEARCH CONFIGURATION \fIname\fR
 
28
    ADD MAPPING FOR \fItoken_type\fR [, \&.\&.\&. ] WITH \fIdictionary_name\fR [, \&.\&.\&. ]
 
29
ALTER TEXT SEARCH CONFIGURATION \fIname\fR
 
30
    ALTER MAPPING FOR \fItoken_type\fR [, \&.\&.\&. ] WITH \fIdictionary_name\fR [, \&.\&.\&. ]
 
31
ALTER TEXT SEARCH CONFIGURATION \fIname\fR
 
32
    ALTER MAPPING REPLACE \fIold_dictionary\fR WITH \fInew_dictionary\fR
 
33
ALTER TEXT SEARCH CONFIGURATION \fIname\fR
 
34
    ALTER MAPPING FOR \fItoken_type\fR [, \&.\&.\&. ] REPLACE \fIold_dictionary\fR WITH \fInew_dictionary\fR
 
35
ALTER TEXT SEARCH CONFIGURATION \fIname\fR
 
36
    DROP MAPPING [ IF EXISTS ] FOR \fItoken_type\fR [, \&.\&.\&. ]
 
37
ALTER TEXT SEARCH CONFIGURATION \fIname\fR RENAME TO \fInew_name\fR
 
38
ALTER TEXT SEARCH CONFIGURATION \fIname\fR OWNER TO \fInew_owner\fR
 
39
ALTER TEXT SEARCH CONFIGURATION \fIname\fR SET SCHEMA \fInew_schema\fR
 
40
.fi
 
41
.SH "DESCRIPTION"
 
42
.PP
 
43
ALTER TEXT SEARCH CONFIGURATION
 
44
changes the definition of a text search configuration\&. You can modify its mappings from token types to dictionaries, or change the configuration\(aqs name or owner\&.
 
45
.PP
 
46
You must be the owner of the configuration to use
 
47
ALTER TEXT SEARCH CONFIGURATION\&.
 
48
.SH "PARAMETERS"
 
49
.PP
 
50
\fIname\fR
 
51
.RS 4
 
52
The name (optionally schema\-qualified) of an existing text search configuration\&.
 
53
.RE
 
54
.PP
 
55
\fItoken_type\fR
 
56
.RS 4
 
57
The name of a token type that is emitted by the configuration\(aqs parser\&.
 
58
.RE
 
59
.PP
 
60
\fIdictionary_name\fR
 
61
.RS 4
 
62
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\&.
 
63
.RE
 
64
.PP
 
65
\fIold_dictionary\fR
 
66
.RS 4
 
67
The name of a text search dictionary to be replaced in the mapping\&.
 
68
.RE
 
69
.PP
 
70
\fInew_dictionary\fR
 
71
.RS 4
 
72
The name of a text search dictionary to be substituted for
 
73
\fIold_dictionary\fR\&.
 
74
.RE
 
75
.PP
 
76
\fInew_name\fR
 
77
.RS 4
 
78
The new name of the text search configuration\&.
 
79
.RE
 
80
.PP
 
81
\fInew_owner\fR
 
82
.RS 4
 
83
The new owner of the text search configuration\&.
 
84
.RE
 
85
.PP
 
86
\fInew_schema\fR
 
87
.RS 4
 
88
The new schema for the text search configuration\&.
 
89
.RE
 
90
.PP
 
91
The
 
92
ADD MAPPING FOR
 
93
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
 
94
ALTER MAPPING FOR
 
95
form does the same, but first removing any existing mapping for those token types\&. The
 
96
ALTER MAPPING REPLACE
 
97
forms substitute
 
98
\fInew_dictionary\fR
 
99
for
 
100
\fIold_dictionary\fR
 
101
anywhere the latter appears\&. This is done for only the specified token types when
 
102
FOR
 
103
appears, or for all mappings of the configuration when it doesn\(aqt\&. The
 
104
DROP MAPPING
 
105
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
 
106
IF EXISTS
 
107
appears\&.
 
108
.SH "EXAMPLES"
 
109
.PP
 
110
The following example replaces the
 
111
english
 
112
dictionary with the
 
113
swedish
 
114
dictionary anywhere that
 
115
english
 
116
is used within
 
117
my_config\&.
 
118
.sp
 
119
.if n \{\
 
120
.RS 4
 
121
.\}
 
122
.nf
 
123
ALTER TEXT SEARCH CONFIGURATION my_config
 
124
  ALTER MAPPING REPLACE english WITH swedish;
 
125
.fi
 
126
.if n \{\
 
127
.RE
 
128
.\}
 
129
.SH "COMPATIBILITY"
 
130
.PP
 
131
There is no
 
132
ALTER TEXT SEARCH CONFIGURATION
 
133
statement in the SQL standard\&.
 
134
.SH "SEE ALSO"
 
135
CREATE TEXT SEARCH CONFIGURATION (\fBCREATE_TEXT_SEARCH_CONFIGURATION\fR(7)), DROP TEXT SEARCH CONFIGURATION (\fBDROP_TEXT_SEARCH_CONFIGURATION\fR(7))