Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming


Table of Contents

  • Figures

  • Tables

  • Summary of Changes

  • About this book
  • Who should use this book
  • How this book is structured
  • How to read the syntax diagrams
  • Related information
  • How to send your comments

  • Part 1. Guide

  • Chapter 1. An overview of DB2 extenders
  • Text Extender
  • Other DB2 Extenders
  • Image Extender
  • Video Extender
  • Audio Extender
  • Text Extender in the DB2 client/server environment
  • Text Extender in the partitioned database environment
  • Chapter 2. Planning a text index
  • Why text documents need to be indexed
  • Types of index
  • Linguistic index
  • Precise index
  • Dual index
  • Ngram index
  • Changing the text index type
  • Creating one or several text indexes for a table
  • Calculating the size of an index
  • Chapter 3. Linguistic processing
  • Linguistic processing when indexing
  • Basic text analysis
  • Reducing terms to their base form (lemmatization)
  • Stop-word filtering
  • Decomposition (splitting compound terms)
  • Linguistic processing for retrieval
  • Synonyms
  • Thesaurus expansion
  • Sound expansion
  • Character and word masking
  • Linguistic processing for browsing
  • Stage 1: Normalization and term expansion
  • Stage 2: Extended matching
  • The supported languages
  • Dictionaries, stop-word lists, and abbreviation lists
  • Thesaurus concepts
  • Terms
  • Relations
  • Ngram thesaurus relations
  • Creating a thesaurus
  • Creating an Ngram thesaurus
  • Chapter 4. Administration
  • The sample wizard for indexing and search
  • Creating a Text Extender instance
  • Managing a Text Extender server
  • Start the server
  • Display the status of the server
  • Stop the server
  • Overview of the client administration tasks
  • Administration overview
  • Before you begin
  • Starting administration
  • Starting the Text Extender command line processor (optional)
  • Connecting to a database
  • Preparing text documents for searching
  • Changing the text configuration
  • Modifying the stop-word and abbreviation files
  • Modifying the document model file
  • Creating a sample table
  • Enabling a database
  • Enabling a text table
  • Enabling a text column
  • Enabling a text column in a large table
  • Enabling text columns of a nonsupported data type
  • Maintaining indexes in a multiple-node environment
  • Working with structured documents
  • Enabling external text files
  • Ending the administration session
  • Reversing the text preparation process
  • Disabling a text column
  • Disabling text files
  • Disabling a text table
  • Disabling a database
  • Maintaining text indexes
  • Updating an index
  • Updating an index for external files
  • Changing the settings of an index
  • Resetting the index status
  • Deleting index events
  • Reorganizing an index
  • Getting useful information
  • Displaying enabled-status information
  • Displaying the settings of the environment variables
  • Displaying the text configuration settings
  • Displaying the status of an index
  • Displaying error events
  • Displaying the index settings
  • Displaying the text settings for a column
  • Working with the Text Extender catalog view
  • Tracing faults
  • Backing up and restoring indexes and enabled databases
  • Chapter 5. Searching with Text Extender UDFs
  • The sample UDFs
  • The sample table DB2TX.SAMPLE
  • Handles for external files
  • Setting the current function path
  • Searching for text
  • Making a query
  • Searching and returning the number of matches found
  • Searching and returning the rank of a found text document
  • Specifying search arguments
  • Searching for several terms
  • Searching with the Boolean operators AND and OR
  • Searching for variations of a term
  • Searching for parts of a term (character masking)
  • Searching for terms that already contain a masking character
  • Searching for terms in any sequence
  • Searching for terms in the same sentence or paragraph
  • Searching for terms in sections of structured documents
  • Searching for synonyms of terms
  • Making a linguistic search
  • Searching with the Boolean operator NOT
  • Fuzzy search
  • Respecting word-phrase boundaries
  • Searching for similar-sounding words
  • Thesaurus search
  • Free-text and hybrid search
  • Refining a previous search
  • Setting and extracting information in handles
  • Setting text information when inserting new text
  • Extracting information from handles
  • Changing information in handles
  • Improving search performance
  • Chapter 6. Using the API functions for searching and browsing
  • Setting up your application
  • Linking a UNIX application
  • Linking an OS/2 or a Windows application
  • Overview of the API functions
  • Searching for text
  • Browsing text
  • Searching for text
  • Get a search result table (DesGetSearchResultTable)
  • Browsing text
  • Get browse information (DesGetBrowseInfo)
  • Start a browse session (DesStartBrowseSession)
  • Open a document (DesOpenDocument)
  • Get matches (DesGetMatches)
  • Close a document (DesCloseDocument)
  • End a browse session (DesEndBrowseSession)
  • Free the browse information (DesFreeBrowseInfo)

  • Part 2. Reference

  • Chapter 7. Administration commands for the client
  • Command line processor help
  • CHANGE INDEX SETTINGS
  • CHANGE TEXT CONFIGURATION
  • CONNECT
  • DELETE INDEX EVENTS
  • DISABLE DATABASE
  • DISABLE TEXT COLUMN
  • DISABLE TEXT FILES
  • DISABLE TEXT TABLE
  • ENABLE DATABASE
  • ENABLE TEXT COLUMN
  • ENABLE TEXT FILES
  • ENABLE TEXT TABLE
  • GET ENVIRONMENT
  • GET INDEX SETTINGS
  • GET INDEX STATUS
  • GET STATUS
  • GET TEXT CONFIGURATION
  • GET TEXT INFO
  • QUIT
  • REORGANIZE INDEX
  • RESET INDEX STATUS
  • UPDATE INDEX
  • Chapter 8. Administration commands for the server
  • TXICRT
  • TXIDROP
  • TXILIST (UNIX only)
  • TXNADD
  • TXNCHECK
  • TXNDROP
  • TXSAMPLE
  • TXSTART
  • TXSTATUS
  • TXSTOP
  • TXTHESC
  • TXTHESN
  • TXTRACE
  • TXVERIFY
  • TXWIZARD
  • Chapter 9. UDTs and UDFs
  • A summary of Text Extender UDTs
  • A summary of Text Extender UDFs
  • CCSID
  • CONTAINS
  • FILE
  • FORMAT
  • HANDLE
  • HANDLE_LIST
  • INIT_TEXT_HANDLE
  • LANGUAGE
  • NO_OF_DOCUMENTS
  • NO_OF_MATCHES
  • RANK
  • REFINE
  • SEARCH_RESULT
  • Chapter 10. Syntax of search arguments
  • Search argument
  • Chapter 11. API functions for searching and browsing
  • DesCloseDocument
  • DesEndBrowseSession
  • DesFreeBrowseInfo
  • DesGetBrowseInfo
  • DesGetMatches
  • DesGetSearchResultTable
  • DesOpenDocument
  • DesStartBrowseSession
  • Chapter 12. Return codes

  • Chapter 13. Messages
  • SQL states returned by UDFs
  • Messages from Text Extender
  • Chapter 14. Configuration
  • Environment variables
  • Text configuration settings
  • Text characteristics
  • Index characteristics
  • Processing characteristics
  • Information about text documents
  • Formats
  • Languages
  • CCSIDs
  • Setting the frequency of index updates
  • Chapter 15. Sample API program

  • Chapter 16. Error event reason codes

  • Notices
  • Programming interface information
  • Trademarks
  • Glossary

  • Index

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