The DBMS_DESCRIBE system package is used to retrieve information about PL objects.
The DBMS_DESCRIBE procedure returns a set of index tables with results based on the specified object name. It performs fully qualified name conversion and performs a security check on the final object.
The DBMS_DESCRIBE system package has the same calling functionality as OCIDescribeAny.
Applicability
This content applies only to OceanBase Database Enterprise Edition. OceanBase Database Community Edition provides only the MySQL-compatible mode.
DBMS_DESCRIBE Privilege Description
This system package is available for PUBLIC use and performs its own security checks based on the described schema objects.
DBMS_DESCRIBE Table Types
The DBMS_DESCRIBE system package declares two PL table types for storing the data returned by DESCRIBE_PROCEDURE in OUT parameters.
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;
DBMS_DESCRIBE Exception
The DBMS_DESCRIBE package may cause the following application errors:
Error |
Description |
|---|---|
| ORA-20000 | ORU 10035: A package that contains only one stored procedure cannot be described. |
| ORA-20001 | ORU-10032: The stored procedure in the package does not exist. |
| ORA-20002 | ORU-10033: The object is remote and cannot be described. |
| ORA-20003 | ORU-10036: The object is invalid and cannot be described. |
| ORA-20004 | Syntax error in parsing the object. |
Overview of the DBMS_DESCRIBE Subprogram
The following table lists the DBMS_DESCRIBE subprograms supported by the current version of OceanBase Database and provides brief descriptions.
subprogram |
Description |
|---|---|
| DESCRIBE_PROCEDURE | Provides a brief description of PL stored procedures. |
