Contents

List of Tables

Title and Copyright Information

Send Us Your Comments

Preface

Audience

Documentation Accessibility

Structure

Related Documentation

Conventions

What's New in Oracle Text?

Oracle Database 10g Release 2 (10.2) New Features in Oracle Text

Oracle Database 10g Release 1 (10.1) New Features in Oracle Text

1 Oracle Text SQL Statements and Operators

ALTER INDEX

ALTER TABLE: Supported Partitioning Statements

CATSEARCH

CONTAINS

CREATE INDEX

DROP INDEX

MATCHES

MATCH_SCORE

SCORE

2 Oracle Text Indexing Elements

Overview

Creating Preferences

Datastore Types

DIRECT_DATASTORE

DIRECT_DATASTORE CLOB Example

MULTI_COLUMN_DATASTORE

Indexing and DML

MULTI_COLUMN_DATASTORE Example

MULTI_COLUMN_DATASTORE Filter Example

Tagging Behavior

Indexing Columns as Sections

DETAIL_DATASTORE

Synchronizing Master/Detail Indexes

Example Master/Detail Tables

FILE_DATASTORE

PATH Attribute Limitations

FILE_DATASTORE Example

URL_DATASTORE

URL Syntax

URL_DATASTORE Attributes

URL_DATASTORE Example

USER_DATASTORE

Constraints

Editing Procedure after Indexing

USER_DATASTORE with CLOB Example

USER_DATASTORE with BLOB_LOC Example

NESTED_DATASTORE

NESTED_DATASTORE Example

Filter Types

CHARSET_FILTER

UTF-16 Big- and Little-Endian Detection

Indexing Mixed-Character Set Columns

AUTO_FILTER

Indexing Formatted Documents

Explicitly Bypassing Plain Text or HTML in Mixed Format Columns

Character Set Conversion With AUTO_FILTER

NULL_FILTER

Indexing HTML Documents

MAIL_FILTER

Filter Behavior

About the Mail Filter Configuration File

Mail_Filter Example

USER_FILTER

User Filter Example

PROCEDURE_FILTER

Parameter Order

Procedure Filter Execute Requirements

Error Handling

Procedure Filter Preference Example

Lexer Types

BASIC_LEXER

Stemming User-Dictionaries

BASIC_LEXER Example

MULTI_LEXER

Multi-language Stoplists

MULTI_LEXER Example

Querying Multi-Language Tables

CHINESE_VGRAM_LEXER

CHINESE_VGRAM_LEXER Attribute

Character Sets

CHINESE_LEXER

CHINESE_LEXER Attribute

Customizing the Chinese Lexicon

JAPANESE_VGRAM_LEXER

JAPANESE_VGRAM_LEXER Attributes

JAPANESE_VGRAM_LEXER Character Sets

JAPANESE_LEXER

Customizing the Japanese Lexicon

JAPANESE_LEXER Attributes

JAPANESE LEXER Character Sets

Japanese Lexer Example

KOREAN_MORPH_LEXER

Supplied Dictionaries

Supported Character Sets

Unicode Support

KOREAN_MORPH_LEXER Attributes

Limitations

KOREAN_MORPH_LEXER Example: Setting Composite Attribute

USER_LEXER

Limitations

USER_LEXER Attributes

INDEX_PROCEDURE

INPUT_TYPE

QUERY_PROCEDURE

Encoding Tokens as XML

XML Schema for No-Location, User-defined Indexing Procedure

XML Schema for User-defined Indexing Procedure with Location

XML Schema for User-defined Lexer Query Procedure

WORLD_LEXER

WORLD_LEXER Attribute

WORLD_LEXER Example

Wordlist Type

BASIC_WORDLIST

BASIC_WORDLIST Example

Enabling Fuzzy Matching and Stemming

Enabling Sub-string and Prefix Indexing

Setting Wildcard Expansion Limit

Storage Types

BASIC_STORAGE

