Administration tool for Db2 Text Search

The administration tool is a command-line tool that provides a convenient way to do several administrative tasks that are related to Db2 Text Search.

You can use the administration tool to complete the following tasks:
  • Check the status and properties of text search collections
  • Optimize text search collections
  • Delete orphaned text search collections
  • Report the version of the server
The text search instance services must be running for the Administration Tool to remove text search collections. You must append the .sh suffix to all stand-alone Db2 Text Search server tools on supported platforms unless mentioned otherwise, for example, adminTool.sh.

Tool syntax

Read syntax diagramSkip visual syntax diagramadminTool -configPathabsolute-path-to-config-folder -localelocale-stringstatus -collectionPathpath -collectionNamecollection-name delete -collection-locationoptimize -collection-locationoptimizeIndexStatus -collection-location versionsupportedClientVersionsconfigureTrace -traceonofflogLevellevel printTracehelp
collection-location
Read syntax diagramSkip visual syntax diagram-collectionPathcollection-path-collectionNamecollection-name

Parameters

status
Provides the status of a text search collection, including the index size, the number of documents present, and the progress of index updates.

-collectionName collection-name
Specifies the text search collection for which you want the status printed.

version
Displays the version of the server in the following format:
version.release.modification.fixpack-protocol-build
  • The version.release.modification.fixpack is the standard version number convention that is used by IBM products.
  • The protocol is the number that is used to serialize request arguments and data between the server and client.
  • The build is the number that indicates the server build.
The following example indicates server version 1, protocol 1.1, and build 290.
1.0.0.0-1.1-290
supportedClientVersions
Prints the list of supported client versions.
configureTrace
Enables or disables tracing.
trace
  • ON: changes the logging level to FINEST
  • OFF: changes the logging level to INFO
The trace parameter is deprecated. Use the configureTrace -logLevel instead.
logLevel
  • level
    Specifies one of the following log levels:
    • OFF
    • SEVERE
    • WARNING
    • INFO
    • CONFIG
    • FINE
    • FINER
    • FINEST
    • ALL
printTrace
Prints the current trace setting.
configPath absolute-path-to-config-folder
Specifies the absolute path to the text search configuration folder.
locale five-char-locale-string
Specifies the five character locale for writing any error messages that are returned during the use of the tool. If you do not specify this parameter, the server locale is used.
help
Prints the Administration Tool command usage. The usage information is also printed if you run the Administration Tool without a required argument.
collectionNamecollection-name
You must use this option only with orphaned collections. Ensure that the collection is not associated with a valid text index. Also do not delete a collection while documents are being indexed.
collectionPath collection-path
Specifies the full path to the directory where collections are stored.
delete
Deletes the text search collection specified by collectionName
optimizeIndex
Optimizes the specified collection for faster indexing and searching.
Note: You cannot optimize an index when the indexing server is processing documents.
optimizeIndexStatus
Prints the optimization status.

Examples

To delete a collection:
adminTool delete -configPath /opt/ibm/search/config -collectionName db2inst1_SAMPLE_TS242320_0000
To print the status of all of the collections that use the French locale, issue the following command:
	adminTool status -configPath "c:\Program Files\IBM\Search\config" -locale fr_FR
To turn on tracing, issue the following command:
	adminTool configureTrace -configPath /opt/ibm/search/config -trace on

Usage notes

The error or trace log is, by default, written to AdminTool.0.log in the default log directory. You can format the log by using the Log Formatter tool.

Run the administration tool from the <ECMTS_HOME>\bin directory on the ECM Text Search server.
  • On Linux® or UNIX systems: adminTool.sh
  • On Windows systems: adminTool.bat