HP 3000 Manuals

HELP [ ISQL Reference Manual for ALLBASE/SQL and IMAGE/SQL ] MPE/iX 5.0 Documentation


ISQL Reference Manual for ALLBASE/SQL and IMAGE/SQL

HELP 
[REV BEG]

The HELP command displays information about ISQL commands and SQL
statements.

Scope 

ISQL only.

ISQL Syntax 

      {@           } [D[ESCRIPTION]]
HE[LP]{SQLstatement} [S[YNTAX]     ]
      {ISQLcommand } [E[AMPLE]     ]
Parameters 

@                       is specified to obtain a list of the SQL
                        statements and a list of the ISQL commands.

SQLstatement            is any unabbreviated SQL statement.  This
                        consists of the SQL verb and the command keywords
                        that follow.

ISQLcommand             is any unabbreviated ISQL command.  This consists
                        of the ISQL verb and the command keywords that
                        follow.

DESCRIPTION             specifies that the information displayed is
                        limited to the description of the requested
                        SQLstatement or ISQLcommand.

SYNTAX                  specifies that the information displayed is
                        limited to the syntax of the requested
                        SQLstatement or ISQLcommand.

EXAMPLE                 specifies that the information displayed is
                        limited to examples of the requested SQLstatement 
                        or ISQLcommand.

Description 

   *   If you specify a command verb that is used in more than one
       command, ISQL lists all the commands that qualify and prompts you
       to enter the entire command.

   *   In prompting mode, ISQL prompts you for a command name.

Example 

     isql=> HELP @; 

In the following list of available HELP statements, those marked by * can
NOT be executed from ISQL.

     ===== SQL Statements =====

        ADD DBEFILE                EXECUTE IMMEDIATE
        ADD TO GROUP               EXECUTE PROCEDURE
       *ADVANCE                   *FETCH
        ALTER DBEFILE             *GOTO
        ALTER TABLE                GRANT
       *BEGIN                     *IF
        BEGIN ARCHIVE             *INCLUDE
       *BEGIN DECLARE SECTION      INSERT
        BEGIN WORK                 LOCK TABLE
        CHECKPOINT                 LOG COMMENT
       *CLOSE                     *OPEN
        COMMIT ARCHIVE             PREPARE
        COMMIT WORK               *PRINT
        CONNECT                    RAISE ERROR
        CREATE DBEFILE            *REFETCH
        CREATE DBEFILESET          RELEASE
        CREATE GROUP               REMOVE DBEFILE
        CREATE INDEX               REMOVE FROM GROUP
        CREATE PARTITION           RESET
        CREATE PROCEDURE          *RETURN
        CREATE RULE                REVOKE
        CREATE SCHEMA              ROLLBACK WORK
        CREATE TABLE               SAVEPOINT
        CREATE TEMPSPACE           SELECT
        CREATE VIEW                SET CONNECTION
       *DECLARE                    SET CONSTRAINTS
       *DECLARE CURSOR             SET DEFAULT DBEFILESET
        DELETE                     SET DML ATOMICITY
       *DELETE WHERE CURRENT       SET MULTITRANSACTION
       *DESCRIBE                   SET PRINTRULES
        DISABLE AUDIT LOGGING      SET SESSION
        DISABLE RULES              SET TRANSACTION
        DISCONNECT                 SET USER TIMEOUT
        DROP DBEFILE               SETOPT
        DROP DBEFILESET           *SQLEXPLAIN
        DROP GROUP                 START DBE
        DROP INDEX                 START DBE NEW
        DROP MODULE                START DBE NEWLOG
        DROP PARTITION             STOP DBE
        DROP PROCEDURE             TERMINATE USER
        DROP RULE                  TRANSFER OWNERSHIP
        DROP TABLE                 TRUNCATE TABLE
        DROP TEMPSPACE             UPDATE
        DROP VIEW                  UPDATE STATISTICS
        ENABLE AUDIT LOGGING      *UPDATE WHERE CURRENT
        ENABLE RULES               VALIDATE
       *END DECLARE SECTION       *WHENEVER
        EXECUTE                   *WHILE

     ===== ISQL Commands =====

        CHANGE           GENPLAN          LIST HISTORY     SET
        DO               HELP             LIST INSTALL     SQLGEN
        EDIT             HOLD             LIST SET         SQLUTIL
        END              INFO             LOAD             START
        ERASE            INPUT            RECALL           STORE
        EXIT             INSTALL          REDO             SYSTEM
        EXTRACT          LIST FILE        RENAME           UNLOAD

     isql=> help help; 

     SCOPE:  ISQL Only

     The HELP command displays information about ISQL or SQL commands.

     ==========
       SYNTAX
     ==========
           {@           } [D[ESCRIPTION]]
     HE[LP]{SQLStatement} [S[YNTAX     ]]
           {ISQLCommand } [E[XAMPLE    ]]

     The conventions used in the syntax diagrams displayed by the
     HELP command are as follows:

     UPPERCASE     Commands and keywords are shown in uppercase characters.
           The characters must be entered in the order shown.
           However, you can enter the characters in either uppercase
           or lowercase.

     Lowercase     A capitalized, lowercase word represents a parameter or
           argument that you must replace with the actual value.

     punctuation   Punctuation characters (other than brackets, braces,
           vertical bars, and ellipses) must be entered exactly
           as shown.

     { }          Braces enclose required elements.  When several elements
          are stacked within braces, you must select one.  In the
          following example, you must select either ON or OFF.

            COMMAND {ON }
            {OFF}

     [  ]         Brackets enclose optional elements.  When several elements
          are stacked within brackets, you can select one or none of
          the elements.  In the following example, you can select
          OPTION or parameter or neither.

            COMMAND [OPTION   ]
            [parameter]

     [...]        Horizontal ellipses enclosed in brackets indicate that
          you can repeatedly select the element(s) that appear
          within the immediately preceding brackets or braces.
          In the following example, you can select parameter zero
          or more times.

     [parameter] [...]

     |...|        Horizontal ellipses enclosed in vertical bars indicate
          that you can select more than one element within the
          immediately preceding  brackets or braces.  However,
          each particular element can only be selected once.
          In the following example, you must select A, AB, BA,
          or B.  The elements cannot be repeated.

     {A} |...|
     {B}

     ===========
       EXAMPLE
     ===========

     HELP @ ;

     HELP input ;

     isql=> help create; 

     Please specify help for one of the following commands:
      CREATE DBEFILE
      CREATE DBEFILESET
      CREATE GROUP
      CREATE INDEX
      CREATE PROCEDURE
      CREATE RULE
      CREATE SCHEMA
      CREATE TABLE
      CREATE TEMPSPACE
      CREATE VIEW

     isql=> help do; 

     SCOPE:  ISQL Only

     The DO command lets you execute any of the commands in the command history
     buffer.

     ==========
       SYNTAX
     ==========

     DO [CommandNumber]
        [CommandString]

     ===========
       EXAMPLE
     ===========

     DO ;

     DO 2 ;

     isql=> help add dbefile example; 

     ===========
       EXAMPLE
     ===========

     ADD DBEFILE ThisDBEFile TO DBEFILESET Miscellaneous ;

     isql=> help add dbefile description; 

     SCOPE:  ISQL or Application Programs

     The ADD DBEFILE statement associates a DBEFile with a DBEFileSet.

     isql=> help add dbefile syntax; 

     ==========
       SYNTAX

     ==========

     ADD DBEFILE DBEFileName TO DBEFILESET DBEFileSetName
[REV END]



MPE/iX 5.0 Documentation