Storage Default Behavior

Storage Example

Section Group Types

Section Group Examples

Creating Section Groups in HTML Documents

Creating Sections Groups in XML Documents

Automatic Sectioning in XML Documents

Classifier Types

RULE_CLASSIFIER

SVM_CLASSIFIER

Cluster Types

KMEAN_CLUSTERING

Stoplists

Multi-Language Stoplists

Creating Stoplists

Modifying the Default Stoplist

Dynamic Addition of Stopwords

System-Defined Preferences

Data Storage

CTXSYS.DEFAULT_DATASTORE

CTXSYS.FILE_DATASTORE

CTXSYS.URL_DATASTORE

Filter

CTXSYS.NULL_FILTER

CTXSYS.AUTO_FILTER

Lexer

CTXSYS.DEFAULT_LEXER

CTXSYS.BASIC_LEXER

Section Group

CTXSYS.NULL_SECTION_GROUP

CTXSYS.HTML_SECTION_GROUP

CTXSYS.AUTO_SECTION_GROUP

CTXSYS.PATH_SECTION_GROUP

Stoplist

CTXSYS.DEFAULT_STOPLIST

CTXSYS.EMPTY_STOPLIST

Storage

CTXSYS.DEFAULT_STORAGE

Wordlist

CTXSYS.DEFAULT_WORDLIST

System Parameters

General System Parameters

Default Index Parameters

CONTEXT Index Parameters

CTXCAT Index Parameters

CTXRULE Index Parameters

Viewing Default Values

Changing Default Values

3 Oracle Text CONTAINS Query Operators

Operator Precedence

Group 1 Operators

Group 2 Operators and Characters

Procedural Operators

Precedence Examples

Altering Precedence

ABOUT

ACCUMulate ( , )

AND (&)

Broader Term (BT, BTG, BTP, BTI)

EQUIValence (=)

Fuzzy

HASPATH

INPATH

MDATA

MINUS (-)

Narrower Term (NT, NTG, NTP, NTI)

NEAR (;)

NOT (~)

OR (|)

Preferred Term (PT)

Related Term (RT)

soundex (!)

stem ($)

Stored Query Expression (SQE)

SYNonym (SYN)

threshold (>)

Translation Term (TR)

Translation Term Synonym (TRSYN)

Top Term (TT)

weight (*)

wildcards (% _)

WITHIN

4 Special Characters in Oracle Text Queries

Grouping Characters

Escape Characters

Querying Escape Characters

Reserved Words and Characters

5 CTX_ADM Package

MARK_FAILED

RECOVER

SET_PARAMETER

6 CTX_CLS Package

TRAIN

CLUSTERING

7 CTX_DDL Package

ADD_ATTR_SECTION

ADD_FIELD_SECTION

ADD_INDEX

ADD_MDATA

ADD_MDATA_SECTION

ADD_SPECIAL_SECTION

ADD_STOPCLASS

ADD_STOP_SECTION

ADD_STOPTHEME

ADD_STOPWORD

ADD_SUB_LEXER

ADD_ZONE_SECTION

COPY_POLICY

CREATE_INDEX_SET

CREATE_POLICY

CREATE_PREFERENCE

CREATE_SECTION_GROUP

CREATE_STOPLIST

DROP_INDEX_SET

DROP_POLICY

DROP_PREFERENCE

DROP_SECTION_GROUP

DROP_STOPLIST

OPTIMIZE_INDEX

REMOVE_INDEX

REMOVE_MDATA

REMOVE_SECTION

REMOVE_STOPCLASS

REMOVE_STOPTHEME

REMOVE_STOPWORD

REPLACE_INDEX_METADATA

SET_ATTRIBUTE

SYNC_INDEX

UNSET_ATTRIBUTE

UPDATE_POLICY

8 CTX_DOC Package

FILTER

GIST

HIGHLIGHT

IFILTER

MARKUP

PKENCODE

POLICY_FILTER

