← Back to branch summary

~ubuntu-branches/debian/sid/postgresql-9.3/sid

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-05-08 05:39:52 UTC
  • Revision ID: package-import@ubuntu.com-20130508053952-1j7uilp7mjtrvq8q
Tags: upstream-9.3~beta1
Import upstream version 9.3~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/man7/ALTER_TEXT_SEARCH_DICTIONARY.7
 
1
'\" t
 
2
.\"     Title: ALTER TEXT SEARCH DICTIONARY
 
3
.\"    Author: The PostgreSQL Global Development Group
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 2013-05-06
 
6
.\"    Manual: PostgreSQL 9.3beta1 Documentation
 
7
.\"    Source: PostgreSQL 9.3beta1
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "ALTER TEXT SEARCH DICTIONARY" "7" "2013-05-06" "PostgreSQL 9.3beta1" "PostgreSQL 9.3beta1 Documentation"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
ALTER_TEXT_SEARCH_DICTIONARY \- change the definition of a text search dictionary
 
32
.\" ALTER TEXT SEARCH DICTIONARY
 
33
.SH "SYNOPSIS"
 
34
.sp
 
35
.nf
 
36
ALTER TEXT SEARCH DICTIONARY \fIname\fR (
 
37
    \fIoption\fR [ = \fIvalue\fR ] [, \&.\&.\&. ]
 
38
)
 
39
ALTER TEXT SEARCH DICTIONARY \fIname\fR RENAME TO \fInew_name\fR
 
40
ALTER TEXT SEARCH DICTIONARY \fIname\fR OWNER TO \fInew_owner\fR
 
41
ALTER TEXT SEARCH DICTIONARY \fIname\fR SET SCHEMA \fInew_schema\fR
 
42
.fi
 
43
.SH "DESCRIPTION"
 
44
.PP
 
45
 
 
46
\fBALTER TEXT SEARCH DICTIONARY\fR
 
47
changes the definition of a text search dictionary\&. You can change the dictionary\*(Aqs template\-specific options, or change the dictionary\*(Aqs name or owner\&.
 
48
.PP
 
49
You must be the owner of the dictionary to use
 
50
\fBALTER TEXT SEARCH DICTIONARY\fR\&.
 
51
.SH "PARAMETERS"
 
52
.PP
 
53
\fIname\fR
 
54
.RS 4
 
55
The name (optionally schema\-qualified) of an existing text search dictionary\&.
 
56
.RE
 
57
.PP
 
58
\fIoption\fR
 
59
.RS 4
 
60
The name of a template\-specific option to be set for this dictionary\&.
 
61
.RE
 
62
.PP
 
63
\fIvalue\fR
 
64
.RS 4
 
65
The new value to use for a template\-specific option\&. If the equal sign and value are omitted, then any previous setting for the option is removed from the dictionary, allowing the default to be used\&.
 
66
.RE
 
67
.PP
 
68
\fInew_name\fR
 
69
.RS 4
 
70
The new name of the text search dictionary\&.
 
71
.RE
 
72
.PP
 
73
\fInew_owner\fR
 
74
.RS 4
 
75
The new owner of the text search dictionary\&.
 
76
.RE
 
77
.PP
 
78
\fInew_schema\fR
 
79
.RS 4
 
80
The new schema for the text search dictionary\&.
 
81
.RE
 
82
.PP
 
83
Template\-specific options can appear in any order\&.
 
84
.SH "EXAMPLES"
 
85
.PP
 
86
The following example command changes the stopword list for a Snowball\-based dictionary\&. Other parameters remain unchanged\&.
 
87
.sp
 
88
.if n \{\
 
89
.RS 4
 
90
.\}
 
91
.nf
 
92
ALTER TEXT SEARCH DICTIONARY my_dict ( StopWords = newrussian );
 
93
.fi
 
94
.if n \{\
 
95
.RE
 
96
.\}
 
97
.PP
 
98
The following example command changes the language option to dutch, and removes the stopword option entirely\&.
 
99
.sp
 
100
.if n \{\
 
101
.RS 4
 
102
.\}
 
103
.nf
 
104
ALTER TEXT SEARCH DICTIONARY my_dict ( language = dutch, StopWords );
 
105
.fi
 
106
.if n \{\
 
107
.RE
 
108
.\}
 
109
.PP
 
110
The following example command
 
111
\(lqupdates\(rq
 
112
the dictionary\*(Aqs definition without actually changing anything\&.
 
113
.sp
 
114
.if n \{\
 
115
.RS 4
 
116
.\}
 
117
.nf
 
118
ALTER TEXT SEARCH DICTIONARY my_dict ( dummy );
 
119
.fi
 
120
.if n \{\
 
121
.RE
 
122
.\}
 
123
.sp
 
124
(The reason this works is that the option removal code doesn\*(Aqt complain if there is no such option\&.) This trick is useful when changing configuration files for the dictionary: the
 
125
\fBALTER\fR
 
126
will force existing database sessions to re\-read the configuration files, which otherwise they would never do if they had read them earlier\&.
 
127
.SH "COMPATIBILITY"
 
128
.PP
 
129
There is no
 
130
\fBALTER TEXT SEARCH DICTIONARY\fR
 
131
statement in the SQL standard\&.
 
132
.SH "SEE ALSO"
 
133
CREATE TEXT SEARCH DICTIONARY (\fBCREATE_TEXT_SEARCH_DICTIONARY\fR(7)), DROP TEXT SEARCH DICTIONARY (\fBDROP_TEXT_SEARCH_DICTIONARY\fR(7))