Syntax
The HELP statement has the following format:
HELP [[schema.]objectname {, [schema.]objectname}]
HELP COMMENT COLUMN [schema.]table column_name {, column_name}
HELP COMMENT TABLE [schema.]table {, [schema.]table }
HELP CONSTRAINT [schema.]table_name
{, [schema.]constraint_name}
HELP DEFAULT [schema.]table_name
HELP HELP
HELP INDEX [schema.]indexname {, [schema.]indexname}
HELP INTEGRITY [schema.]table_name {, [schema.]table_name}
HELP PERMIT ON DBEVENT
[schema.]objectname {, [schema.]objectname}
HELP PERMIT ON PROCEDURE | TABLE | VIEW
[schema.]object_name {, [schema.]object_name}
HELP PROCEDURE [schema.]procedurename
{, [schema.]procedurename}
HELP REGISTER [schema.]objectname
HELP RULE [schema.]rulename, {[schema.]rulename}
HELP SECURITY_ALARM [ON TABLE] table_name
HELP SECURITY_ALARM ON DATABASE database_name
HELP SECURITY_ALARM ON CURRENT INSTALLATION
HELP SEQUENCE [schema.]objectname
HELP SQL [sql_statement]
HELP SYNONYM [schema.]synonym {, [schema.]synonym}
HELP TABLE [schema.]table_name {, [schema.]table_name}
HELP TABLE|INDEX name
HELP VIEW [schema.]view_name {, [schema.]view_name}
objectname
Specifies the name of a table, view, or index. Display format is block-style.
COMMENT COLUMN
Displays any comments defined for the specified columns.
COMMENT TABLE
Displays any comments defined for the specified tables.
CONSTRAINT
Displays any constraints defined on columns of the specified table or on the entire table. For details about table constraints, see
Create Table (see page
CREATE TABLE).
These constraints are not the same as the integrities displayed by the HELP INTEGRITY statement.
DEFAULT
Displays any user-defined defaults defined on columns of the specified table
HELP
Displays valid HELP statements.
INDEX
Displays detailed information about the specified indexes.
INTEGRITY
Displays any integrity constraints defined on the specified tables or indexes. Integrity constraints are defined using the CREATE INTEGRITY statement.
PERMIT ON DBEVENT
Displays information about the specified database event.
PERMIT ON PROCEDURE | TABLE | VIEW
For tables, displays the permit text. For other objects, displays the values required by the corresponding DROP PERMIT statement.
PROCEDURE
Displays detailed information about the specified procedure.
REGISTER
Displays information about registered objects. For details about registering objects, see
Register Table (see page
REGISTER TABLE).
RULE
Displays the text of the CREATE RULE statement that defined the rule.
SECURITY_ALARM [ON TABLE]
Displays all security alarms defined for the specified table. The information includes an index number that can be used to delete the security alarm (using the DROP SECURITY_ALARM statement).
SECURITY_ALARM ON DATABASE
Displays all security alarms defined for the specified database. The information includes an index number that can be used to delete the security alarm (using the DROP SECURITY_ALARM statement).
SECURITY_ALARM ON CURRENT INSTALLATION
Displays all security alarms defined for the current installation. The information includes an index number that can be used to delete the security alarm (using the DROP SECURITY_ALARM statement).
SEQUENCE
Displays detailed information about the specified sequence.
SQL
Displays information about the specified SQL statement. If the sql_statement parameter is omitted, displays a list of SQL statements for which help information is available.
SYNONYM
Displays information about the specified synonyms. To display all the synonyms you own, specify HELP SYNONYM *. To display all the synonyms you own plus all the synonyms to which you have access, specify HELP SYNONYM *.*.
TABLE
Displays detailed information about the specified tables.
TABLE | INDEX
Displays the cache priority.
VIEW
Displays detailed information about the specified views.