4
Index Preferences

Use this chapter as a guide to replacing ConText pre-8.1.5 objects with interMedia Text 8.1.5 objects. The following topics are covered:

Preference Objects

Changes to Index Preference Objects

Table 4-1 lists the objects that are used to create preferences for indexing that have changed or are obsolete from 2.x to 8.1.

You can migrate preferences defined with 2.x objects manually using the information in Table 4-1, or you can use the migration scripts.

See Also:
For more information on using the migration scripts, see "Using the Index Migration Scripts" in this chapter.
For more information about creating preferences, see Chapter 5, "Indexing".

Table 4-1

Preference Class	Preference Object	Status	Migration Notes
Datastore	DIRECT	Changed	Renamed to DETAIL_DATSTORE
	MASTER DETAIL	Obsolete	In 8.1, MASTER DETAIL is obsolete. You set up master/detail tables using the DETAIL_DATASTORE object (MASTER DETAIL NEW in 2.x).
	MASTER DETAIL NEW	Changed	Renamed to DETAIL_DATASTORE
	OSFILE	Changed	Renamed to FILE_DATASTORE
	URL	Changed	Renamed to URL_DATASTORE
Filter	NULL FILTER	Changed	Renamed to NULL_FILTER
	BLASTER FILTER	Obsolete	In 8.1, BLASTER FILTER is obsolete. To index single or mixed format columns, use INSO_FILTER object. The INSO filter autodetects, so format attribute is not needed. To index formats (single or mixed column) not supported by INSO_FILTER, create/supply a user filter and use USER_FILTER object, specifying the executable name with the command attribute.
	HTML FILTER	Obsolete	To index HTML documents without indexing HTML tags, create and specify a section group preference of type HTML_SECTION_GROUP. If Japanese CODE_CONVERSION is on for HTML documents in 2.x, use the CHARSET_FILTER filter preference with CHARSET set to JAAUTO. KEEP_TAG is not needed anymore as HTML filtering and sectioning have been combined in one object.
	USER FILTER	Changed	Renamed to USER_FILTER
Lexer	BASIC LEXER	Changed	Renamed to BASIC_LEXER In addition, the SENT_PARA is no longer a valid attribute. To enable sentence or paragraph searching, add a special section to the section group preference.
	JAPANESE V-GRAM LEXER	Changed	Renamed to JAPANESE_VGRAM_LEXER In addition, in 8.1, this object has no attributes.
	KOREAN LEXER	Changed	Renamed to KOREAN_LEXER In addition, in 8.1, attributes have been added to allow users to control what is indexed.
	CHINESE V-GRAM LEXER	Changed	Renamed to CHINESE_VGRAM_LEXER In addition, this object has no attributes.
	THEME LEXER	Obsolete	To index themes, use BASIC_LEXER with INDEX_THEMES attribute set to TRUE.
	NLS_LEXER	Obsolete	This object was not implemented in 2.x and has been removed for 8.1
Wordlist	GENERIC WORD LIST	Changed	Renamed to BASIC_WORDLIST In addition, the STCLAUSE, INSTCLAUSE, SOUNDEX_AT_INDEX, and SECTION_GROUP attributes are obsolete. Soundex is automatically enabled and does not require any attributes. To specify a section group for an index, first create a section group using CTX_DDL.CREATE_SECTION_GROUP, then specify the section group in the parameter string of CREATE INDEX. BASIC_WORDLIST only requires attributes for the STEMMER and FUZZY attributes.
Stoplist	GENERIC STOP LIST	Obsolete	Create stoplists using the CTX_DDL.CREATE_STOPLIST procedure and specify the stoplist in the parameter string of CREATE INDEX.
Engine	GENERIC ENGINE	Changed	Renamed to BASIC_STORAGE In 8.1, Engine preference renamed to Storage preference. In addition, all the 2.X attributes are obsolete. No INDEX_MEMORY attribute. Set indexing memory in the parameter string of CREATE INDEX and ALTER INDEX. Various options have been combined. So, instead of specifying three clauses for each table as I1I_TABLESPACE, I1I_STORAGE etc., specify all clauses with one attribute I_TABLE_CLAUSE.
Loader	GENERIC LOADER	Obsolete	These preference objects were used in 2.x to create sources for automating text loading using ctxload. In 8.1, ctxload no longer supports text loading. As a result, these preference objects are obsolete. To load text in database, use SQL*Loader.
	NULL TRANSLATOR	Obsolete
	USER TRANSLATOR	Obsolete
	DIRECTORY READER	Obsolete
