DBMS_METADATA , 6 of 11

SET_PARSE_ITEM Procedure

SET_PARSE_ITEM enables output parsing by specifying an object attribute to be parsed and returned. It should only be used in conjunction with FETCH_DDL.

Syntax

PROCEDURE set_parse_item
  (handle IN NUMBER,
   name IN VARCHAR2);

Parameters

Table 28-8 SET_PARSE_ITEM Parameters

Parameter	Description
`handle`	The handle returned from `OPEN`.
`name`	The name of the object attribute to be parsed and returned. See Table 28-9 for the attribute object type, name, and meaning.

Table 28-9 SET_PARSE_ITEM: Parse Items

Object Type	Name	Meaning
All objects	`VERB`	For every row in the `sys.ku$_ddls` nested table returned by `fetch_ddl,` the verb in the corresponding `ddlText` is returned. See the example using `sys.ku$_ddls`.
	`OBJECT_TYPE`	The object type as used in a DDL `CREATE` statement is returned, for example, `TABLE` or `PACKAGE BODY`.
	`SCHEMA`	The object schema is returned. If the object is not a schema object, `NULL` is returned.
	`NAME`	The object name is returned. If the object is not a named object, `NULL` is returned.
TABLE, INDEX	`TABLESPACE`	The tablespace name of the table or index is returned.
TRIGGER	`ENABLE`	If the trigger is enabled, `ENABLE` is returned. If the trigger is disabled, `DISABLE` is returned.

Exceptions

INVALID_ARGVAL. A NULL or invalid value was supplied for an input parameter. The error message text identifies the parameter.
INVALID_OPERATION. SET_PARSE_ITEM was called after the first call to FETCH_xxx for the OPEN context. After the first call to FETCH_xxx is made, no further calls to SET_PARSE_ITEM are permitted.
INCONSISTENT_ARGS. The attribute name is not valid for the object type associated with the OPEN context.

Usage Notes

By default fetch_ddl returns object metadata as creation DDL. By calling SET_PARSE_ITEM, you can request that individual attributes of the object be returned also, to avoid the tedious process of parsing SQL text. This is useful when fetching objects based on the value of a returned object, for example, fetching indexes for a returned table.

You can call SET_PARSE_ITEM multiple times to ask for multiple items to be parsed and returned. Parsed items are returned in the sys.ku$_parsed_items nested table. See the example using sys.ku$_parsed_items.

See Also: