Download as pdf or txt
Download as pdf or txt
You are on page 1of 16

Document ID: 74011-01-1192-01

Last Revised: September 15, 1998

Installation and Release Bulletin


Full-Text Search Specialty Data Store
Version 11.9.2 for HP 9000/800 HP-UX

Table of Contents
1. Accessing Current Installation and Release Bulletin Information 1
2. Product Summary 2
3. Installation Instructions (Enhanced Version Only) 2
4. Configuring the Full-Text Search Engine 7
5. Upgrade Instructions 10
6. What’s New in the Enhanced Version 10
7. Known Problems 11
8. Documentation Updates and Clarifications 12
9. Technical Support 13
10. Other Sources of Information 14

1. Accessing Current Installation and Release Bulletin Information


A more recent version of this Installation and Release Bulletin may be
available on the World Wide Web. To check for critical product or
document information added after the release of the product CD, use
the Sybase Technical Library Product Manual Web site.
To access release bulletins at the Technical Library Product Manual
Web site:

Copyright © 1989–1998 by Sybase, Inc. All rights reserved. Sybase, the Sybase logo, Data Workbench, InfoMaker, PowerBuilder,
Powersoft, SQL Advantage, SQL Debug, Transact-SQL, Adaptive Server, Adaptive Server Anywhere, Adaptive Server Enterprise
Monitor, Adaptive Server IQ, ADA Workbench, AnswerBase, APT-Build, APT-Edit, APT-Execute, APT-Library, APT-Translator,
APT Workbench, Backup Server, Client-Library, DB-Library, dbQueue, DirectConnect, Distribution Agent, Embedded SQL, Enterprise
Client/Server, Enterprise Connect, InformationConnect, KnowledgeBase, MainframeConnect, MAP, Net-Gateway, NetImpact, Net-
Library, ObjectConnect, OmniConnect, OmniSQL Access Module, Open Client, Open ClientConnect, Open Client/Server, Open
Gateway, Open Server, Open ServerConnect, PC DB-Net, PowerDesigner, Replication Agent, Replication Driver, Replication Server,
Replication Server Manager, Report Workbench, RW-Library, Secure SQL Server, Security Guardian, SQL Anywhere, SQL Remote,
SQL Server, SQL Server Manager, SQL Toolset, Sybase Central, Sybase MPP, Sybase SQL Desktop, Sybase SQL Workgroup, SyBooks,
System 10, System 11, Watcom SQL, Web.SQL, WorkGroup SQL Server, XA-Library, XA-Server, and XP Server are trademarks of
Sybase, Inc. Other product names used herein may be trademarks or registered trademarks of Sybase or other companies. 1/98

1
Product Summary Full-Text Search SDS Version 11.9.2

1. Go to support.sybase.com.
2. Click the Electronic Support Services tab.
3. Under the Technical Library heading, choose Product Manuals.
4. Choose the appropriate version link.
5. In the right-hand window, choose the “platform” collection of
the product you are interested in.
6. In the right-hand window, choose the release bulletin for your
platform.

2. Product Summary
Full-Text Search Specialty Data Store version 11.9.2 for Sybase
Adaptive Server Enterprise is compatible with the following
platform and operating system configuration:
• HP 9000/800 HP-UX 11.0

2.1. Version Contents

There are two versions of the Full-Text Search Specialty Data Store:
• The Standard version is included with your purchase of Adaptive
Server Enterprise.
• The Enhanced version is purchased separately and has additional
capabilities.
The information in this Installation and Release Bulletin applies to both
versions.

3. Installation Instructions (Enhanced Version Only)


This section contains information about unloading Enhanced Full-
Text Search Specialty Data Store from the CD.

➤ Note
If you are using Standard Full-Text Search Specialty Data Store, install the
software from the Enterprise Data Studio distribution media, and proceed
to “Configuring the Full-Text Search Engine” on page 7.

2 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Installation Instructions (Enhanced Version Only)

3.1. Hardware and Software Requirements

To install and use the Full-Text Search Specialty Data Store, you must
have one of the following installed:
• Adaptive Server version 11.5.1 or later
• OmniConnect version 11.5.1 or later
The Full-Text Search Specialty Data Store requires the same
operating system and patches that are required by Adaptive Server
release 11.5.1.
You can install the Full-Text Search engine on a machine other than
the machine on which Adaptive Server is installed—if the two
machines have a shared drive.

Hardware Requirements
• Minimum of 64MB of RAM
• 90MB of disk space for the Full-Text Search engine and Verity
collections
• Twice the amount of space required by the text being indexed (for
example, if you have 100MB of text, you need 200MB of space)