Compressor	NULL COMPRESSOR	Obsolete	This object was not implemented in 2.x and has been removed for 8.1.

New Indexing Objects

Oracle8i interMedia Text 8.1.5 has some new indexing objects.

See Also:
For a complete list of the interMedia Text 8.1.5 indexing objects, see Oracle8i interMedia Text Reference.

System-Defined Preferences

Oracle8i interMedia Text has renamed most system-defined preferences and added some new ones.

See Also:
For a complete list of the interMedia Text 8.1.5 system-defined preferences, see Oracle8i interMedia Text Reference.

The migration script automates the transformation of system-defined preferences.

See Also:
For a complete list on the automated transformations, see "System-Defined Preference Transformations" in the next section.

Using the Index Migration Scripts

The migration scripts are the following:

drminst
drmrun
migrate.sql

The migrations scripts drminst and drmrun are obtained from your 8.1.5 installation. They are located in the $ORACLE_HOME/ctx/migrate directory.

You must copy these scripts into your production environment (pre-8.1). Run these scripts to generate migrate.sql.

The migrate.sql script attempts to recreate the pre-8.1.5 index as closely as possible. It does so by creating corresponding preferences and attributes and finally the index using interMedia Text 8.1.5 code.

You then copy migrate.sql to your test environment, edit it appropriately, and run the edited migrate.sql to transform your index.

See Also:
For more information on planning your migration, see "Migration Plan" in Chapter 2.

User-Defined Preference Transformation

The migration script attempts to replace all preferences defined with pre-8.1.5 objects with preferences defined with the renamed 8.1.5 objects.

For example, if you have a pre-8.1.5 policy that uses a preference named mydatapref set to the OSFILE object, the migration script creates an 8.1.5 preference called mydatapref and sets it to use the FILE_DATASTORE object. The 8.1.5 index is created with the mydatapref storage preference.

Warning for Preferences Based on Obsolete Objects

When an pre-8.1.5 object or attribute has been made obsolete in 8.1, the migration script issues a warning in the form of a REM statement and creates no corresponding preference. In such cases, you must edit the migration script to reflect the correct replacement preference, if any, for your system.

See Also:
For a list of renamed and obsolete objects, see "Preference Objects" in this chapter.

System-Defined Preference Transformations

The migration script replaces pre-8.1.5 system-defined preferences with 8.1.5 system-defined preferences.

Unchanged Preferences

When a system-defined preference name has not changed from pre-8.1.5 to 8.1, the migration script uses the same preference name and attribute. For example, if your pre-8.1.5 policy used the DEFAULT_LEXER system-defined preference, your 8.1.5 index will be created with the DEFAULT_LEXER system-defined lexer preference.

Renamed Preferences

When system-defined preference names or attributes have been renamed for 8.1, the migration script replaces the old name with the new name.

Warning for Obsolete Preferences

When an pre-8.1.5 system-defined preference or attribute has been made obsolete in 8.1, the migration script issues a warning in the form of a REM statement and creates no corresponding preference. In such cases, you must edit the migration script to reflect the correct replacement preference, if any, for your system.

Table of Transformations

The migration script replaces system-defined 2.Xpreferences with the new 8.1.5 preferences. The following table lists these replacements:

2.x System-Defined Preference 8.1.5 Replacement

DEFAULT_DIRECT_DATASTORE

DEFAULT_DATASTORE

MD_TEXT

Obsolete

MD_BINARY

Obsolete

OSFILE

FILE_DATASTORE

DEFAULT_URL

URL_DATASTORE

DEFAULT_NULL_COMPRESSOR

Obsolete

DEFAULT_NULL_FILTER

NULL_FILTER

AUTOB

INSO_FILTER

WW6B

INSO_FILTER

HTML_FILTER

Obsolete

BASIC_HTML_FILTER

Obsolete

DEFAULT_LEXER

DEFAULT_LEXER

VGRAM_JAPANESE

JAPANESE_LEXER

