IBM (R) DB2 (R) Universal Database Text Extender Version 8.1 Release Notes Note: Before using this information and the product it supports, be sure to read the general information under "Notices" near the end of this file. Set the font to monospace to better view this file. Welcome to DB2 Universal Database Text Exender, Version 8.1. (referred to as Text Extender in this document) -------------------------------------------------------------------------------- Table of Contents -------------------------------------------------------------------------------- 1. Prerequisites 2. Supported platforms 3. Documentation 4. Alternative IBM Text Search products 5. Installation Instructions: UNIX 6. Installation Instructions: Windows 7. Migration Instructions: UNIX 8. Migration Instructions: Windows 9. Hints and Tips 10. Restrictions 11. Notices -------------------------------------------------------------------------------- 1. Prerequisites -------------------------------------------------------------------------------- Text Extender requires a DB2 Universal Database Version 8.1 installation. -------------------------------------------------------------------------------- 2. Supported platforms -------------------------------------------------------------------------------- The Text Extender CD-ROM contains install packages for the following platforms: * AIX * Solaris * Windows NT * Windows 2000 * Windows XP * HP-UX Text Extender supports only 32-bit platforms. For a complete platform overview, supported versions and maintenance levels, see the announcement letter: IBM DB2 Universal Database V8.1 for Linux, UNIX, and Windows Delivers Enhanced Scalability, Manageability, Performance, and Availability for e-business Deployment. Programming Announcement, September 17, 2002 The announcement letter can also be found on the web at: http://www.ibmlink.ibm.com/ -------------------------------------------------------------------------------- 3. Documentation -------------------------------------------------------------------------------- DB2 Extenders documentation is available in PDF format for online viewing. The manuals are available in several languages. en_US English de_DE German ja_JP Japanese ko_KR Korean zh_CN Simplified Chinese zh_TW Traditional Chinese es_ES Spanish Several documentation defects were fixed after translation cutoff. In case of problems, check the English documentation. In addition, see the "Hints & Tips" and "Restrictions" sections of this release note. For the latest available technical information, see the Web Based Technical Support information on: http://www.ibm.com/software/data/db2/extenders/text/support.html -------------------------------------------------------------------------------- 4. Alternative IBM Text Search products -------------------------------------------------------------------------------- To get an overview of the available text search Extenders, see: http://www.ibm.com/software/data/db2/extenders/ For a comparison of the available text search Extenders, see: http://www.ibm.com/software/data/db2/extenders/fulltextcomparison.html We strongly recommend that you review the latest available text search technology from IBM, the DB2 UDB Net Search Extender Version 8.1. For a product description: http://www.ibm.com/software/data/db2/extenders/netsearch/index.html -------------------------------------------------------------------------------- 5. Installation Instructions: UNIX -------------------------------------------------------------------------------- 5.1 Installation steps AIX 1. Create a temporary directory to hold the Text Extender tar file. Example : mkdir /tmp/db2tx 2. Extract the archived files using: cd /tmp/db2tx tar -xvf /tmp/db2tx/C508RML.tar 3. Install the package using : "smitty installp". Select "Install and Update from LATEST Available Software Specify the download directory and then select the package in the "Software to install" line . Solaris 1. If a group smadmin does not exist, create one using 'groupadd smadmin'. 2. Create a temporary directory to hold the Text Extender tar file. Example : mkdir /tmp/db2tx 3. Extract the archived files using: cd /tmp/db2tx tar -xvf /tmp/db2tx/C508TML.tar 4. Install the package using: 'pkgadd -d /tmp/db2tx/IBM/db2tx'. A list of available packages is displayed. - For a server installation, the following packages are mandatory: db2txsrv, db2txclnt, db2txcom, db2txdius, and db2txmsgs - For a client-only installation, the following packages are required: db2txclnt, db2txcom, db2txdius, and db2txmsgc To install the package, the script file 'db2tx_install' can also be used. Hint: If installation fails due to incorrect attributes of the /opt/IBM directory, please check that its ownership is set to bin:bin. HP-UX 1. Create a temporary directory to hold the Text Extender tar file. Example : mkdir /tmp/db2tx 2. Extract the archived files using: cd /tmp/db2tx tar -xvf /tmp/db2tx/C508SML.tar 2. Install the package using: swinstall -s /tmp/db2tx/IBMdb2tx_81.depot DB2TX 5.2 Instance creation If there is no existing Text Extender instance, you have to create a new instance using the following steps: Logon as root user and run the following command: /instance/txicrt where is: On AIX: /usr/opt/db2tx_08_01 On Solaris and HP-UX: /opt/IBM/db2tx/V8.1 is the userid of the Text Extender instance owner is the name of an existing DB2 instance NOTE: On HP-UX add a third parameter to the txicrt command to create a tcpip mode configuration. Local Mode is not supported for HP-UX. Ensure the Text Extender instance owner is part of the smadmin group. If the DB2 instance owner userid is different from the fenced userid specified during DB2 instance creation, make sure that the fenced id is also part of the smadmin group. If the Text Extender instance owner userid is different from the DB2 instance owner userid, create a symbolic link from '/db2tx/db2txprofile' to '/db2tx/db2txprofile' where '' is the DB2 instance owner home directory is the Text Extender instance owner home directory. Note: After instance creation, stop and start DB2 to make DB2 aware of the new Text Extender environment variable settings. -------------------------------------------------------------------------------- 6. Installation Instructions: Windows -------------------------------------------------------------------------------- 6.1 Installation steps 1. Create a temporary directory to hold the Text Extender self extracting file C508QML.exe. Example : mkdir d:\tmp\db2tx 2. Click on the START button on the task bar and select 'RUN'. Type d:\tmp\db2tx\C508QML in the open field. 3. If a previous version of Text Extender has been installed, see the "Migration" section before continuing with the installation. 4. Click on the START button on the task bar and select 'RUN'. Type d:\tmp\db2tx\setup in the open field. During installation you are prompted for a target installation path. Note that the target installation path can not contain blank characters. 5. It is necessary to restart Windows before you can work with Text Extender. 6. Ensure that the DB2 Service for the instance you want to use Text Extender for shows a valid administrator userid listed in the "Log On As" information in the Windows Services panel. 6.2 Instance creation After installation, a Text Extender instance has to be created. See the "Migration" section for existing instances before you create a new Text Extender instance. Run 'txicrt ' where is the name of the new Text Extender instance. -------------------------------------------------------------------------------- 7. Migration Instructions: UNIX -------------------------------------------------------------------------------- To migrate a Text Extender Version 7 instance and Text Extender Version 7 enabled databases to Version 8, use the following steps: 1. Stop Text Extender and DB2 using the following commands: txstop db2stop 2. Migrate the instance. a) If your DB2 instance is still a DB2 Version 7 instance, run as root: - For AIX: /usr/opt/db2_08_01/instance/db2imigr - For Solaris and HP-UX: /opt/IBM/db2/V8.1/instance/db2imigr b) Edit '/sqllib/db2profile' and change the DB2DIR environment variable to /usr/opt/db2_08_01 (for AIX) or /opt/IBM/db2/V8.1 (for Solaris). As instance user, start DB2. c) Migrate the Version 7 database to a Version 8 database using: db2 migrate db d) If your Text Extender instance is still a Version 7 instance change to: - For AIX: /usr/opt/db2tx_08_01/instance - For solaris and HP-UX: /opt/IBM/db2tx/V8.1/instance and execute 'txiupdt ' where is the name of the Text Extender Version 7 instance is the name of the DB2 Version 8 instance. For example, txiupdt db2v7 db2v8 e) stop TE and DB2 (txstop, db2stop) and then restart DB2 and TE. -------------------------------------------------------------------------------- 8. Migration Instructions: Windows -------------------------------------------------------------------------------- To migrate a Text Extender Version 7 instance and Text Extender Version 7 enabled databases to Version 8 use the following steps: 1. Migrate the database(s) using the DB2 command db2 migrate database where is the DB2 database name 2. Stop Text Extender and DB2 using the following commands: txstop db2stop 3. Migrate the instance: a) Before you install Text Extender Version 8.1 you must copy the following files to a temporary directory. For example: d:\temp. Files from the Text Extender Version 7.1 instance directory: - the master index reference file: %DMBMMPATH%\instance\\db2tx\txins000\desmastr.dat - if modified, the model file for structured document processing: %DMBMMPATH%\instance\\db2tx\txins000\desmodel.ini - if modified the TAF configuration file: %DMBMMPATH%\instance\\db2tx\txins000\destaf.tcf Files from the Text Extender Version 7.1 dictionary directory: - any modified stopword files: %DMBMMPATH%\db2tx\dicts - any modified thesaurus files: %DMBMMPATH%\db2tx\dicts b) Deinstall Text Extender V7.1 Deinstallation does not drop the Text Extender created indexes you want to reuse. If you stored the indexes under the Text Extender V7.1 installation directory, do not drop the directory. c) Install Text Extender Version 8.1 and a reboot. d) Create the new Text Extender instance. txicrt e) Copy the saved files back to the new instance directory. Files from the Text Extender Version 7.1 instance directory to: %DESTXPATH%\instance\\db2tx\txins000\ The existing default files can be overwritten. Files from the Text Extender Version 7.1 dictionary directory to: %DESTXPATH%\db2tx\dicts\ where %DMBMMPATH% is the Text Extender V7.1 environment variable that points to the Text Extender Installation. 4. Start DB2 and Text Extender using the following commands: db2start txstart -------------------------------------------------------------------------------- 9. Hints and tips -------------------------------------------------------------------------------- 1. For large tables, check the following to avoid performance problems: - Store the Text Extender created index files on another disc than DB2 objects like tables and DB2 created indexes. - On AIX increase the file system cache. - Use the search_result UDF for search rather than the contains UDF. - Try to limit the search result list size by using the RESULT LIMIT keyword. - Avoid wild card searches, and check if you can use fuzzy search instead. - Check if you can use DB2 UDB Net Search Extender V8.1. Net Search Extender provides a DB2 optimizer integration for SQL-based searches which is beneficial for combined full-text and parametric searches. 2. On UNIX, for databases with CCSID's other than 819, the sample command file 'txsample' has to be adapted. Therefore, change the CCSID value of the enable step for the Ngram index type to your database CCSID. For Windows, use the CCSID option of the txsample command to specify the database CCSID. For example, 'txsample mydb 1253'. 3. If the search server has been successfully started with txstart, but the desdiag.log file shows an error. For example: ...Shared Memory Access Failed or, if a search returns the error message: SQL0443N Routine "CONTAINS" (specific name "DES5A") has returned an error SQLSTATE with diagnostic text "DES38708 RC_SE_SERVER_NOT_AVAILABLE. Search failed. ". SQLSTATE=38708 Try one of the following: UNIX Try to remove pending shared resources using the command 'txipclean'. Refer to the Administration and Programming Guide for more information. If this does not solve the problem, use the AIX configuration parameter EXTSHM to increase the number of available shared memory segments. Add the following commands to db2profile: export EXTSHM=ON db2set DB2ENVLIST=EXTSHM Then restart the instance with the following commands: db2stop db2start WINDOWS Stop and start Text Extender or reboot the machine. 4. (Windows only ) If you use Windows Terminal Services to connect to the server where Text Extender is installed, the Text Extender server must be started as follows : set ENABLE_TERMINAL_SERVICE=1 txstart -------------------------------------------------------------------------------- 10. Current restrictions -------------------------------------------------------------------------------- - Support for data partitioning in a partitioned database environment is currently only provided for AIX by Net Search Extender V8.1 with a minimum of Fix Pack level 2. Support for other platforms will follow. For more information about Net Search Extender, see chapter 'Documentation'. - Support for the C-language API is no longer supported. - To run Text Extender in a Windows environment, set the DB2 service in the Services window of the Control Panel to a valid administrator userid. - For Windows, the environment variable DB2INSTANCE must be set as system environment variable. If it is not set, the utilities txstart, txstatus, and txstop cannot be called. - The STEMMED FORM OF for index type normalized is only supported for US_ENGLISH. - The REFINE UDF does not support IS ABOUT or THESAURUS queries as a query refinement. - Masking is not allowed for SOUNDS LIKE. - The maximum number of model names in the model definition file is 50. - Stemming is not supported for thesaurus searches on a linguistic index type. - The backslash cannot be used as escape character for CCSID 954. - The following formats are not supported for DBCS languages: AMI, FFT, MSWORD, RFT, RTF, and WP5. - Values for attribute sections for search must be SBCS characters. - Running multiple enabling commands on the same table in parallel may result in RC 507 shown with db2tx get index status. For a workaround, sequentially run the enable commands. - For Windows 2000, the system and user locale must match. - Documentation. See the 'TXTHESN command' in the "Administration commands for the server" chapter. For a list of supported CCSIDs, see the 'Creating an Ngram thesaurus' section in the "Thesaurus concepts" chapter. -------------------------------------------------------------------------------- 11. Notices -------------------------------------------------------------------------------- IBM may not offer the products, services, or features discussed in this document in all countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country/region or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country/region where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions; therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product, and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information that has been exchanged, should contact: IBM Canada Limited Office of the Lab Director 8200 Warden Avenue Markham, Ontario L6G 1C7 CANADA Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems, and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements, or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility, or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information may contain examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious, and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Trademarks The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both, and have been used in at least one of the documents in the DB2 UDB documentation library: ACF/VTAM AISPO AIX AIXwindows AnyNet APPN AS/400 BookManager C Set++ C/370 CICS Database 2 DataHub DataJoiner DataPropagator DataRefresher DB2 DB2 Connect DB2 Extenders DB2 OLAP Server DB2 Universal Database Distributed Relational Database Architecture DRDA eServer Extended Services FFST First Failure Support Technology IBM IMS IMS/ESA iSeries LAN Distance MVS MVS/ESA MVS/XA Net.Data NetView OS/390 OS/400 PowerPC pSeries QBIC QMF RACF RISC System/6000 RS/6000 S/370 SP SQL/400 SQL/DS System/370 System/390 SystemView Tivoli VisualAge VM/ESA VSE/ESA VTAM WebExplorer WebSphere WIN-OS/2 z/OS zSeries Trademarks of Other Companies The following terms are trademarks or registered trademarks of other companies and have been used in at least one of the documents in the DB2 UDB documentation library: Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Intel and Pentium are trademarks of Intel Corporation in the United States, other countries, or both. Solaris, Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. HP-UX is a trademark of Hewlett-Packard. Linux is a trademark of Linux Torvalds. Other company, product, or service names may be trademarks or service marks of others. (C) COPYRIGHT INTERNATIONAL BUSINESS MACHINES CORPORATION 1993 - 2003. ALL RIGHTS RESERVED.