ut_annotation_manager.md

UT_ANNOTATION_MANAGER

• GET_ANNOTATED_OBJECTS Function
• REBUILD_ANNOTATION_CACHE Procedure
• PURGE_CACHE Procedure

GET_ANNOTATED_OBJECTS Function

Gets annotations for all objects of a specified type for database schema.
Annotations that are stale or missing are parsed and placed in persistent cache.
After placing in cache, annotation data is returned as pipelined table data.

Syntax

function get_annotated_objects(a_object_owner varchar2, a_object_type varchar2) return ut_annotated_objects pipelined

Parameters

Name	Description
a_object_owner	owner of objects to get annotations for
a_object_type	type of objects to get annotations for
return	array containing annotated objects along with annotations for each object (nested)

REBUILD_ANNOTATION_CACHE Procedure

Rebuilds annotation cache for a specified schema and object type.
The procedure is called internally by get_annotated_objects function.
It can be used to speedup initial execution of utPLSQL on a given schema
if it is executed before any call is made to ut.run or ut_runner.run procedure.

Syntax

procedure rebuild_annotation_cache(a_object_owner varchar2, a_object_type varchar2)

Parameters

Name	Description
a_object_owner	owner of objects to get annotations for
a_object_type	type of objects to get annotations for

PURGE_CACHE Procedure

Removes cached information about annotations for objects of specified type and specified owner

Syntax

procedure purge_cache(a_object_owner varchar2, a_object_type varchar2)

Parameters

Name	Description
a_object_owner	owner of objects to purge annotations for
a_object_type	type of objects to purge annotations for