3.2. Installation Directory Structure

When you unload the Full-Text Search engine from the CD, the sds
directory containing the Full-Text Search engine is installed in your
Sybase installation directory ($SYBASE).
The Full-Text Search engine installation directory is in
$SYBASE/sds/text and has the structure shown in Figure 1.

Release Bulletin for HP 9000/800 HP-UX 3


Installation Instructions (Enhanced Version Only) Full-Text Search SDS Version 11.9.2

bin Executable files (includes txtsvr.exe)

charsets Character set and sort order definition files


$
collections Stores the searchable text collections

S s t config Files required by Open Server

Y d e lib
Required static libraries needed to run
the Full-Text Search engine

B s x locales
Localization files for message language
support

A t sample
scripts SQL scripts and sample queries

source Files for getsend program


S
scripts Installation scripts

E verity Verity dynamic link libraries, messages,


filters, and utilities

install RUN_textsvr Runserver file for the Full-Text Search engine

textsvr.cfg Configuration file for the Full-Text Search


engine

Figure 1: Full-Text Search engine installation directory for UNIX platforms

Note that the RUN_textsvr file is copied to the $SYBASE/install


directory and the textsvr.cfg file is copied directly to the $SYBASE
directory.

3.3. Unloading Files from the CD

The Full-Text Search engine is on the Sybase product CD. Follow


these steps to unload the files from the CD:

4 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Installation Instructions (Enhanced Version Only)

1. Make sure the SYBASE environment variable is set to the Sybase


installation directory.
2. Place the Sybase product CD in the CD-ROM drive.
3. Log in as “root” to the UNIX system attached to the CD-ROM
drive. You must have “root” permission to mount the CD.
This login can be either local or remote. If you are running
sybsetup from a machine that is not attached to the CD-ROM, you
must log in remotely. If you login remotely:
- Verify that the DISPLAY environment is set to the machine on
which you are viewing sybsetup screens and output.
- Give the remote machine permission to display screens on
your local machine by entering the following command at the
UNIX prompt of your local machine:
xhost +
4. Mount the CD-ROM:
/etc/mount -F cdfs -o ro device_name /cdrom
where device_name is the CD-ROM drive device name and
/cdrom is the name of the directory where the CD is to be
mounted.

➤ Note
The location of the mount command is site specific, and might be different
than what is shown in these instructions. If you are unable to mount the CD-
ROM drive using the path shown, consult your operating system
documentation or contact your System Administrator.

5. Log out as “root”.


6. On the UNIX system attached to the CD-ROM drive, log in as
the “sybase” user.
7. The sybsetup utility is used to unload the software from the CD.
By default, the sybsetup utility is run from the CD. Optionally,
you can copy the sybsetup executable to your $SYBASE/bin
directory. Doing so allows you to run sybsetup and invoke the
configuration utilities from within the sybsetup graphical
interface. At the end of the unload process, sybsetup lets you copy
the sybsetup executable to the $SYBASE/bin directory.
To run the sybsetup utility from the CD, at the command prompt,
enter:

Release Bulletin for HP 9000/800 HP-UX 5


Installation Instructions (Enhanced Version Only) Full-Text Search SDS Version 11.9.2

device_name/sybsetup
where device_name is the CD-ROM drive device name.
For example:
/cdrom/sybasecd/sybsetup
The sybsetup dialog box appears.
8. Make sure the Sybase Directory box lists the directory into which
you want the Full-Text Search engine software to be unloaded
(this is the same as your $SYBASE directory). If it is not the
correct directory, enter the correct directory.
9. Select Unload Sybase Products in the sybsetup dialog box. sybsetup
displays the Installation Destination dialog box.
The Sybase Installation Directory box lists the directory into
which the software is to be unloaded. If it is not correct, enter the
correct directory.
10. Choose the check mark button. sybsetup displays the Installation
Source Device dialog box.
sybsetup displays the path to the image on the CD that contains
the compressed software image. The information is in the
format:
device_name/sybimage
where device_name is the CD-ROM drive device name.
If sybsetup does not display the information, enter the value. For
example:
/cdrom/sybasecd/sybimage
11. Choose the check mark button. sybsetup displays the Products
Selection dialog box, which lists the products available for
installation.
12. Select Enhanced Full Text Search SDS from the Available
Products list.
After you select the product, sybsetup lists the space required in
the Total Space Required window. If not enough space is
available, sybsetup issues a message warning of insufficient free
disk space. If there is insufficient space, see your System
Administrator about increasing the space necessary to install the
Full-Text Search engine.
13. Choose the check mark button. sybsetup displays the Install
Products? dialog box.

