SQL$HELP72.HLB  —  DESCRIBE  Arguments

1  –  INPUT

    Specifies that the DESCRIBE statement writes information about
    input parameter markers to the SQLDA. The MARKERS or INPUT clause
    specifies that the DESCRIBE statement writes information about
    the number and data types of any input parameter markers in the
    prepared statement to the SQLDA.

    Input parameter markers in a prepared statement serve the same
    purpose as host language variables in nondynamic, embedded SQL
    statements. The program can use that information in the SQLDA
    to allocate storage. The program must supply values in that
    allocated storage. SQL substitutes these values for the parameter
    markers when it dynamically executes the prepared statement.

2  –  INTO descriptor name

    Specifies the name of a structure declared in the host language
    program as an SQLDA to which SQL writes information about select
    list items, or input or output parameter markers.

    Precompiled programs can use the embedded SQL statement INCLUDE
    SQLDA to automatically insert a declaration of an SQLDA
    structure, called SQLDA, in the program when it precompiles
    the program. Programs that use the SQL module language must
    explicitly declare an SQLDA. Either precompiled or SQL module
    language programs can explicitly declare additional SQLDAs but
    must declare them with unique names. For sample declarations of
    SQLDA structures, see the Oracle Rdb SQL Reference Manual.

3  –  MARKERS

    Specifies that the DESCRIBE statement writes information about
    input parameter markers to the SQLDA. The MARKERS or INPUT clause
    specifies that the DESCRIBE statement writes information about
    the number and data types of any input parameter markers in the
    prepared statement to the SQLDA.

    Input parameter markers in a prepared statement serve the same
    purpose as host language variables in nondynamic, embedded SQL
    statements. The program can use that information in the SQLDA
    to allocate storage. The program must supply values in that
    allocated storage. SQL substitutes these values for the parameter
    markers when it dynamically executes the prepared statement.

4  –  OUTPUT

    Specifies that the DESCRIBE statement writes information about
    returned values in a prepared statement to the SQLDA. If you
    use this clause, the DESCRIBE statement writes information about
    the number and data types of any returned values in the prepared
    statement to the SQLDA. The program uses that information to
    allocate storage for the returned values. The storage allocated
    by the program then receives the returned values.

    The following statements or clauses return values to the DESCRIBE
    statement:

    o  Select list items in a SELECT statement

    o  The following statements within multistatement procedures:

       -  Singleton SELECT statement

       -  INSERT . . . RETURNING and UPDATE . . . RETURNING statements

       -  SET assignment statement

    o  CALL statement (invoking a stored procedure)

    o  Dynamic singleton SELECT statement

    The default is SELECT LIST (or OUTPUT).

5  –  SELECT_LIST

    Specifies that the DESCRIBE statement writes information about
    returned values in a prepared statement to the SQLDA. If you
    use this clause, the DESCRIBE statement writes information about
    the number and data types of any returned values in the prepared
    statement to the SQLDA. The program uses that information to
    allocate storage for the returned values. The storage allocated
    by the program then receives the returned values.

    The following statements or clauses return values to the DESCRIBE
    statement:

    o  Select list items in a SELECT statement

    o  The following statements within multistatement procedures:

       -  Singleton SELECT statement

       -  INSERT . . . RETURNING and UPDATE . . . RETURNING statements

       -  SET assignment statement

    o  CALL statement (invoking a stored procedure)

    o  Dynamic singleton SELECT statement

    The default is SELECT LIST (or OUTPUT).

6  –  statement-name

    Specifies the name of a prepared statement. If the PREPARE
    statement for the dynamically executed statement specifies a
    parameter, use the same parameter in the DESCRIBE statement
    instead of an explicit statement name.

    You can supply either a parameter or a compile-time statement
    name. Specifying a parameter lets SQL supply identifiers to
    programs at run time. Use an integer parameter to contain the
    statement identifier returned by SQL or a character string
    parameter to contain the name of the statement that you pass
    to SQL. See the PREPARE statement and the DECLARE Dynamic_CURSOR
    statement for more details.

7  –  statement-id-parameter

    The name of a prepared statement. If the PREPARE statement for
    the dynamically executed statement specifies a parameter, use the
    same parameter in the DESCRIBE statement instead of an explicit
    statement name.

    You can supply either a parameter or a compile-time statement
    name. Specifying a parameter lets SQL supply identifiers to
    programs at run time. Use an integer parameter to contain the
    statement identifier returned by SQL or a character string
    parameter to contain the name of the statement that you pass
    to SQL. See the PREPARE statement and the DECLARE Dynamic_CURSOR
    statement for more details.
Close Help