db2ts HELP command

db2ts HELP displays the list of available Db2® Text Search commands, or the syntax of an individual command.

Use the db2ts HELP command to get help on specific error messages as well.

For execution, the command needs to be prefixed with db2ts at the command line.

Authorization

None.

Command syntax

Read syntax diagramSkip visual syntax diagram HELP?commandsqlcodesqlstateerror-identifier

Command parameters

HELP | ?
Provides help information for a command or a reason code.
command
The first keywords that identify a Db2 Text Search command:
  • ALTER
  • CLEANUP
  • CLEAR (for both CLEAR COMMAND LOCKS and CLEAR EVENTS FOR INDEX)
  • CREATE
  • DISABLE
  • DROP
  • ENABLE
  • RESET PENDING
  • START
  • STOP
  • UPDATE
sqlcode
SQLCODE for message returned by db2ts command (within or outside the administration stored procedure) or text search query.
sqlstate
Sqlstate returned by command, administration stored procedure, or text search query.
error-identifier
An identifier is part of the text-search-error-msg that is embedded in error messages. This identifier starts with 'CIE' and is of the form CIEnnnnn where nnnnn is a number. This identifier represents the specific error that is returned upon an error during text search. It may also be returned in an informational message upon completion of a text search command or in the message printed at the completion of a text search administration procedure. If the identifier does not start with 'CIE', then db2ts help cannot provide information about the error-identifier. For example, db2ts cannot provide help for a message with an error-identifier such as IQQR0012E.

Usage notes

When using a UNIX shell, it might be necessary to supply the arguments to db2ts using double quotation marks, as in the following example:
db2ts "? CIE00323"
Without the quotation marks, the shell tries to match the wildcard with the contents of the working directory and it may give unexpected results.

If the first keyword of any db2ts command is specified, the syntax of the identified command is displayed. For the two db2ts commands that share the same first keyword (CLEAR COMMAND LOCKS and CLEAR EVENTS FOR INDEX), the syntax of both commands will be displayed when db2ts help clear is issued, but each command may be specifically displayed by adding the second keyword to distinguish them, for example db2ts help clear events. If a parameter is not specified after ? or HELP, db2ts lists all available db2ts commands.

Specifying a sqlcode, sqlstate, or CIE error-identifier will return information about that code, state, or error identifier. For example, 
db2ts help SQL20423
or
db2ts ? 38H10
or
db2ts ? CIE00323