119
DBMS_XMLSTORE

DBMS_XMLSTORE provides the ability to store XML data in relational tables.

This chapter contains the following sections:

• Using DBMS_XMLSTORE
  • Types
• Summary of DBMS_XMLSTORE Subprograms

Using DBMS_XMLSTORE

Types

Table 119-1  Types of DBMS_XMLSTORE

ctxType

Summary of DBMS_XMLSTORE Subprograms

Table 119-2  DBMS_XMLSTORE Package Subprograms

CLEARKEYCOLUMNLIST

Clears the key column list.

Syntax

PROCEDURE clearKeyColumnList(
   ctxHdl IN ctxType);

ctxHdl

(IN)

CLEARUPDATECOLUMNLIST

Clears the update column list.

Syntax

PROCEDURE clearUpdateColumnList(
   ctxHdl IN ctxType);

ctxHdl

(IN)

CLOSECONTEXT

Closes/deallocates a particular save context.

Syntax

PROCEDURE closeContext(
   ctxHdl IN ctxType);

ctxHdl

(IN)

DELETEXML

Deletes records specified by data from the XML document from the table specified at the context creation time, and returns the number of rows deleted.

FUNCTION  deleteXML(
   ctxHdl IN ctxPType, 
   xDoc IN VARCHAR2) 
RETURN NUMBER;

FUNCTION  deleteXML( 
   ctxHdl IN ctxType, 
   xDoc IN CLOB) 
RETURN NUMBER;

FUNCTION  deleteXML( 
   ctxHdl IN ctxType, 
   xDoc IN XMLType) 
RETURN NUMBER;

ctxHdl

(IN)

xDoc

(IN)

INSERTXML

Inserts the XML document into the table specified at the context creation time, and returns the number of rows inserted.

FUNCTION  insertXML(
   ctxHdl IN ctxType, 
   xDoc IN VARCHAR2) 
RETURN NUMBER;

FUNCTION  insertXML(
   ctxHdl IN ctxType,
   xDoc IN CLOB) 
RETURN NUMBER;

FUNCTION  insertXML(
   ctxHdl IN ctxType,
   xDoc IN XMLType) 
RETURN NUMBER;

ctxHdl

(IN)

xDoc

(IN)

NEWCONTEXT

Creates a save context, and returns the context handle.

Syntax

FUNCTION newContext(
   targetTable IN VARCHAR2)
RETURN ctxType;

targetTable

(IN)

SETKEYCOLUMN

This method adds a column to the "key column list". The value for the column cannot be NULL. In case of update or delete, the columns in the key column list make up the WHERE clause of the statement. The key columns list must be specified before updates can complete; this is optional for delete operations

Syntax

PROCEDURE setKeyColumn( 
   ctxHdl IN ctxType,
   colName IN VARCHAR2);

ctxHdl

(IN)

colName

(IN)

SETROWTAG

Names the tag used in the XML document, to enclose the XML elements corresponding to databse records.

Syntax

PROCEDURE setRowTag(
   ctxHdl IN ctxType,
   tag IN VARCHAR2);

ctxHdl

(IN)

tag

(IN)

SETUPDATECOLUMN

Adds a column to the update column list. In case of insert, the default is to insert values to all the columns in the table; on the other hand, in case of updates, the default is to only update the columns corresponding to the tags present in the ROW element of the XML document. When the update column list is specified, the columns making up this list alone will get updated or inserted into.

Syntax

PROCEDURE setUpdateColumn( 
   ctxHdl IN ctxType,
   colName IN VARCHAR2);

ctxHdl

(IN)

colName

(IN)

UPDATEXML

Updates the table specified at the context creation time with data from the XML document, and returns the number of rows updated. The options are described in the following table.

FUNCTION  updateXML( 
   ctxHdl IN ctxType,
   xDoc IN VARCHAR2) 
RETURN NUMBER;

FUNCTION  updateXML(
   ctxHdl IN ctxType, 
   xDoc IN CLOB)
RETURN NUMBER;

FUNCTION  updateXML(
   ctxHdl IN ctxType, 
   xDoc IN XMLType)
RETURN NUMBER;

ctxHdl

(IN)

xDoc

(IN)