The DBMS_DESCRIBE package queries information related to PL objects.
DBMS_DESCRIBE returns a group of index tables containing results based on the specified object names. The package performs full-name conversion and security checks for the final objects.
The DBMS_DESCRIBE package has the same call features as OCIDescribeAny.
Applicability
This topic applies only to OceanBase Database Enterprise Edition. OceanBase Database Community Edition provides only the MySQL-compatible mode.
Privileges
This package can be used by PUBLIC and performs security checks on itself based on the described schema objects.
Table types
The DBMS_DESCRIBE package declares two PL table types to store the data returned in the OUT parameter by DESCRIBE_PROCEDURE.
The two table types are as follows:
TYPE VARCHAR2_TABLE IS TABLE OF VARCHAR2(30)
INDEX BY BINARY_INTEGER;
TYPE NUMBER_TABLE IS TABLE OF NUMBER
INDEX BY BINARY_INTEGER;
Exceptions
The following table describes the application exceptions that may be raised by the DBMS_DESCRIBE system package.
| Error code | Description |
|---|---|
| OBE-20000 | ORU 10035: Unable to describe a program package that contains only one stored procedure. |
| OBE-20001 | ORU-10032: The stored procedure in the program package does not exist. |
| OBE-20002 | ORU-10033: The object is remote and cannot be described. |
| OBE-20003 | ORU-10036: The object is invalid and cannot be described. |
| OBE-20004 | A syntax error occurred while parsing the object. |
Subprograms
The following table describes the DBMS_DESCRIBE subprograms supported by the current OceanBase Database version.
| Subprogram | Description |
|---|---|
| DESCRIBE_PROCEDURE | Provides a brief description of PL stored procedures. |