6 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Configuring the Full-Text Search Engine

14. Choose the check mark button to install the Full-Text Search
engine.
15. sybsetup displays the Installation Status dialog box, which
describes the progress of the Full-Text Search engine installation.
When the installation is complete, sybsetup displays an
“installation complete” message.
16. When you exit from sybsetup, log out as the “sybase” user.
17. Log in as “root”.
18. Unmount the CD-ROM:
/etc/umount /cdrom
19. Go to “Configuring the Full-Text Search Engine” below, to
configure the Full-Text Search engine.

4. Configuring the Full-Text Search Engine


This section describes how to configure the Full-Text Search engine.
The configuration process includes:
• Setting the SYBASE environment variable
• Using the srvbuild utility to:
- Add an entry to the interfaces file
- Edit the configuration file
- Create a runserver file

4.1. Setting the SYBASE Environment Variable

If you have not already done so, set the SYBASE environment
variable to point to the Sybase installation directory.

4.2. Using the srvbuild Utility

Follow these steps to configure the Full-Text Search engine:


1. Log in as the user “sybase”.
2. Start the srvbuild utility:
$SYBASE/bin/srvbuild
srvbuild displays the Select Servers to Build menu.

Release Bulletin for HP 9000/800 HP-UX 7


Configuring the Full-Text Search Engine Full-Text Search SDS Version 11.9.2

3. Choose Full-Text Search SDS. srvbuild activates the Server Name


box. The default server name that displays is the name of the
machine on which you installed the Full-Text Search engine.
4. Accept the default name or enter a new name in the Server
Name box.

➤ Note
The Full-Text Search engine is shipped with a default configuration file
named textsvr.cfg. This file is copied to $SYBASE when the software is
unloaded from the CD. If you do not name the Full-Text Search engine
“textsvr”, srvbuild creates a configuration file named server_name.cfg. For
example, if you enter KRAZYKAT as the name of your Full-Text Search
engine, srvbuild creates a configuration file named KRAZYKAT.cfg.

5. Choose OK. srvbuild displays the Server Attribute Editor dialog


box, where you select options for the configuration file and the
Full-Text Search engine entries for the interfaces file.
Following are the configuration file options—the only option
you must select is the error log path:
- Error log path – the full path name to the Full-Text Search
engine error log file. The default entry for the error log path is
$SYBASE/install/server_name.log.
- Collection directory – the location of the Verity collections. The
default location of the collections is
$SYBASE/sds/text/collections.
- Default database – the name of the database that contains the
metadata used by the Full-Text Search engine. The default
name is text_db. This database is created in Adaptive Server
and contains the vesaux and vesauxcol tables. You are only
naming the default database at this time; you will create the
database itself later, following the instructions in “Running the
installtextserver Script” on page 3-3 in the Full-Text Search
Specialty Data Store User’s Guide.
- Language – the language used by the Full-Text Search engine.
The default is us_english. Set the language parameter to the
same value as Adaptive Server.
- Character set – the character set used by the Full-Text Search
engine. The default is iso_1. The character set parameter
should be set to the same value as Adaptive Server.

8 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Configuring the Full-Text Search Engine

- Minimum number of sessions – defines the min_sessions


parameter, which specifies the minimum number of user
sessions for the Full-Text Search engine. The default is 10. For
more information about min_sessions, see “min_sessions and
max_sessions” on page 9-4.
- Maximum number of sessions – defines the max_sessions
parameter, which specifies the maximum number of user
sessions for the Full-Text Search engine. The default is 100. For
more information about max_sessions, see “min_sessions and
max_sessions” on page 9-4 in the Full-Text Search Specialty Data
Store User’s Guide.
You can adjust any of these options for a configuration that best
suits your site. srvbuild lists only the required configuration
parameters.
6. Edit the interfaces file. Select Transport Type, Host Name, and
Port Number:
- Transport Type – The network interface used by your system.
Select tli tcp or tcp spx.
- Host Name – the name of the machine on which you installed
the Full-Text Search engine.
- Port Number – the port number Adaptive Server uses to
connect to the Full-Text Search engine.
7. Choose the Build Server! button to build the Full-Text Search
engine. srvbuild displays the Status Output window, which
describes the process of building the Full-Text Search engine.
While building the Full-Text Search engine, srvbuild creates the
runserver and configuration files and also sets the SYBASE and
SHLIB_PATH environment variables.
8. Exit srvbuild.

4.3. Starting the Full-Text Search Engine

