The DESCRIBE_PROCEDURE stored procedure provides a brief description of PL stored procedures.
DESCRIBE_PROCEDURE identifies the name of a stored procedure and returns information about each parameter of this stored procedure.
Applicability
This topic applies only to OceanBase Database Enterprise Edition. OceanBase Database Community Edition provides only the MySQL mode.
Syntax
DBMS_DESCRIBE.DESCRIBE_PROCEDURE(
object_name IN VARCHAR2,
reserved1 IN VARCHAR2,
reserved2 IN VARCHAR2,
overload OUT NUMBER_TABLE,
position OUT NUMBER_TABLE,
datalevel OUT NUMBER_TABLE,
argument_name OUT VARCHAR2_TABLE,
datatype OUT NUMBER_TABLE,
default_value OUT NUMBER_TABLE,
in_out OUT NUMBER_TABLE,
datalength OUT NUMBER_TABLE,
dataprecision OUT NUMBER_TABLE,
scale OUT NUMBER_TABLE,
radix OUT NUMBER_TABLE,
spare OUT NUMBER_TABLE
include_string_constraints OUT BOOLEAN DEFAULT FALSE);
Parameters
Parameter |
Description |
|---|---|
| object_name | The name of the stored procedure described. The syntax of this parameter follows the rules of identifiers in SQL. The object name can be a synonym. This parameter is required and cannot be empty. The length of the name cannot exceed 197 bytes. |
| reserved1 reserved2 | Reserved parameters for future use. They must be set to NULL or an empty string. |
| overload | The unique ID allocated to the signature of the stored procedure. If the stored procedure is overloaded, this field stores a different value for each version of the stored procedure. |
| position | The position of the parameter in the parameter list. |
| datalevel | The level of the data type if the parameter is of a composite type, such as record. |
| argument_name | The name of the parameter related to the stored procedure described. |
| datatype | The data type of the described parameter. Valid values:
|
| default_value | The value is 1 if the described parameter has a default value, and is 0 if otherwise. |
| in_out | The parameter mode. Valid values:
|
| datalength | Returns the length constraint for a %rowtype parameter, and returns 0 if otherwise. If include_string_constraints is set to TRUE, the parameter length constraint is passed back if it is of a proper parameter type. String types:
|
| dataprecision | The precision of the described parameter if its datatype is set to 2 (NUMBER). |
| scale | The number of decimal places of the described parameter if its datatype is set to 2 (NUMBER). |
| radix | The base of the described parameter if its datatype is set to 2 (NUMBER). |
| spare | Reserved for future use. |
| include_string_constraints | The default value is FALSE. If the value is set to TRUE, the type constraint of the described parameter is passed back if it is of a proper parameter type. String types:
|
Return values
All values of DESCRIBE_PROCEDURE are returned through the OUT parameter. The data types are stored as PL tables to accommodate a variable number of parameters.