← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/src/sgml/man7/CREATE_TEXT_SEARCH_PARSER.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/CREATE_TEXT_SEARCH_PARSER.7
 
1
'\" t
 
2
.\"     Title: CREATE TEXT SEARCH PARSER
 
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 "CREATE TEXT SEARCH PARSER" "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
CREATE_TEXT_SEARCH_PARSER \- define a new text search parser
 
23
.\" CREATE TEXT SEARCH PARSER
 
24
.SH "SYNOPSIS"
 
25
.sp
 
26
.nf
 
27
CREATE TEXT SEARCH PARSER \fIname\fR (
 
28
    START = \fIstart_function\fR ,
 
29
    GETTOKEN = \fIgettoken_function\fR ,
 
30
    END = \fIend_function\fR ,
 
31
    LEXTYPES = \fIlextypes_function\fR
 
32
    [, HEADLINE = \fIheadline_function\fR ]
 
33
)
 
34
.fi
 
35
.SH "DESCRIPTION"
 
36
.PP
 
37
CREATE TEXT SEARCH PARSER
 
38
creates a new text search parser\&. A text search parser defines a method for splitting a text string into tokens and assigning types (categories) to the tokens\&. A parser is not particularly useful by itself, but must be bound into a text search configuration along with some text search dictionaries to be used for searching\&.
 
39
.PP
 
40
If a schema name is given then the text search parser is created in the specified schema\&. Otherwise it is created in the current schema\&.
 
41
.PP
 
42
You must be a superuser to use
 
43
CREATE TEXT SEARCH PARSER\&. (This restriction is made because an erroneous text search parser definition could confuse or even crash the server\&.)
 
44
.PP
 
45
Refer to
 
46
Chapter 12, Full Text Search, in the documentation
 
47
for further information\&.
 
48
.SH "PARAMETERS"
 
49
.PP
 
50
\fIname\fR
 
51
.RS 4
 
52
The name of the text search parser to be created\&. The name can be schema\-qualified\&.
 
53
.RE
 
54
.PP
 
55
\fIstart_function\fR
 
56
.RS 4
 
57
The name of the start function for the parser\&.
 
58
.RE
 
59
.PP
 
60
\fIgettoken_function\fR
 
61
.RS 4
 
62
The name of the get\-next\-token function for the parser\&.
 
63
.RE
 
64
.PP
 
65
\fIend_function\fR
 
66
.RS 4
 
67
The name of the end function for the parser\&.
 
68
.RE
 
69
.PP
 
70
\fIlextypes_function\fR
 
71
.RS 4
 
72
The name of the lextypes function for the parser (a function that returns information about the set of token types it produces)\&.
 
73
.RE
 
74
.PP
 
75
\fIheadline_function\fR
 
76
.RS 4
 
77
The name of the headline function for the parser (a function that summarizes a set of tokens)\&.
 
78
.RE
 
79
.PP
 
80
The function names can be schema\-qualified if necessary\&. Argument types are not given, since the argument list for each type of function is predetermined\&. All except the headline function are required\&.
 
81
.PP
 
82
The arguments can appear in any order, not only the one shown above\&.
 
83
.SH "COMPATIBILITY"
 
84
.PP
 
85
There is no
 
86
CREATE TEXT SEARCH PARSER
 
87
statement in the SQL standard\&.
 
88
.SH "SEE ALSO"
 
89
ALTER TEXT SEARCH PARSER (\fBALTER_TEXT_SEARCH_PARSER\fR(7)), DROP TEXT SEARCH PARSER (\fBDROP_TEXT_SEARCH_PARSER\fR(7))