Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming


Working with the Text Extender catalog view

Text Extender creates and maintains a catalog view called DB2TX.TEXTINDEXES for each database . It is created when you run ENABLE DATABASE. It contains information about the tables and columns that are enabled for Text Extender.

New entries are created in DB2TX.TEXTINDEXES whenever a table, a column, or external files are enabled. Entries are updated whenever index settings are modified using the CHANGE INDEX SETTINGS command. Entries are deleted if columns or tables are disabled.

Data in the catalog view is available through normal SQL query facilities. However, you cannot modify the catalog view using normal SQL data manipulation commands. You cannot explicitly create or drop the catalog view. Table 4 shows the contents of the catalog view.

Table 4. Text Extender catalog view
Column name Data type Null- able Description
TABLESCHEMA CHAR(8) No Schema of the table to which this entry applies.
TABLENAME VARCHAR(18) No Name of the table to which this entry applies.
COLUMNNAME VARCHAR(18) Yes Name of a column that has been enabled within this table. This value is null if the table has been enabled, but no column has been enabled.
HANDLENAME VARCHAR(18) Yes Name of a handle column. This value is null if there is no column enabled in the table TABLESCHEMA.TABLENAME.
INDEXNAME CHAR(8) No Name of the text index created during enabling of the text table or a text column.
LOGTABLE VARCHAR(18) No Name of the log table for the index INDEXNAME. The table DB2TX.LOGTABLE contains information about which text documents are scheduled for the next update of the text index, and error events.
INDEXTYPE VARCHAR(30) No Type of index: DUAL, LINGUISTIC, PRECISE, NGRAM.
MINIMUM INTEGER Yes The smallest number of index update requests required before an index update is performed. See Setting the frequency of index updates. This value is null if the update frequency is set to NONE.
DAYS VARCHAR(15) Yes The days when an update is to be scheduled. See Setting the frequency of index updates. This value is null if the update frequency is set to NONE.
HOURS VARCHAR(75) Yes The hours when an index update is to be scheduled. See Setting the frequency of index updates. This value is null if the update frequency is set to NONE.
MINUTES VARCHAR(185) Yes The minutes when an update is scheduled. See Setting the frequency of index updates. This value is null if the update frequency is set to NONE.
INDEXDIRECTORY VARCHAR(254) No Name of the directory where the text index is stored within the file system.
UPDATEONCREATE VARCHAR(10) No The value "update" or "noupdate", whatever has been specified with the UPDATEINDEX option in ENABLE TEXT TABLE or ENABLE TEXT COLUMN, or in the last CHANGE INDEX SETTINGS.
COMMONINDEX VARCHAR(4) No "yes" if the table TABLESCHEMA.TABLENAME is a common-index table. "no" if the table TABLESCHEMA.TABLENAME is a multi-index table.
CCSID SMALLINT Yes CCSID for the text column TEXTCOLUMN specified with the enable text column command. This value is null if TEXTCOLUMN is null.
LANGUAGE VARCHAR(30) Yes The name of the dictionary used when processing text column TEXTCOLUMN. This value is null if TEXTCOLUMN is null.
FORMAT VARCHAR(30) Yes The format specified for text column TEXTCOLUMN. This value is null if TEXTCOLUMN is null.
FUNCTIONSCHEMA CHAR(8) Yes Schema of the access UDF specified in the ENABLE TEXT COLUMN command using the FUNCTION option. This value is null if no FUNCTION option is specified.
FUNCTIONNAME VARCHAR(18) Yes Name of the access UDF specified in the ENABLE TEXT COLUMN command using the FUNCTION option. This value is null if no FUNCTION option is specified.
PROTOTYPEHANDLE VARCHAR(60) Yes A handle for use in performance UDFs. It contains only the index name which is common for the whole text column.
INDEXOPTION VARCHAR(30) Yes Option used when creating the index: CASE_ENABLED.
INDEXPROPERTY VARCHAR(30) Yes Property used when creating the index: SECTIONS_ENABLED
NODENUMBER INTEGER No Node number of the table partition.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]