Was this helpful?
HELP--Display Help
Valid in: QUEL
Gets information about a variety of database objects.
This statement has the following format:
help [objectname {, objectname}]
help comment column table columnname {, columnname}
help comment table table {, table }
help constraint constraintname  
 {, constraintname}
help default tablename 
help help
help index 
indexname {, indexname}
help integrity tablename {, tablename
help permit on dbevent 
  objectname  {objectname}
help permit on procedure | table | view
  objectname  {objectname}
help procedure procedure_name 
 {, procedure_name}
help register objectname 
help rule rulename, {rulename
help security_alarm tablename
help synonym synonym {, synonym}
help table tablename {, tablename}
help view viewname {, viewname}
The help statement displays information about database objects. In general, to display high-level information, specify help objectname (for example, help mytable); to display detailed information, specify help objecttype objectname (for example, help table mytable).
You can use the asterisk wildcard character (*) in object name specifications to display a selected set of objects. For details, see Wildcards and Help.
The following lists help options:
Displays object name, owner, and type for all tables, views, and indexes to which the user has access, and all synonyms owned by the user. System tables and temporary tables are not listed. Information is displayed in a one-line-per-object format.
help objectname {, objectname}
Displays detailed information for specified objects; display format is block-style.
Specifies the name of a table, view, or index
help comment column tablename columnname
{, columnname}
Displays any comments defined for the specified columns
help comment table tablename
{, tablename}
Displays any comments defined for the specified tables
help constraint tablename
Displays any constraints defined on columns of the specified table or on the entire table. For details about table constraints, see the create table statement description in the SQL Reference Guide.
These constraints are not the same as the integrities displayed by the help integrities statement.
help default tablename
Displays any user-defined defaults defined on columns of the specified table
help help
Displays valid help statements
help index indexname {, indexname}
Displays detailed information about the specified indexes
help integrity objectname
{, objectname}
Displays any integrity constraints defined on the specified tables or indexes. Integrity constraints are defined using the create integrity statement, described in this chapter.
Specifies the name of a table or index
help permit on procedure | table | dbevent | view objectname
{, objectname}
Displays the permit numbers and text. The permit numbers are required for the corresponding drop permit statement.
Specifies the name of a database procedure, table, event, or view
help procedure procedure_name
{, procedure_name}
Displays detailed information about the specified procedure
help register objectname
Displays information about registered objects. For details about registering objects, see the Database Administrator Guide.
help rule rulename, {rulename}
Displays the text of the create rule statement that defined the rule
help security_alarm tablename{, tablename}
Displays all security alarms defined for the specified table. The information includes an index number you can use to delete the security alarm (using the drop security_alarm statement).
help synonym synonym{synonym}
Displays information about the specified synonyms. To display all the synonyms you own, specify help synonym *.
help table tablename {, tablename}
Displays detailed information about the specified tables
help view viewname {, viewname}
Displays detailed information about the specified views
Last modified date: 11/28/2023