begriffs open source - ai-pg/blob - full-docs/man7/CREATE_TEXT_SEARCH_CONFIGURATION.7

   1 '\" t
   2 .\"     Title: CREATE TEXT SEARCH CONFIGURATION
   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 CONFIGURATION" "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_CONFIGURATION \- define a new text search configuration
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 CREATE TEXT SEARCH CONFIGURATION \fIname\fR (
  36     PARSER = \fIparser_name\fR |
  37     COPY = \fIsource_config\fR
  38 )
  39 .fi
  40 .SH "DESCRIPTION"
  41 .PP
  42 \fBCREATE TEXT SEARCH CONFIGURATION\fR
  43 creates a new text search configuration\&. A text search configuration specifies a text search parser that can divide a string into tokens, plus dictionaries that can be used to determine which tokens are of interest for searching\&.
  44 .PP
  45 If only the parser is specified, then the new text search configuration initially has no mappings from token types to dictionaries, and therefore will ignore all words\&. Subsequent
  46 \fBALTER TEXT SEARCH CONFIGURATION\fR
  47 commands must be used to create mappings to make the configuration useful\&. Alternatively, an existing text search configuration can be copied\&.
  48 .PP
  49 If a schema name is given then the text search configuration is created in the specified schema\&. Otherwise it is created in the current schema\&.
  50 .PP
  51 The user who defines a text search configuration becomes its owner\&.
  52 .PP
  53 Refer to
  54 Chapter\ \&12
  55 for further information\&.
  56 .SH "PARAMETERS"
  57 .PP
  58 \fIname\fR
  59 .RS 4
  60 The name of the text search configuration to be created\&. The name can be schema\-qualified\&.
  61 .RE
  62 .PP
  63 \fIparser_name\fR
  64 .RS 4
  65 The name of the text search parser to use for this configuration\&.
  66 .RE
  67 .PP
  68 \fIsource_config\fR
  69 .RS 4
  70 The name of an existing text search configuration to copy\&.
  71 .RE
  72 .SH "NOTES"
  73 .PP
  74 The
  75 PARSER
  76 and
  77 COPY
  78 options are mutually exclusive, because when an existing configuration is copied, its parser selection is copied too\&.
  79 .SH "COMPATIBILITY"
  80 .PP
  81 There is no
  82 \fBCREATE TEXT SEARCH CONFIGURATION\fR
  83 statement in the SQL standard\&.
  84 .SH "SEE ALSO"
  85 ALTER TEXT SEARCH CONFIGURATION (\fBALTER_TEXT_SEARCH_CONFIGURATION\fR(7)), DROP TEXT SEARCH CONFIGURATION (\fBDROP_TEXT_SEARCH_CONFIGURATION\fR(7))