begriffs open source - ai-pg/blob - full-docs/src/sgml/man7/CREATE_TEXT_SEARCH_DICTIONARY.7

   1 '\" t
   2 .\"     Title: CREATE TEXT SEARCH DICTIONARY
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "CREATE TEXT SEARCH DICTIONARY" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 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 CREATE_TEXT_SEARCH_DICTIONARY \- define a new text search dictionary
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 CREATE TEXT SEARCH DICTIONARY \fIname\fR (
  36     TEMPLATE = \fItemplate\fR
  37     [, \fIoption\fR = \fIvalue\fR [, \&.\&.\&. ]]
  38 )
  39 .fi
  40 .SH "DESCRIPTION"
  41 .PP
  42 \fBCREATE TEXT SEARCH DICTIONARY\fR
  43 creates a new text search dictionary\&. A text search dictionary specifies a way of recognizing interesting or uninteresting words for searching\&. A dictionary depends on a text search template, which specifies the functions that actually perform the work\&. Typically the dictionary provides some options that control the detailed behavior of the template\*(Aqs functions\&.
  44 .PP
  45 If a schema name is given then the text search dictionary is created in the specified schema\&. Otherwise it is created in the current schema\&.
  46 .PP
  47 The user who defines a text search dictionary becomes its owner\&.
  48 .PP
  49 Refer to
  50 Chapter\ \&12
  51 for further information\&.
  52 .SH "PARAMETERS"
  53 .PP
  54 \fIname\fR
  55 .RS 4
  56 The name of the text search dictionary to be created\&. The name can be schema\-qualified\&.
  57 .RE
  58 .PP
  59 \fItemplate\fR
  60 .RS 4
  61 The name of the text search template that will define the basic behavior of this dictionary\&.
  62 .RE
  63 .PP
  64 \fIoption\fR
  65 .RS 4
  66 The name of a template\-specific option to be set for this dictionary\&.
  67 .RE
  68 .PP
  69 \fIvalue\fR
  70 .RS 4
  71 The value to use for a template\-specific option\&. If the value is not a simple identifier or number, it must be quoted (but you can always quote it, if you wish)\&.
  72 .RE
  73 .PP
  74 The options can appear in any order\&.
  75 .SH "EXAMPLES"
  76 .PP
  77 The following example command creates a Snowball\-based dictionary with a nonstandard list of stop words\&.
  78 .sp
  79 .if n \{\
  80 .RS 4
  81 .\}
  82 .nf
  83 CREATE TEXT SEARCH DICTIONARY my_russian (
  84     template = snowball,
  85     language = russian,
  86     stopwords = myrussian
  87 );
  88 .fi
  89 .if n \{\
  90 .RE
  91 .\}
  92 .SH "COMPATIBILITY"
  93 .PP
  94 There is no
  95 \fBCREATE TEXT SEARCH DICTIONARY\fR
  96 statement in the SQL standard\&.
  97 .SH "SEE ALSO"
  98 ALTER TEXT SEARCH DICTIONARY (\fBALTER_TEXT_SEARCH_DICTIONARY\fR(7)), DROP TEXT SEARCH DICTIONARY (\fBDROP_TEXT_SEARCH_DICTIONARY\fR(7))