Help Center/ GaussDB(DWS)/ SQL Syntax Reference/ SQL Syntax Reference (9.1.0.x)/ DDL Syntax/ CREATE TEXT SEARCH CONFIGURATION
Updated on 2025-07-22 GMT+08:00
View PDF
Share

CREATE TEXT SEARCH CONFIGURATION

Function

CREATE TEXT SEARCH CONFIGURATION creates a 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.

Precautions

  • 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 ALTER TEXT SEARCH CONFIGURATION commands must be used to create mappings to make the configuration useful. If COPY option is specified, the parser, mapping and configuration option of text search configuration is copied automatically.
  • If a schema name is specified, the text search configuration is created in the specified schema. Otherwise, the text search configuration is created in the current schema.
  • The user who defines a text search configuration becomes its owner.
  • PARSER and COPY options are mutually exclusive, because when an existing configuration is copied, its parser configuration is also copied.

Syntax

1
2
3
 
CREATE TEXT SEARCH CONFIGURATION name 
    ( PARSER = parser_name | COPY = source_config )
    [ WITH ( {configuration_option = value} [, ...] )];

Parameter Description

Table 1 CREATE TEXT SEARCH CONFIGURATION parameters

Parameter

Description

Value Range

name

Specifies the name (optionally schema-qualified) of the text search configuration to be created.

A string, which must comply with the naming convention.

parser_name

Specifies the name of the text search parser to use for this configuration.

-

source_config

Specifies the name of an existing text search configuration to copy.

-

configuration_option

Specifies the configuration parameter of text search configuration is mainly for the parser executed by parser_name or contained by source_config.

Currently, the default, ngram, and zhparser parsers are supported.

  • The parser of the default type does not have the corresponding configuration_option.
  • For details about the configuration_option of the ngram and zhparser parsers, see Table 2.
Table 2 Configuration parameters for ngram and zhparser parsers

Parser

Parameters for adding an account

Description

Value Range

ngram

gram_size

Length of word segmentation

Integer, 1 to 4

Default value: 2

punctuation_ignore

Whether to ignore punctuations
  • true (default value): Ignore punctuations.
  • false: Do not ignore punctuations.

grapsymbol_ignore

Whether to ignore graphical characters
  • true: Ignore graphical characters.
  • false (default value): Do not ignore graphical characters.

zhparser

punctuation_ignore

Whether to ignore special characters including punctuations (\r and \n will not be ignored) in the word segmentation result
  • true (default value): Ignore all the special characters including punctuations.
  • false: Do not ignore all the special characters including punctuations.

seg_with_duality

Whether to aggregate segments with duality
  • true: Aggregate segments with duality.
  • false (default value): Do not aggregate segments with duality.

multi_short

Whether to execute long words composite divide
  • true (default value): Execute long words composite divide.
  • false: Do not execute long words composite divide.

multi_duality

Whether to aggregate segments in long words with duality
  • true: Aggregate segments in long words with duality.
  • false (default value): Do not aggregate segments in long words with duality.

multi_zmain

Whether to display key single words individually
  • true: Display key single words individually.
  • false (default value): Do not display key single words individually.

multi_zall

Whether to display all single words individually.
  • true: Display all single words individually.
  • false (default value): Do not display all single words individually.

Examples

Create a text search configuration named ngram1 using the ngram parser.

1
 
CREATE TEXT SEARCH CONFIGURATION ngram1 (parser=ngram) WITH (gram_size = 2, grapsymbol_ignore = false);

Create a text search configuration named ngram2 and copy all parameters of the existing configuration ngram1.

1
 
CREATE TEXT SEARCH CONFIGURATION ngram2 (copy=ngram1);

Create a text search configuration named english_1 and use the default text parser.

1
 
CREATE TEXT SEARCH CONFIGURATION english_1 (parser=default);

Helpful Links

ALTER TEXT SEARCH CONFIGURATION, DROP TEXT SEARCH CONFIGURATION

Parent Topic: DDL Syntax