The DBMS_DESCRIBE system package is used to obtain information about PL objects.
The DBMS_DESCRIBE system package returns an indexed table with results based on the specified object name. It performs full name conversion and security checks on the final object.
The DBMS_DESCRIBE system package has the same calling functionality as OCIDescribeAny.
Applicability
This topic applies only to OceanBase Database Enterprise Edition. OceanBase Database Community Edition does not support this feature.
Privilege requirements
The DBMS_DESCRIBE system package is available to PUBLIC and performs its own security checks based on the described schema objects.
Table types
The DBMS_DESCRIBE system package declares two PL table types to store the data returned by the DESCRIBE_PROCEDURE procedure in the OUT parameter.
The two 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 DBMS_DESCRIBE system package may raise the following application errors:
| Error | Description |
|---|---|
| OBE-20000 | ORU 10035: Cannot describe a package that contains only one stored procedure. |
| OBE-20001 | ORU-10032: The stored procedure does not exist in the package. |
| 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 | Syntax error when parsing the object. |
Subprograms
The following table lists the DBMS_DESCRIBE subprograms supported in the current version of OceanBase Database and their brief descriptions.
| Subprogram | Description |
|---|---|
| DESCRIBE_PROCEDURE | Provides a brief description of the PL stored procedure. |
