Creating a Text Configuration Object

Create a text configuration for use with a text index.

Prerequisites
Database Version Text Configuration Object Privileges
SAP Sybase IQ 15.3 and 15.4 Text configuration object to be owned by self – Requires RESOURCE authority.

Text configuration object to be owned by any user – Requires DBA authority.

SAP Sybase IQ 16.0 Text configuration object to be owned by self – Requires CREATE TEXT CONFIGURATION system privilege.
Text configuration object to be owned by any user – Requires one of:
  • CREATE ANY TEXT CONFIGURATION system privilege.
  • CREATE ANY OBJECT system privilege.
Also requires one of:
  • ALTER ANY TEXT CONFIGURATION system privilege.
  • ALTER ANY OBJECT system privilege.
Task

For detailed information on stoplists, in the SAP Sybase IQ documentation, see SAP Sybase IQ Unstructured Data Analytics > TEXT Indexes and Text Configuration Objects > Text Configuration Objects > Text Configuration Object Settings > Stoplist Setting (STOPLIST).

  1. In the Perspective Resources view, select the resource and select Resource > Administration Console.
  2. In the left pane, select IQ Servers > Schema Objects > Text Configuration Objects.
  3. Click the arrow next to Text Configuration Objects and select New.
    The Create Text Configuration Wizard appears.
  4. On the Text Configuration Name page, specify
    Option Description
    Select a resource for which the text configuration will be created From the list, select the resource for which the text configuration object will be created.
    Which user do you want to own the text configuration object? From the list, select the user to own the text configuration object.
    What do you want to name the view? Enter a unique name for the new text configuration object; maximum of 128 characters.
    For which database collation will this text configuration object be used Each database has a CHAR collation and an NCHAR collation, configured when the database is created. Valid choices are:

    ISO_BINENG – Binary ordering, English ISO/ASCII 7-bit letter case mappings

    UCA – Standard default Unicode Collation Algorithm collation

    Default value is ISO_BINENG.

    (Optional) Comment Specify an option comment for the text configuration object.
  5. Click Next.
  6. On the Choose the Term Breaker page, specify:
    Option Description
    Which term breaker algorithm should be used? Select Generic or N-gram.
    What is the minimum term length? For Generic - Valid range is 1-60. Default value is 1.

    For N-gram - Not available.

    What is the maximum term length? For Generic - Valid range is 1-60. Default value is 20.

    For N-gram - Valid range is 1-60. Default value is 4.

    Use an external term breaker? If you chose the database collation ISO_BINENG and Generic term breaker algorithm, you can specify an external library function to break the text into terms, using one of these formats:
    • function-name@library-file-name
    • Windows-function-name@library-file-name.dll
    • UNIX:UNIX-function-name@library-file-name.so
  7. Click Next.
  8. (Available for ISO_BINENG database collation only) On the Specify an Option Prefilter page, select Use an external prefilter if required and specify the external prefilter function and library.
  9. Click Next.
  10. On the Specify the Stoplist page, indicate the terms to be ignored when building a text index.
  11. (Optional) If you chose the Generic term breaker algorithm, you can specify an external library function to break the text into terms. Use one of these formats:
    • function-name@library-file-name
    • Windows-function-name@library-file-name.dll
    • UNIX:UNIX-function-name@library-file-name.so
  12. (Optional; available only for CHAR collations) Specify an external library to perform document filtering before term breaker processing.
  13. (Optional) Create a stoplist by entering terms to omit from the text index. (Terms in the stoplist are also ignored in queries.) Separate terms with spaces.
    Many non-alphanumeric characters are ignored in stoplists; others (including spaces, apostrophes, and dashes) are interpreted as term delimiters. Consequently, including contractions and hyphenated terms may lead to undesirable results, even when you enclose the terms in quotes. How the stoplist is parsed depends on the term breaker and term lengths you specified in step 6.
  14. Click Finish.
Next
Create a text index that uses your new text configuration.
Related tasks
Deleting a Text Configuration Object
Generating Text Configuration Object DDL Commands
Viewing or Modifying Text Configuration Object Properties
Authenticating a Login Account for a Managed Resource
Related reference
Text Configuration Privilege Summary