Cleaning up Collections - Full-Text Retrieval (FTR) - Help

Full-Text Retrieval (FTR) Help

Language
English
Product
Full-Text Retrieval (FTR)
Search by Category
Help

Sometimes, such as when a system crashes due to a power outage, FTR collections can contain invalid rows. These invalid rows, as they accumulate over time, can impact FTR performance. To remove any invalid rows in a collection, use the ftrclnup utility.

When you start this utility, ftrclnup makes a copy of the collection files in the ftrclnup subdirectory of the collection directory. The utility deletes all invalid rows in the collection, and then attempts to re-index the collection after it completes the cleanup. If re-indexing fails for any reason, the utility displays a command you can enter in ExecSQL to re-index the collection. Cleanup of a collection can take several hours, depending on the size of the collection.

Before You Begin Collection Cleanup

Before you begin collection cleanup, perform the following steps.

  • Stop the Directa Network and Services.

  • Make a backup copy of the collection files to be cleaned up.

    The ftrclnup utility will also make a backup copy of the collection files in the ftrclnup subdirectory.

  • Set the environment variable ORACLE_HOME to point to the Oracle installation directory. For example, set ORACLE_HOME=d:\orant will allow the ftrclnup utility to look for d:\orant\bin as the Oracle bin directory.

ftrclnup

PURPOSE

Remove any duplicate or non-existent rows in the FTR collection.

SYNTAX

ftrclnup [-?] [-s <ODBC data source>] [-p <password>] [-d <debug level>] <Collection Name>

ARGUMENTS

-?

Print a brief usage statement

-s ODBC data source

Allows you to set the ODBC data source used by the collection cleanup utility. The default ODBC data source is SearchServer_6.5. It is unlikely that you will need to specify a different ODBC data source.

-b password

Password for Oracle database (default is "oracle"). This password is used to connect to the Oracle database.

-d debug level

Causes the collection cleanup utility to log information to the file %TEMP%\ftrclnup.pid, where pid is the process ID of the collection cleanup utility. Use an integer number between 1 (least verbose) to 4 (most verbose).

Collection Name

This is the name of the local collection that you want to clean up. When the collection name is omitted, ftrclnup utility displays a list of local collections from which you can select.

To convert existing collections, run ftrclnup by selecting the Intergraph FTR Ftrclnup entry in the FTR start menu or by typing ftrclnup at a DOS command prompt.

EXAMPLES

The following examples illustrate the use of ftrclnup:

  • ftrclnup = Displays a list of local collections (my_collection) that you can clean up.

  • ftrclnup my_collection = Cleans up the my_collection collection.

  • ftrclnup -p newpw my_collection = Cleans up the my_collection collection, using 'newpw' as Oracle database password.