182 DBMS_XDB_ADMIN

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

See Also:

Oracle XML DB Developer's Guide for information about Oracle XML DB Repository

This chapter contains the following topics:

Using DBMS_XDB_ADMIN

Deprecated Subprograms

Note:

Oracle recommends that you do not use deprecated procedures in new applications. Support for deprecated features is for backward compatibility only and may be terminated in future releases.

The following subprograms are deprecated with Oracle Database 11g:

Security Model

Owned by XDB, the DBMS_XDB_ADMIN package must be created by SYS or XDB. The EXECUTE privilege is granted to SYS or XDB or DBA. Subprograms in this package are executed using the privileges of the current user.

Summary of DBMS_XDB_ADMIN Subprograms

This table lists the package subprograms in alphabetical order.

Table 182-1 DBMS_XDB_ADM Package Subprograms

Subprogram Description

CREATENONCEKEY Procedure

Generates a nonce value for use in digest authentication

CREATEREPOSITORYXMLINDEX Procedure

[Deprecated] Creates an XMLIndex on the XML DB repository

DROPREPOSITORYXMLINDEX Procedure

[Deprecated] Drops the XMLIndex on the XML DB repository

INSTALLDEFAULTWALLET Procedure

Installs the default XDB wallet in the default XDB wallet directory

MOVEXDB_TABLESPACE Procedure

Moves the XDB (user) to the specified tablespace

REBUILDHIERARCHICALINDEX Procedure

Rebuilds the hierarchical index after import or export operations

XMLINDEXADDPATH Procedure

[Deprecated] Takes a path in XML DB repository as an input and index all the resources under this given path

XMLINDEXREMOVEPATH Procedure

[Deprecated] Removes the index for the given path

CREATENONCEKEY Procedure

This procedure generates a nonce value for use in digest authentication.

Syntax

DBMS_XDB_ADMIN.CREATENONCEKEY;

CREATEREPOSITORYXMLINDEX Procedure

Note:

This procedure is deprecated with Oracle Database 11g.

This procedure creates an XMLIndex on the XML DB repository.

Syntax

DBMS_XDB_ADMIN.CREATEREPOSITORYXMLINDEX;

DROPREPOSITORYXMLINDEX Procedure

Note:

This procedure is deprecated in Oracle Database 11g.

This procedure drops the XMLIndex on the XML DB repository.

Syntax

DBMS_XDB_ADMIN.DROPREPOSITORYXMLINDEX;

INSTALLDEFAULTWALLET Procedure

This procedure installs the default XDB wallet in the default XDB wallet directory. The directory name where the XDB wallet is stored is prefixed either by ORACLE_BASE when it is defined, or ORACLE_HOME. It is then followed by /admin/db_name/xdb_wallet where db_name is the unique database name.

Syntax

DBMS_XDB_ADMIN.INSTALLDEFAULTWALLET;

Usage Notes

Only SYS can install or replace the default wallet.

MOVEXDB_TABLESPACE Procedure

This procedure moves the XDB (user) to the specified tablespace.

Syntax

DBMS_XDB_ADMIN.MOVEXDB_TABLESPACE(
   new_tablespace   IN  VARCHAR2);

Parameters

Table 182-2 MOVEXDB_TABLESPACE Procedure Parameters

Parameter Description

new_tablespace

Name of the tablespace to where the XDB is moved

Usage Notes

  • This operation waits for all concurrent XDB sessions to exit.

  • If MOVEXDB_TABLESPACE fails, the user should restart the database before issuing any further command.Failure to do so will result into unexpected behavior from the database.

  • The XDB repository by default resides in the SYSAUX tablespace. Using this procedure it can be moved to another tablespace. As a best practice we recommend to create a dedicated tablespace for the XDB repository only and not share it with other objects (such as tables). The tablespace containing the XDB repository should never be set to READ ONLY because this might affect various XML operations being executed.

REBUILDHIERARCHICALINDEX Procedure

This procedure rebuilds the hierarchical index after import or export operations. This is necessary because data cannot be exported from index tables.

Syntax

DBMS_XDB_ADMIN.REBUILDHIERARCHICALINDEX;

XMLINDEXADDPATH Procedure

Note:

This procedure is deprecated with Oracle Database 11g.

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 182-3 XMLINDEXADDPATH Procedure Parameters

Parameter Description

path

Path to a resource

recurse

TRUE or FALSE

XMLINDEXREMOVEPATH Procedure

Note:

This procedure is deprecated with Oracle Database 11g.

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);

Parameters

Table 182-4 XMLINDEXREMOVEPATH Procedure Parameters

Parameter Description

path

Path to a resource

recurse

TRUE or FALSE