149 DBMS_XDB_ADMIN

The DBMS_XDB_ADMIN package provides an interface to manage the XMLIndex on the XML DB repository.

See Also:

Oracle XML DB Developer's Guide for information about "Using XMLIndex on Oracle XML DB Repository"

This chapter contains the following topics:

• Summary of DBMS_XDB_ADMIN Subprograms

---

Summary of DBMS_XDB_ADMIN Subprograms

This table list the package subprograms in alphabetical order.

Table 149-1 DBMS_XDB_ADM Package Subprograms

Subprogram	Description
CREATEREPOSITORYXMLINDEX Procedure	Creates an XMLIndex on the XML DB repository
DROPREPOSITORYXMLINDEX Procedure	Drops the XMLIndex on the XML DB repository
XMLINDEXADDPATH Procedure	Takes a path in XML DB repository as an input and index all the resources under this given path
XMLINDEXREMOVEPATH Procedure	Removes the index for the given path

---

CREATEREPOSITORYXMLINDEX Procedure

This procedure creates an XMLIndex on the XML DB repository.

Syntax

DBMS_XDB_ADMIN.CREATEREPOSITORYXMLINDEX; 

---

DROPREPOSITORYXMLINDEX Procedure

This procedure drops the XMLIndex on the XML DB repository.

Syntax

DBMS_XDB_ADMIN.DROPREPOSITORYXMLINDEX; 

---

XMLINDEXADDPATH Procedure

This procedure adds to the repository xmlindex the resource identified by path (when recurse is FALSE) or adds to the repository xmlindex the sub-tree of resources rooted at path (when recurse is TRUE). The default value for recurse is TRUE.

Syntax

DBMS_XDB_ADMIN.XMLINDEXADDPATH(
   path         IN  VARCHAR2, 
   recurse      IN  BOOLEAN);

Parameters

Table 149-2 XMLINDEXADDPATH Procedure Parameters

Parameter	Description
path	Path to a resource
recurse	TRUE or FALSE

Examples

DECLARE    ret BOOLEAN;BEGIN    ret := DBMS_XDB_ADMIN.XMLINDEXADDPATH('/PurchaseOrder', FALSE); END;

---

XMLINDEXREMOVEPATH Procedure

This procedure removes from the repository xmlindex the resource identified by path (when recurse is FALSE) or removes from the repository xmlindex the sub-tree of resources rooted at path (when recurse is TRUE). The default value for recurse is TRUE.

Syntax

DBMS_XDB_ADMIN.XMLINDEXREMOVEPATH(
   path              IN  VARCHAR2, 
   isrecursive       IN  BOOLEAN)
 RETURN BOOLEAN;

Parameters

Table 149-3 XMLINDEXREMOVEPATH Procedure Parameters

Parameter	Description
path	Path to a resource
recurse	TRUE or FALSE

Examples

DECLARE    ret BOOLEAN;BEGIN    ret := DBMS_XDB_ADMIN.XMLINDEXREMOVEPATH(            '/PurcahseOrder', FALSE);     ret := DBMS_XDB_ADMIN.XMLINDEXREMOVEPATH(           '/PurcahseOrder/CompanyA', TRUE); END;