Applies To
OraDatabase
Description
Describes a schema object. This method returns an instance of the OraMetaData
interface.
Arguments
[in] SchemaObjectName
A String representing the name of the schema object to be described.
Usage
OraMetaDataObj = OraDatabase.Describe("SchemaObjectName")
Remarks
The following schema object types are allowed to be described: Tables, Views,
Procedures, Functions, Packages, Sequences, Collections (VARRAYS or Nested
Tables), and Types. Attempting to describe any other schema object (for example, a
column) or an invalid schema object name will raise an error. Schema objects
not listed here should be navigated to rather than described directly.
This method takes the name of a schema object, such as emp, and returns a COM
Automation object (OraMetaData). OraMetaData provides methods for dynamically navigating and accessing all the attributes
(OraMDAttribute collection) of a schema object described.
Example
The following VB script illustrates a simple usage of Describe to retrieve and
display several attributes of the emp table.
Set emp = OraDatabase.Describe("emp")
'Display the name of the Tablespace
msgbox emp!tablespace
'Display name, data type, and size of each column in the emp table.
Set empColumns = emp!Columns
for I = 1 to empColumns.Count
Set Column = empColumns(I)
MsgBox Column!Name & Column!Datatype & Column!Length
Next I
See Examples for more code samples.