HELP

Syntax

HELP |? [topic | <error_code> | <facility name> <error number> ]

Accesses the SQL*Plus command-line help system, which enables you to get help on SQL*Plus topics. This command also displays error details, such as Cause, Action, and Parameters, for the provided error code, similar to the OERR command.

Terms

topic

Refers to a SQL*Plus topic, for example, COLUMN.

error_code

Contains the error prefix, such as ORA or SP2, and the error number.

facility name

Refers to the error prefix, such as ORA, SP2, and so on.

error number

Refers to the error number.

Usage

You can specify only one topic after HELP. You can also abbreviate the topic, for example, by using COL instead of COLUMN. However, if the abbreviation used is ambiguous, then SQL*Plus displays help for all topics that match the abbreviation. For example:

HELP EX

SQL*Plus displays the syntax of the EXECUTE command, followed by the syntax of the EXIT command. If you get a response indicating that help is not available, then consult your database administrator.

You can enter HELP INDEX or ? INDEX for a list of valid topics. Enter HELP or ? without topic to get help on the SQL*Plus help system.

See Also:

Oracle Database Library

When you enter the error number without specifying the facility name in the HELP command, then the default facility name ORA is used. The message from the ORA facility corresponding to the specified error number is displayed.

Examples

You can execute the following command to view a list of SQL*Plus commands:

HELP INDEX

or

? INDEX

You can execute the following command to view a single column list of SQL*Plus commands:

HELP TOPICS

You can execute the following command to view error details for a specified error code:

HELP ORA-1422