This Users Guide explains how to use the Enhanced Full-Text Search Specialty Data Store product with Sybase® Adaptive Server® Enterprise. The features and functionality of the enhanced version of this product are described in this book.
This book is for System Administrators who are configuring Adaptive Server for an Enhanced Full-Text Search Specialty Data Store and for users who are performing full-text searches on Adaptive Server data.
This book includes these chapters:
Chapter 1, “Introduction,” provides an overview of the Enhanced Full-Text Search Specialty Data Store.
Chapter 2, “Understanding the Enhanced Full-Text Search Engine,” describes the components of the Enhanced Full-Text Search Specialty Data Store and how it works.
Chapter 3, “Configuring Adaptive Server for Full-Text Searches,” describes how to configure Adaptive Server so that Enhanced Full-Text Search Specialty Data Store can perform full-text searches on the databases.
Chapter 4, “Setting Up Verity Functions,” describes the setup you need to do before you can issue full-text search queries.
Chapter 5, “Writing Full-Text Search Queries,” describes the components you use to write full-text search queries.
Chapter 6, “System Administration,” provides information about system administration issues.
Chapter 7, “Performance and Tuning,” provides information about performance and tuning issues.
Chapter 8, “Verity Topics,” provides information about configuring the Verity engine.
Appendix A, “System Procedures,” describes Enhanced Full-Text Search Specialty Data Store system procedures.
Appendix B, “Sample Files,” contains the text of the textsvr.cfg file, describes the sample files included with Enhanced Full-Text Search Specialty Data Store, and discusses issues regarding the sample_text_main.sql script.
Appendix C, “Unicode Support,” describes how to configure Enhanced Full Text Search Specialty Data Store to use Unicode.
Appendix D, “Working with XML data,” provides the correct format for XML data indexed into text indexes using fields and zones, and samples of using such data.
The Sybase® Adaptive Server® Enterprise documentation set consists of the following:
The release bulletin for your platform – contains last-minute information that was too late to be included in the books.
A more recent version of the release bulletin may be available on the World Wide Web. To check for critical product or document information that was added after the release of the product CD, use the Sybase Technical Library.
The Installation Guide for your platform – describes installation, upgrade, and configuration procedures for all Adaptive Server and related Sybase products.
What’s New in Adaptive Server Enterprise? – describes the new features in Adaptive Server version 15.0, the system changes added to support those features, and changes that may affect your existing applications.
ASE Replicator Users Guide – describes how to use the Adaptive Server Replicator feature of Adaptive Server to implement basic replication from a primary server to one or more remote Adaptive Servers.
Component Integration Services Users Guide – explains how to use the Adaptive Server Component Integration Services feature to connect remote Sybase and non-Sybase databases.
Configuring Adaptive Server Enterprise for your platform – provides instructions for performing specific configuration tasks for Adaptive Server.
Full-Text Search Specialty Data Store Users Guide – describes how to use the Full-Text Search feature with Verity to search Adaptive Server Enterprise data.
Glossary – defines technical terms used in the Adaptive Server documentation.
Historical Server Users Guide – describes how to use Historical Server to obtain performance information for SQL Server® and Adaptive Server.
Java in Adaptive Server Enterprise – describes how to install and use Java classes as data types, functions, and stored procedures in the Adaptive Server database.
Job Scheduler User's Guide – provides instructions on how to install and configure, and create and schedule jobs on a local or remote Adaptive Server using the command line or a graphical user interface (GUI).
Monitor Client Library Programmer’s Guide – describes how to write Monitor Client Library applications that access Adaptive Server performance data.
Monitor Server Users Guide – describes how to use Monitor Server to obtain performance statistics from SQL Server and Adaptive Server.
Performance and Tuning Guide – is a series of four books that explains how to tune Adaptive Server for maximum performance:
Basics – the basics for understanding and investigating performance questions in Adaptive Server.
Locking – describes how the various locking schemas can be used for improving performance in Adaptive Server.
Optimizer and Abstract Plans – describes how the optimizer processes queries and how abstract plans can be used to change some of the optimizer plans.
Monitoring and Analyzing – explains how statistics are obtained and used for monitoring and optimizing performance.
Quick Reference Guide – provides a comprehensive listing of the names and syntax for commands, functions, system procedures, extended system procedures, datatypes, and utilities in a pocket-sized book.
Reference Manual – is a series of four books that contains the following detailed Transact-SQL® information:
Building Blocks – Transact-SQL datatypes, functions, global variables, expressions, identifiers and wildcards, and reserved words.
Commands – Transact-SQL commands.
Procedures – Transact-SQL system procedures, catalog stored procedures, system extended stored procedures, and dbcc stored procedures.
Tables – Transact-SQL system tables and dbcc tables.
System Administration Guide – provides in-depth information about administering servers and databases. This manual includes instructions and guidelines for managing physical resources, security, user and system databases, and specifying character conversion, international language, and sort order settings.
System Tables Diagram – illustrates system tables and their entity relationships in a poster format. Available only in print version.
Transact-SQL Users Guide – documents Transact-SQL, Sybase’s enhanced version of the relational database language. This manual serves as a textbook for beginning users of the database management system. This manual also contains descriptions of the pubs2 and pubs3 sample databases.
Using Adaptive Server Distributed Transaction Management Features – explains how to configure, use, and troubleshoot Adaptive Server DTM features in distributed transaction processing environments.
Using Sybase Failover in a High Availability System – provides instructions for using Sybase’s Failover to configure an Adaptive Server as a companion server in a high availability system.
Unified Agent and Agent Management Console – Describes the Unified Agent, which provides runtime services to manage, monitor and control distributed Sybase resources.
Utility Guide – documents the Adaptive Server utility programs, such as isql and bcp, which are executed at the operating system level.
Web Services Users Guide – explains how to configure, use, and troubleshoot Web Services for Adaptive Server.
XA Interface Integration Guide for CICS, Encina, and TUXEDO – provides instructions for using the Sybase DTM XA interface with X/Open XA transaction managers.
XML Services in Adaptive Server Enterprise – describes the Sybase native XML processor and the Sybase Java-based XML support, introduces XML in the database, and documents the query and mapping functions that comprise XML Services.
Use the Sybase Getting Started CD, the SyBooks CD, and the Sybase Product Manuals Web site to learn more about your product:
The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the SyBooks CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks CD contains product manuals and is included with your software. The Eclipse-based SyBooks browser allows you to access the manuals in an easy-to-use, HTML-based format.
Some documentation may be provided in PDF format, which you can access through the PDF directory on the SyBooks CD. To read or print the PDF files, you need Adobe Acrobat Reader.
Refer to the SyBooks Installation Guide on the Getting Started CD, or the README.txt file on the SyBooks CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is an online version of the SyBooks CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.
To access the Sybase Product Manuals Web site, go to Product Manuals.
Technical documentation at the Sybase Web site is updated frequently.
Finding the latest information on product certifications
Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list and click Go.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.
Finding the latest information on component certifications
Point your Web browser to Availability and Certification Reports.
Either select the product family and product under Search by Product; or select the platform and product under Search by Platform.
Select Search to display the availability and certification report for the selection.
Creating a personalized view of the Sybase Web
site (including support pages)
Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.
Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.
Finding the latest information on EBFs and software maintenance
Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBFs/Maintenance releases is displayed.
Padlock icons indicate that you do not have download authorization for certain EBFs/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBFs/Maintenance report, or click the product description to download the software.
Directory paths For readability, directory paths in this manual are in UNIX format. On Windows NT, substitute $SYBASE with %SYBASE% and replace slashes (/) with backslash (\). For example, replace this user input:
$SYBASE/$SYBASE_FTS/scripts
with:
%SYBASE%\%SYBASE_FTS%\scripts
Formatting SQL statements SQL is a free-form language: there are no rules about the number of words you can put on a line or where you must break a line. However, for readability, all examples and syntax statements in this manual are formatted so that each clause of a statement begins on a new line. Clauses that have more than one part extend to additional lines, which are indented.
SQL syntax conventions The conventions for syntax statements in this manual are as follows:
Key |
Definition |
|---|---|
command |
Command names, command option names, utility names, utility flags, and other keywords are in bold Courier in syntax statements and in bold Helvetica in paragraph text. |
variable |
Variables, or words that stand for values that you fill in, are in italics. |
|
Curly braces indicate that you choose at least one of the enclosed options. Do not include braces in your option. |
|
Brackets mean choosing one or more of the enclosed options is optional. Do not include brackets in your option. |
|
Parentheses are to be typed as part of the command. |
| |
The vertical bar means you may select only one of the options shown. |
, |
The comma means you may choose as many of the options shown as you like, separating your choices with commas to be typed as part of the command. |
Syntax statements (displaying the syntax and all options for a command) are printed like this:
sp_dropdevice [device_name]
or, for a command with more options:
select column_name from table_name where search_conditions
In syntax statements, keywords (commands) are in normal font and identifiers are in lowercase: normal font for keywords, italics for user-supplied words.
Examples showing the use of Transact-SQL commands are printed like this:
select * from publishers
Examples of output from the computer are printed like this:
pub_id pub_name city state ------- ------------------- ----------- ----- 0736 New Age Books Boston MA 0877 Binnet & Hardley Washington DC 1389 Algodata Infosystems Berkeley CA (3 rows affected)
Case In this manual, most of the examples are in lowercase. However, you can disregard case when typing Transact-SQL keywords. For example, SELECT, Select, and select are the same.
Adaptive Server’s sensitivity to the case of database objects, such as table names, depends on the sort order installed on Adaptive Server. You can change case sensitivity for single-byte character sets by reconfiguring the Adaptive Server sort order.
Obligatory options {you must choose at least one}
Curly Braces and Vertical Bars: Choose one and only one option.
{die_on_your_feet | live_on_your_knees | live_on_your_feet}
Curly Braces and Commas: Choose one or more options. If you choose more than one, separate your choices with commas.
{cash, check, credit}
Optional options [you do not have to choose any]
One Item in Square Brackets: You don’t have to choose it.
[anchovies]
Square Brackets and Vertical Bars: Choose none or only one.
[beans | rice | sweet_potatoes]
Square Brackets and Commas: Choose none, one, or more than one option. If you choose more than one, separate your choices with commas.
[extra_cheese, avocados, sour_cream]
Ellipsis: Do it again (and again)... An ellipsis (...) means that you can repeat the last unit as many times as you like. In this syntax statement, buy is a required keyword:
buy thing = price [cash | check | credit]
[, thing = price [cash | check | credit] ]...
You must buy at least one thing and give its price. You may choose a method of payment: one of the items enclosed in square brackets. You may also choose to buy additional things: as many of them as you like. For each thing you buy, give its name, its price, and (optionally) a method of payment.
This document is available in an HTML version that is specialized for accessibility. You can navigate the HTML with an adaptive technology such as a screen reader, or view it with a screen enlarger.
This version of the Enhanced Specialty Data Store and the HTML documentation have been tested for compliance with U.S. government Section 508 Accessibility requirements. Documents that comply with Section 508 generally also meet non-U.S. accessibility guidelines, such as the World Wide Web Consortium (W3C) guidelines for Web sites.
The online help for this product is also provided in HTML, which you can navigate using a screen reader.
You might need to configure your accessibility tool
for optimal use. Some screen readers pronounce text based on its
case; for example, they pronounce ALL UPPERCASE TEXT as initials,
and MixedCase Text as words. You might find it helpful to configure
your tool to announce syntax conventions. Consult the documentation
for your tool.
For information about how Sybase supports accessibility, see Sybase Accessibility. The Sybase Accessibility site includes links to information on Section 508 and W3C standards.
