+--- NOTE! ----------------------------------------------------------+ | | | Before using this information and the product it supports, be sure | | to read the general information under "Notices" | | | +--------------------------------------------------------------------+ This document contains proprietary information of IBM. It is provided under a license agreement and is protected by copyright law. The information contained in this publication does not include any product warranties and any statements provided in this manual should not be interpreted as such. Requests for publications and for technical information about IBM products should be made to your IBM software reseller or contact the IBM office nearest you. IBM is a registered trademark of International Business Machines Corporation, Armonk, N.Y. (C) COPYRIGHT INTERNATIONAL BUSINESS MACHINES CORPORATION 2001. ALL RIGHTS RESERVED. Note to U.S. Government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp. CONTENTS ________ ABOUT THE DB2 NET SEARCH EXTENDER INSTALLATION INSTRUCTIONS MIGRATION TRY & BUY QUICK GUIDE TO GETTING STARTED DB2 NET SEARCH EXTENDER NOTES NOTICES TRADEMARKS ABOUT THE DB2 NET SEARCH EXTENDER _________________________________ Welcome to the IBM* DB2 Universal Database* (DB2*) Net Search Extender Version 7.2 For further details on DB2 Net Search Extender please check the nsdoc.pdf file for Adobe Acrobat Reader included in the package. INSTALLATION INSTRUCTIONS _________________________ REQUIREMENTS DB2 Net Search Extender prerequires the installation of DB2 Enterprise Edition Version 7.1 . Currently, the installation of DB2 V7.1 Fixpak 2 is recommended. NOTE: If you are upgrading from a previous version of DB2 Net Search Extender to version 7.2, you have to deactivate all indexes before upgrading. Use the DB2NX DEACTIVATE INDEX command for that. INSTALLING THE DB2 NET SEARCH EXTENDER ON AIX 4 _______________________________________________ 1. Install the product component on the target machine. 2. Establish the DB2 Net Search Extender instance. STEP 1 - INSTALL THE PRODUCT COMPONENT ON THE TARGET MACHINE 1. Log in at the target machine as the root user. 2. Use installp to transfer the files from the Package to the target machine. You can use the System Management Interface tool (SMIT) to run installp from a prompted interface, or you can enter the installp command. To run smit: a. Enter 'smit install_latest' to open The Software Installation and Maintenance Tool menu. b. Enter the directory of the install file in the 'INPUT device / directory for software' field. //aix where is your cdrom drive path. c. Click the DO button or press ENTER. This confirms the installation directory. d. Identify in the SOFTWARE TO INSTALL field the DB2 Net Search Extender component to be installed. e. Click the DO button or press ENTER. f. You are prompted for confirmation of the installation parameters. To confirm, press ENTER. g. If you don't see the registration screen during install please set your DISPLAY variable and call /usr/lpp/db2nx_07_01/register 3. Logout. STEP 2 - ESTABLISH THE DB2 NET SEARCH EXTENDER INSTANCE 1. Stop the db2instance you like to work with: db2stop 2. Ensure you are active as the root user. 3. Enter: cd /usr/lpp/db2nx_07_01/instance 4. Run nxicrt as follows: ./nxicrt __________ where is an existing DB2 instance user ID. ___________ Running nxicrt creates the directory db2nx under the home directory of the DB2 instance user ID. Do not create additional files or directories under ~/db2nx; these files will be lost if the instance is deleted. A db2iupdt command will be done during this call to ensure the transfer of the license file. 5. Logout. INSTALLING DB2 NET SEARCH EXTENDER ON WINDOWS NT _________________________________________ 1. Use the setup.exe to transfer the files from the installation package to the target machine. 2. Reboot the system after data transfer. 3. Call nxstart.bat to start a DB2 Net Search Extender daemon process. If the daemon process is not available Net Search Extender queries cannot be performed. If the daemon has been stopped (system reboot,etc.) you have to call nxstart.bat and activate all indexes again. 4. To deinstall the product use the Add/Remove Program icon in the Control Panel. INSTALLING THE DB2 NET SEARCH EXTENDER ON SUNOS 5.6 AND 5.7 ___________________________________________________________ 1. Install the product component in the target machine. 2. Establish the DB2 Net Search Extender. STEP 1 - INSTALL THE PRODUCT COMPONENTS IN THE TARGET MACHINE 1. Log in at the target machine as the root user. 2. Install the Package You install packages with the 'pkgadd' command. Install packages with the following command: pkgadd -d //solaris/ibmnets.pkg where is your cdrom drive path. The list of available packages is displayed from which you can choose the 'IBMNETS' package. STEP 2 - ESTABLISH THE DB2 NET SEARCH EXTENDER INSTANCE 1. Stop the db2instance you like to work with: db2stop 2. Ensure you are active as the root user. 3. Enter: cd /opt/IBMdb2nx/V7.1/instance 4. Run nxicrt as follows: ./nxicrt __________ where is an existing DB2 instance user ID. ___________ Running nxicrt creates the directory db2nx under the home directory of the DB2 instance user ID. Do not create additional files or directories under ~/db2nx; these files will be lost if the instance is deleted. A db2iupdt command will be done during this call to ensure the transfer of the license file. 5. Logout. INSTALLING THE DB2 NET SEARCH EXTENDER ON HP-UX 11 ___________________________________________________________ 1. Install the product component in the target machine. 2. Establish the DB2 Net Search Extender. STEP 1 - INSTALL THE PRODUCT COMPONENTS IN THE TARGET MACHINE 1. Log in at the target machine as the root user. 2. Install the Package You install packages with the 'swinstall' command. Install packages with the following command: /usr/bin/swinstall -s : DB2NSE where is the fully qualified hostname of the machine where you install DB2 Net Search Extender and is the full pathname of the DB2NSE72.pkg file Alternatively you can use SAM to locate the package file and select DB2NSE as the software to be installed. See you system documentation for details on how to use SAM. STEP 2 - ESTABLISH THE DB2 NET SEARCH EXTENDER INSTANCE 1. Stop the db2instance you like to work with: db2stop 2. Ensure you are active as the root user. 3. Enter: cd /opt/IBMdb2nx/V7.1/instance 4. Run nxicrt as follows: ./nxicrt __________ where is an existing DB2 instance user ID. ___________ Running nxicrt creates the directory db2nx under the home directory of the DB2 instance user ID. Do not create additional files or directories under ~/db2nx; these files will be lost if the instance is deleted. A db2iupdt command will be done during this call to ensure the transfer of the license file! 5. Logout. MIGRATION _________ If you have created indexes under DB2 Net Search Extender 7.1.3, you can migrate them for use under version 7.1.3 Deactivate your indexes prior to installing version 7.2. If your indexes were created with an ORDER BY statement, migration is simply done by using the DB2NX ACTIVATE INDEX command. If your indexes did not use a pre-sorted order of the in-memory table, it is necessary that you do a DB2NX UPDATE INDEX command for each index that you want to keep using. This is necessary, since DB2 Net Search Extender now uses an implicit ORDER BY if no ORDER BY is used during ENABLE TEXT COLUMN. Otherwise the correctness of search results involving numeric indexes could not be guaranteed (see the section on fixed defects in this fixpack below). TRY & BUY _________ If you are using the Try & Buy version you can use the product for 90 days for evaluation purposes. After that no further admin operations are possible. For an upgrade to a full license please contact your IBM representative. CHANGES/FIXES PROVIDED WITH DB2 NET SEARCH EXTENDER VERSION 7.2 _________________________________________________________________ New features in DB2 Net Search Extender version 7.2: -- additional platform support for Linux -- incremental index update Defects fixed in DB2 Net Search Extender 7.2 : DB2 NET SEARCH EXTENDER NOTES _____________________________ 1. The described unique key column in the documentation is not needed if you intend to do searches only with the "In Memory Tables" and not within DB2. 2. If you face problems with the DB2 Net Search Extender license (provided you are using the Full Licence Version) you can list the current license with the call: db2licm -l To add the license again call: db2licm -a db2nse.lic (the db2nse.lic file can be found in the install directory) On AIX and Solaris you can also try to update your db2 instance with: db2iupdt and check your nodelock file under /var/ifor or /var/lum If you are using the Try&Buy Version you need to upgrade to the full license version after the end of the 90 days evaluation period if you want to continue to use Net Search Extender. 3. If you get the following error message during search: SQL0104N An unexpected token "VALUES) as " was found ... please check that the startRow is not equal to the resultsize. The startRow default value is 0. 4. When installing a new version of DB2 you have to rebind the two bind files against your database: db2 connect to db2 bind desfpssp.bnd db2 bind desfpiiu.bnd The files are located in the /db2nx/bnd (UNIX) or in \bnd (Windows) directory. 5. The stored procedure is registered with the instance owner schema. In order to do searches with a different userid it is necessary that you qualify your stored procedure with the schema of the instance owner. 6. Using large datasets and high values of maxHitCount could lead to out of memory errors during search. To avoid this problem reduce the maxHitCount value. 8. The attribute value is related to the tag order during ENABLE TEXT COLUMN, i.e. use 'attribute(1)' for searches against the first numeric column, attribute(2) for the second, etc. 9. The relational operators & (AND), | (OR), & NOT ( AND NOT) can be used between numeric search terms. 10. When choosing names for indexes, databases, columns make sure that they are not keywords of any of the db2nx commands ( i.e. do not call them 'index' 'numeric' 'optimize' etc.) 11. If you receive an error DES7302N during search and the message associated with this error says 'index does not exists' check whether you issued a numeric search, but did not enable a numeric index. 12. The length of the search argument is limited to 1000 bytes. 13. The output variable totalDocs of the stored procedure does not always reflect the number of documents returned. In particular, this is the case if the query combines a textual search with an SQL statement. In this case the value of totalDocs is the the total number of documents qualified by the query term. The subsequent SQL statement can increase or decrease the result set without reflecting this in a change of the value of totalDocs. 14. The syntax diagram for the UPDATE command on page 77 of the documentation shows square brackets surrounding the INCREMENTAL, REORG, and COMMITCOUNT keywords. These keywords have to be used without the square brackets. 15. There are limits to the total size of shared memory segments. In the incremental update scenario this limit affects the number of updates which Net Search Extender can handle before an UPDATE is obligatory. On a system that has a limit of 2 GB (like AIX), a maximum of approx. 33 million document updates can be handled that way, provided that enough overall memory is available. 15. On Linux, the settings for shared memory limits (SHMMAX) can be updated at runtime, but are reset after a reboot. To establish the new values permanently, a change to /usr/src/linux/include/asm-i386/shmparam.h followed by a kernel recompile is required. 16. The following limits apply: - the maximum number of numeric columns you can index is 20 - the maximum number of columns you can optimize on is 25 - the maximum length of pathnames for the index and the temporary directory is 128 characters. 17. There are two more factors that contribute to the amount of memory needed for indexing: - each document occupies 64 byte in the administrative block in shared memory block - if incremental update is enabled, 50% of the above space (i.e. half the number of rows times 64 bytes) is allocated as a reserve for documents to be added incrementally WINDOWS only ____________ 1. Due to an internal limitation in DB2 Net Search Extender, only DB2 schema names with a length of max. 8 chars work reliably together with DB2 Net Search Extender. Note that the default schema name is the logon UserID, which may in some cases be longer than 8 characters (e.g. 'Administrator'). If that condition is not met, the error message you receive during enabling a text column is: "CLI0002W Data truncated. " 2. After system shutdown or nxstop you have to call "nxclean databasename". Otherwise you will get wrong information with: "db2nx get index status ...". 3. NT could currently not handle system load with more than 40 parallel DB2 dari processes and In-memory tables greater then 500 MB. A "index not activated" message will be displayed. To avoid this message you could work with datasource = 1 and no optimize on columns. 4. Using UNIX notation for path specification like d:/myindex/ on NT leads to not cleaning up the index files correctly. 5. Do not use blanks in the DB2 Net Search Extender installation path. 6. If your database contains columns with CLOBs, you have to increase the DB2 parameter APP_CTL_HEAP_SZ depending on the size of the CLOBs. UNIX only _________ 1. After instance creation only the .profile will be updated. If the instance owner works with a UNIX shell not using .profile following environment variables should be set: DB2NX_INSTOWNERHOMEDIR=// PATH=$PATH:DB2NX_INSTONWERHOMEDIR/db2nx/bin where $PATH = your existing PATH variable 2. If you put your text data into the "In Memory Tables" the default limits for the user should be increased to avoid out of memory error during indexing. On AIX, to do this change to the /etc/security directory and change following values of the limits file: data = -1 rss = -1 stack = -1 for not imposing any limits on the usage of these resources. Limit them appropriately, if your system environment requires it. For HP-UX, Solaris, and Linux, please refer to the documentation of your operating system on how to achieve the same effect. NOTICES _______ This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other 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 500 Columbus Avenue Thornwood, NY 10594 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country 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 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. 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 which has been exchanged, should contact: IBM Corporation W92/H3 555 Bailey Avenue P.O. Box 49023 San Jose, CA 95161-9023 U.S.A. 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 information 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. TRADEMARKS __________ The following terms are trademarks of the IBM Corporation in the United States or other countries or both. +-------------------------------------+-------------------------------------+ | AIX | DB2 Universal Database | +---------------------------------------------------------------------------+ | DB2 | IBM | +-------------------------------------+-------------------------------------+ | DB2 Net Search Extender Net.Data | +-------------------------------------+-------------------------------------+ Microsoft, Windows, Windows NT, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation. 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 in the United States and other countries licensed exclusively through X/Open Company limited. Other company, product, and service names may be trademarks or service marks of others.