After srvbuild completes, the Full-Text Search engine is running, but is


not yet connected to Adaptive Server.

4.4. What’s Next

Go to “Configuring Adaptive Server for Full-Text Searches” on page


3-1 in the Full-Text Search Specialty Data Store User’s Guide to configure
the Adaptive Server to perform full-text searches.

Release Bulletin for HP 9000/800 HP-UX 9


Upgrade Instructions Full-Text Search SDS Version 11.9.2

5. Upgrade Instructions
The 11.9.2 version of both Standard and Enhanced Full-Text Search
Specialty Data Store is fully compatible with text indexes created
using the Standard Full-Text Search Specialty Data Store version 11.5.
To upgrade your Full-Text Search Specialty Data Store:
1. Shut down all of your Full-Text Search engines.
2. Install the 11.9.2 Standard or Enhanced Full-Text Search
Specialty Data Store over your existing installation.
3. Start the Full-Text Search engine.
4. Re-run the following installation scripts:
- installtextserver
- installmessages
- installevent
For instructions on how to run those installation scripts, see
“Configuring Adaptive Server for a Full-Text Search Engine” on
page 3-1 in the Full-Text Search Specialty Data Store User’s Guide.

6. What’s New in the Enhanced Version


The Enhanced Full-Text Search Specialty Data Store has all the
functionality of the Standard version, plus the following features:
• Topics – Allows you to assign complex queries to a topic and then
make it available to end users as a shared resource.
• Custom thesaurus – Allows you to create a custom thesaurus that
contains your application-specific synonyms.
• Clustering – Groups documents by subtopics to provide a sense
of the major subject areas covered by the documents in a cluster.
• Query-by-example – Finds documents similar to the documents
and phrases you include in a query.
• Additional system procedures:
- sp_text_dump_database – Creates a backup copy of the text indexes
in a database and, optionally, dumps the text_db and current
databases
- sp_text_load_index – Restores text indexes from a backup
- sp_text_configure – Displays or modifies the value of the Full-Text
Search engine configuration parameters

10 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Known Problems

- sp_help_text_index – Displays text indexes


- sp_text_optimize – Runs the Verity optimization routines
• Multiple sort specifications – Allows you to assign up to 16 sort
specifications to a sort_by pseudo column. The Standard version
allows only 1 sort specification.
• Brings text indexes online automatically – Provides a
configuration parameter to bring text indexes online
automatically. With the Standard version, you must issue
sp_text_online to bring text indexes online.
• Sample scripts and files – Includes several sample scripts and
files for setting up text indexes, configuring functionality, and
running queries.
• Text loading program – Includes the program getsend to load text
and image data into your database.
• Indexing of additional datatypes – Supports indexing of the
additional datatypes int, smallint, and tinyint.
• Unicode – Supports the character set utf8 for Unicode.

7. Known Problems
The following sections describe known problems with this version of
Full-Text Search Specialty Data Store.

7.1. Duplicate IDENTITY Column Values

If you execute sp_refresh_text_index and sp_text_notify several times for


the same source record, you may create duplicate IDENTITY values.
The Full-Text Search Specialty Data Store does not check for
duplicates in the IDENTITY column. Your user application should
ensure that there are no duplicate IDENTITY column values in a
Verity collection or index.

7.2. Using Multiple index_any Clauses

You use multiple index_any clauses in queries that have search items
of more than 255 characters. You cannot join multiple index_any
clauses using the or keyword. Because of Adaptive Server Bug
#140002, or clauses are not passed to the Full-Text Search engine. Use
the following method to rewrite a query that contains multiple

Release Bulletin for HP 9000/800 HP-UX 11


Documentation Updates and Clarifications Full-Text Search SDS Version 11.9.2

index_any clauses in which one or more clauses are joined by an or


keyword.
Specify a sequence number as the first word in an index_any clause.
This instructs the Full-Text Search engine to concatenate all index_any
clauses, based on the sequence number. The format of the sequence
number is “sn” where n is a number greater than 0.
For example, to change this query:
select i.score, t.name from index i, table t
where i.id = t.id and
index_any = 'apple <and> orange' OR
index_any = 'kumquat <and> lime'
use an and clause instead of an or clause:
select i.score, t.name from index i, table t
where i.id = t.id and
index_any = '<s1>apple <and> orange' AND
index_any = '<s2> <or> kumquat <and> lime'

7.3. Using Filters

Do not create a text index that contains more than one column, if the
text index must use a filter. This causes the Full-Text Search engine to
crash during sp_create_text_index processing.