POLICY_GIST

POLICY_HIGHLIGHT

POLICY_MARKUP

POLICY_SNIPPET

POLICY_THEMES

POLICY_TOKENS

SET_KEY_TYPE

SNIPPET

THEMES

TOKENS

9 CTX_OUTPUT Package

ADD_EVENT

ADD_TRACE

END_LOG

END_QUERY_LOG

GET_TRACE_VALUE

LOG_TRACES

LOGFILENAME

REMOVE_EVENT

REMOVE_TRACE

RESET_TRACE

START_LOG

START_QUERY_LOG

10 CTX_QUERY Package

BROWSE_WORDS

COUNT_HITS

EXPLAIN

HFEEDBACK

REMOVE_SQE

STORE_SQE

11 CTX_REPORT

Procedures in CTX_REPORT

Using the Function Versions

DESCRIBE_INDEX

DESCRIBE_POLICY

CREATE_INDEX_SCRIPT

CREATE_POLICY_SCRIPT

INDEX_SIZE

INDEX_STATS

QUERY_LOG_SUMMARY

TOKEN_INFO

TOKEN_TYPE

12 CTX_THES Package

ALTER_PHRASE

ALTER_THESAURUS

BT

BTG

BTI

BTP

CREATE_PHRASE

CREATE_RELATION

CREATE_THESAURUS

CREATE_TRANSLATION

DROP_PHRASE

DROP_RELATION

DROP_THESAURUS

DROP_TRANSLATION

HAS_RELATION

NT

NTG

NTI

NTP

OUTPUT_STYLE

PT

RT

SN

SYN

THES_TT

TR

TRSYN

TT

UPDATE_TRANSLATION

13 CTX_ULEXER Package

WILDCARD_TAB

14 Oracle Text Executables

Thesaurus Loader (ctxload)

Text Loading

ctxload Syntax

Mandatory Arguments

Optional Arguments

ctxload Examples

Thesaurus Import Example

Thesaurus Export Example

Knowledge Base Extension Compiler (ctxkbtc)

Knowledge Base Character Set

ctxkbtc Syntax

ctxkbtc Usage Notes

ctxkbtc Limitations

ctxkbtc Constraints on Thesaurus Terms

ctxkbtc Constraints on Thesaurus Relations

Extending the Knowledge Base

Example for Extending the Knowledge Base

Adding a Language-Specific Knowledge Base

Limitations for Adding a Knowledge Base

Order of Precedence for Multiple Thesauri

Size Limits for Extended Knowledge Base

Lexical Compiler (ctxlc)

Syntax of ctxlc

Mandatory Arguments

Optional Arguments

Performance Considerations

ctxlc Usage Notes

Example

15 Oracle Text Alternative Spelling

Overview of Alternative Spelling Features

Alternate Spelling

Base-Letter Conversion

Generic Versus Language-Specific Base-Letter Conversions

New German Spelling

Overriding Alternative Spelling Features

Overriding Base-Letter Transformations with Alternate Spelling

Alternative Spelling Conventions

German Alternate Spelling Conventions

Danish Alternate Spelling Conventions

Swedish Alternate Spelling Conventions

A Oracle Text Result Tables

CTX_QUERY Result Tables

EXPLAIN Table

Operation Column Values

OPTIONS Column Values

HFEEDBACK Table

Operation Column Values

OPTIONS Column Values

CTX_FEEDBACK_TYPE

CTX_DOC Result Tables

Filter Table

Gist Table

Highlight Table

Markup Table

Theme Table

Token Table

CTX_THES Result Tables and Data Types

EXP_TAB Table Type

B Oracle Text Supported Document Formats

About Document Filtering Technology

Latest Updates for Patch Releases

Restrictions on Format Support

Supported Platforms

Supported Platforms

Environment Variables

Supported Document Formats

Text and Markup

Word Processing Formats

Word Processing Filtering Limitations

Spreadsheet Formats