VGRAM_JAPANESE_1

JAPANESE_LEXER

VGRAM_JAPANESE_2

JAPANESE_LEXER

KOREAN

KOREAN_LEXER

VGRAM_CHINESE

CHINESE_LEXER

VGRAM_CHINESE_1

CHINESE_LEXER

VGRAM_CHINESE_2

CHINESE_LEXER

THEME_LEXER

Obsolete

BASIC_HTML_LEXER

Obsolete

BASIC_HTML_SECTION

Obsolete

SOUNDEX

DEFAULT_WORDLIST

NO_SOUNDEX

DEFAULT_WORDLIST

VGRAM_JAPANESE_WORDLIST

JAPANESE_WORDLIST

KOREAN_WORDLIST

KOREAN_WORDLIST

VGRAM_CHINESE_WORDLIST

CHINESE_WORDLIST

BASIC_HTML_WORDLIST

Obsolete

DEFAULT_STOPLIST

DEFAULT_STOPLIST

NO_STOPLIST

EMPTY_STOPLIST

DEFAULT_INDEX

DEFAULT_STORAGE

DEFAULT_LOADER

Obsolete

DEFAULT_TRANSLATOR

Obsolete

FRENCH_STOPLIST

FRENCH_STOPLIST

ITALIAN_STOPLIST

ITALIAN_STOPLIST

SPANISH_STOPLIST

SPANISH_STOPLIST

GERMAN_STOPLIST

GERMAN_STOPLIST

2.x System-Defined Preference	8.1.5 Replacement
DEFAULT_DIRECT_DATASTORE	DEFAULT_DATASTORE
MD_TEXT	Obsolete
MD_BINARY	Obsolete
OSFILE	FILE_DATASTORE
DEFAULT_URL	URL_DATASTORE
DEFAULT_NULL_COMPRESSOR	Obsolete
DEFAULT_NULL_FILTER	NULL_FILTER
AUTOB	INSO_FILTER
WW6B	INSO_FILTER
HTML_FILTER	Obsolete
BASIC_HTML_FILTER	Obsolete
DEFAULT_LEXER	DEFAULT_LEXER
VGRAM_JAPANESE	JAPANESE_LEXER
VGRAM_JAPANESE_1	JAPANESE_LEXER
VGRAM_JAPANESE_2	JAPANESE_LEXER
KOREAN	KOREAN_LEXER
VGRAM_CHINESE	CHINESE_LEXER
VGRAM_CHINESE_1	CHINESE_LEXER
VGRAM_CHINESE_2	CHINESE_LEXER
THEME_LEXER	Obsolete
BASIC_HTML_LEXER	Obsolete
BASIC_HTML_SECTION	Obsolete
SOUNDEX	DEFAULT_WORDLIST
NO_SOUNDEX	DEFAULT_WORDLIST
VGRAM_JAPANESE_WORDLIST	JAPANESE_WORDLIST
KOREAN_WORDLIST	KOREAN_WORDLIST
VGRAM_CHINESE_WORDLIST	CHINESE_WORDLIST
BASIC_HTML_WORDLIST	Obsolete
DEFAULT_STOPLIST	DEFAULT_STOPLIST
NO_STOPLIST	EMPTY_STOPLIST
DEFAULT_INDEX	DEFAULT_STORAGE
DEFAULT_LOADER	Obsolete
DEFAULT_TRANSLATOR	Obsolete
FRENCH_STOPLIST	FRENCH_STOPLIST
ITALIAN_STOPLIST	ITALIAN_STOPLIST
SPANISH_STOPLIST	SPANISH_STOPLIST
GERMAN_STOPLIST	GERMAN_STOPLIST

Index Creation Warnings

After attributes and preferences have been created, the migration script attempts to recreate the pre-8.1.5 indexes from the pre-8.1.5 policy information.

Policies do not exist in interMedia Text 8.1. In 8.1, you create a Text index as an extensible type of Oracle index. In addition, you can create only a single index per column.

Therefore, the migration script issues a warning as a REM statement if your pre-8.1.5 environment includes any of the following non-migratable structures:

multiple policies on a single column
non-indexed policies
template policies
indexes on views

See Also:
For more information on the Text index, see "About the Text Index" in Chapter 5.

4 Index Preferences