7.4. Ignoring Error E0-0900

Occasionally, the Full-Text Search engine logs the following error


message when using collections that are on NFS-mounted devices:
Error E0-0900 (Io): Couldn't delete filespec
Ignore this error. The unused files will be deleted the next time the
text index is optimized.

8. Documentation Updates and Clarifications


This section contains updates to the Full-Text Search Specialty Data
Store User’s Guide.

12 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Technical Support

8.1. Location of the startserver Utility

“Starting the Full-Text Search Engine on UNIX” on page 6-1 should


say the startserver utility is included in the install directory of
Adaptive Server, not the bin directory.

8.2. Path Environment Variable in the Runserver File

“Creating the Runserver File” on page 6-1 states that you must
include the LD_LIBRARY_PATH environment variable in the
runserver file. It should say to include the correct path environment
variable for your platform in the runserver file. Table 1 shows the
path environment variable to use for each platform.

Table 1: Path environment variable for the runserver file

Platform Environment Variable


HP 9000(800) SHLIB_PATH
RS/6000 AIX LIBPATH
Sun Solaris LD_LIBRARY_PATH
Digital UNIX LD_LIBRARY_PATH

For example, the runserver file on HP for a Full-Text Search engine


named KRAZYKAT would be RUN_KRAZYKAT and would be
similar to:
#!/bin/sh
#
SYBASE=$SYBASE/sds/text
export SYBASE

SHLIB_PATH="$SYBASE/lib:$SHLIB_PATH"
export SHLIB_PATH

$SYBASE/bin/txtsvr -SKRAZYKAT

9. Technical Support
Each Sybase installation that has purchased a support contract has
one or more designated people who are authorized to contact Sybase
Technical Support. If you have any questions about this installation
or if you need assistance during the installation process, ask the

Release Bulletin for HP 9000/800 HP-UX 13


Other Sources of Information Full-Text Search SDS Version 11.9.2

designated person to contact Sybase Technical Support or the Sybase


subsidiary in your area.

10. Other Sources of Information


Use the Sybase Technical Library CD and the Technical Library Web
site to learn more about your product:
• Technical Library CD contains product manuals and technical
documents and is included with your software. The DynaText
browser (included on the Technical Library CD) allows you to
access technical information about your product in an easy-to-
use format.
Refer to the Technical Library Installation Guide in your
documentation package for instructions on installing and
starting Technical Library.
• Technical Library Web site includes the Product Manuals site,
which is an HTML version of the Technical Library CD that you
can access using a standard Web browser. In addition, you’ll find
links to the Technical Documents Web site (formerly known as
Tech Info Library), the Solved Cases page, and Sybase/Powersoft
newsgroups.
To access the Technical Library Web site, go to
support.sybase.com, click the Electronic Support Services tab,
and select a link under the Technical Library heading.

10.1. Sybase Certifications on the Web

Technical documentation at the Sybase Web site is updated


frequently.

For the latest information on product certifications and/or the EBF Rollups:
1. Point your Web browser to Technical Documents at the
following Web site:
techinfo.sybase.com
2. In the Browse section, click on the Hot entry.
3. Explore your area of interest: Hot Docs covering various topics,
or Hot Links to Technical News, Certification Reports, Partner
Certifications, and so on.

14 Release Bulletin for HP 9000/800 HP-UX


Full-Text Search SDS Version 11.9.2 Other Sources of Information

If you are a registered SupportPlus user:


1. Point your Web browser to Technical Documents at the
following Web site:
techinfo.sybase.com
2. In the Browse section, click on the Hot entry.
3. Click on the EBF Rollups entry.
You can research EBFs using Technical Documents, and you can
download EBFs using Electronic Software Distribution (ESD).
4. Follow the instructions associated with the SupportPlusSM
Online Services entries.

If you are not a registered SupportPlus user and you want to become one:
You can register by following the instructions on the Web.
To use SupportPlus, you need:
• A Web browser that supports the Secure Sockets Layer (SSL),
such as Netscape Navigator 1.2 or later
• An active support license
• A named technical support contact
• Your user ID and password

Whether or not you are a registered SupportPlus user:


You can use Sybase’s Technical Documents. Certification Reports are
among the features documented at this site.
1. Point your Web browser to Technical Documents at the
following Web site:
techinfo.sybase.com
2. In the Browse section, click on the Hot entry.
3. Click on the topic that interests you.

Release Bulletin for HP 9000/800 HP-UX 15


Other Sources of Information Full-Text Search SDS Version 11.9.2

16 Release Bulletin for HP 9000/800 HP-UX

You might also like