Spreadsheet Format Limitations

Presentation Formats

Presentation Format Limitations

Display Formats

Filtering of PDF Format Documents

Graphic Formats

C Text Loading Examples for Oracle Text

SQL INSERT Example

SQL*Loader Example

Creating the Table

Issuing the SQL*Loader Command

Example Control File: loader1.dat

Example Data File: loader2.dat

Structure of ctxload Thesaurus Import File

Alternate Hierarchy Structure

Usage Notes for Terms in Import Files

Usage Notes for Relationships in Import Files

Examples of Import Files

Example 1 (Flat Structure)

Example 2 (Hierarchical)

Example 3

D Oracle Text Multilingual Features

Introduction

Indexing

Index Types

CONTEXT Index Type

CTXCAT Index Type

CTXRULE Index Type

Lexer Types

Basic Lexer Features

Theme Indexing

Alternate Spelling

Base Letter Conversion

Composite

Index stems

Multi Lexer Features

World Lexer Features

Querying

ABOUT Operator

Fuzzy Operator

Stem Operator

Supplied Stop Lists

Knowledge Base

Knowledge Base Extension

Multi-Lingual Features Matrix

E Oracle Text Supplied Stoplists

English Default Stoplist

Chinese Stoplist (Traditional)

Chinese Stoplist (Simplified)

Danish (dk) Default Stoplist

Dutch (nl) Default Stoplist

Finnish (sf) Default Stoplist

French (f) Default Stoplist

German (d) Default Stoplist

Italian (i) Default Stoplist

Portuguese (pt) Default Stoplist

Spanish (e) Default Stoplist

Swedish (s) Default Stoplist

F The Oracle Text Scoring Algorithm

Scoring Algorithm for Word Queries

Example

DML and Scoring

G Oracle Text Views

CTX_CLASSES

CTX_INDEXES

CTX_INDEX_ERRORS

CTX_INDEX_OBJECTS

CTX_INDEX_PARTITIONS

CTX_INDEX_SETS

CTX_INDEX_SET_INDEXES

CTX_INDEX_SUB_LEXERS

CTX_INDEX_SUB_LEXER_VALUES

CTX_INDEX_VALUES

CTX_OBJECTS

CTX_OBJECT_ATTRIBUTES

CTX_OBJECT_ATTRIBUTE_LOV

CTX_PARAMETERS

CTX_PENDING

CTX_PREFERENCES

CTX_PREFERENCE_VALUES

CTX_SECTIONS

CTX_SECTION_GROUPS

CTX_SQES

CTX_STOPLISTS

CTX_STOPWORDS

CTX_SUB_LEXERS

CTX_THESAURI

CTX_THES_PHRASES

CTX_TRACE_VALUES

CTX_USER_INDEXES

CTX_USER_INDEX_ERRORS

CTX_USER_INDEX_OBJECTS

CTX_USER_INDEX_PARTITIONS

CTX_USER_INDEX_SETS

CTX_USER_INDEX_SET_INDEXES

CTX_USER_INDEX_SUB_LEXERS

CTX_USER_INDEX_SUB_LEXER_VALS

CTX_USER_INDEX_VALUES

CTX_USER_PENDING

CTX_USER_PREFERENCES

CTX_USER_PREFERENCE_VALUES

CTX_USER_SECTIONS

CTX_USER_SECTION_GROUPS

CTX_USER_SQES

CTX_USER_STOPLISTS

CTX_USER_STOPWORDS

CTX_USER_SUB_LEXERS

CTX_USER_THESAURI

CTX_USER_THES_PHRASES

CTX_VERSION

H Stopword Transformations in Oracle Text

Understanding Stopword Transformations

Word Transformations

AND Transformations

OR Transformations

ACCUMulate Transformations

MINUS Transformations

NOT Transformations

EQUIValence Transformations

NEAR Transformations

Weight Transformations

Threshold Transformations

WITHIN Transformations

Index