173 DBMS_XMLINDEX

DBMS_XMLINDEXパッケージでは、非同期の索引付けを実装するインタフェースが提供されています。

関連項目: XMLIndexの詳細は、『Oracle XML DB開発者ガイド』を参照してください。

この章では、次の項目について説明します。

• DBMS_XMLINDEXの使用方法

  • 概要

  • セキュリティ・モデル

• DBMS_XMLINDEXサブプログラムの要約

---

DBMS_XMLINDEXの使用方法

• 概要

• セキュリティ・モデル

---

概要

非同期索引のメンテナンス

基本のXMLIndexは、すべてのDML操作でメンテナンスされます。ただし、計算のコストを考慮すると、多くの場合、失効した結果には十分な可用性があります。そのような場合、データベースのロードが少ないときなど、適切なときまで索引の更新を延期することが得策です。このようにして、非同期索引メンテナンスのメカニズムが提供されています。

---

セキュリティ・モデル

DBMS_XMLINDEXパッケージは、XDBが所有しているため、SYSまたはXDBによって作成される必要があります。EXECUTE権限は、PUBLICに付与されます。このパッケージ内のサブプログラムは、現行のユーザーの権限を使用して実行されます。

---

DBMS_XMLINDEXサブプログラムの要約

次の表に、このパッケージのサブプログラムをアルファベット順に示します。

表173-1 DBMS_XMLINDEXパッケージのサブプログラム

サブプログラム	説明
CREATEDATEINDEXプロシージャ	XMLIndexの記憶表であるPATH TABLEのVALUE列に、日付値の2次索引を作成します。
CREATENUMBERINDEXプロシージャ	XMLIndexの記憶表であるPATH TABLEのVALUE列に、数値の2次索引を作成します。
DROPPARAMETERプロシージャ	指定したパラメータ識別子に関連付けられているXMLIndexパラメータ文字列を削除します。
MODIFYPARAMETERプロシージャ	指定したパラメータ名に関連付けられているXMLIndexパラメータ文字列を変更します。
REGISTERPARAMETERプロシージャ	パラメータ文字列とXMLIndexパラメータ文字列のペアをXDBに登録します。
SYNCINDEXプロシージャ	索引を手動で同期化します。

---

CREATEDATEINDEXプロシージャ

このプロシージャは、XMLIndexの記憶表であるPATH TABLEのVALUE列に、日付値の2次索引を作成します。プロシージャの2番目の形式を使用すると、date_index_clauseを空の文字列に設定できます。

構文

DBMS_XMLINDEX.CREATEDATEINDEX  (
   xml_index_schema   IN   VARCHAR2,
   xml_index_name     IN   VARCHAR2,
   date_index_name    IN   VARCHAR2,
   xmltypename        IN   VARCHAR2,
   date_index_clause  IN   VARCHAR2);

DBMS_XMLINDEX.CREATEDATEINDEX  (
   xml_index_schema   IN   VARCHAR2
   xml_index_name     IN   VARCHAR2,
   date_index_name    IN   VARCHAR2,
   xmltypename        IN   VARCHAR2);

パラメータ

表173-2 CREATEDATEINDEXプロシージャのパラメータ

パラメータ	説明
xml_index_schema	XMLIndexの所有者の名前。
xml_index_name	XMLIndexの名前。
date_index_name	xml_index_schemaが所有するxml_index_nameという名前のXMLIndexのPATH TABLEのVALUE列に、日付値に対して作成される2次索引の名前。
xmltypename	パス表のVALUE列内の値が変換されるタイプ。指定可能な値の文字列は、DATETIME、TIME、DATE、GDAY、GMONTH、GYEAR、GYEARMONTH、GMONTHDAYです。
date_index_clause	作成時に日付索引に適用するSTORAGE句。日付索引を作成するためにCREATE INDEX文に追加される文字列引数です。

---

CREATENUMBERINDEXプロシージャ

このプロシージャは、XMLIndexの記憶表であるPATH TABLEのVALUE列に、数値の2次索引を作成します。

構文

DBMS_XMLINDEX.CREATENUMBERINDEX (
   xml_index_schema   IN   VARCHAR2,
   xml_index_name     IN   VARCHAR2,
   num_index_name     IN   VARCHAR2,
   num_index_clause   IN   VARCHAR2,
   xmltypename        IN   VARCHAR2);

パラメータ

表173-3 CREATENUMBERINDEXプロシージャのパラメータ

パラメータ	説明
xml_index_schema	XMLIndexの所有者の名前。
xml_index_name	XMLIndexの名前。
num_index_name	xml_index_schemaが所有するxml_index_nameという名前のXMLIndexのPATH TABLEのVALUE列に、数値に対して作成される2次索引の名前。
num_index_clause	作成時に数値索引に適用するSTORAGE句。数値索引を作成するためにCREATE INDEX文に追加される文字列引数です。
xmltypename	パス表のVALUE列内の値が変換されるタイプ。指定可能な値の文字列は、FLOAT、DOUBLE、DECIMAL、INTEGER、NONPOSITIVEINTEGER、NEGATIVEINTEGER、LONG、INT、SHORT、BYTE、NONNEGATIVEINTEGER、UNSIGNEDLONG、UNSIGNEDINT、UNSIGNEDSHORT、UNSIGNEDBYTE、POSITIVEINTEGERです。

---

DROPPARAMETERプロシージャ

このプロシージャは、指定したパラメータ識別子に関連付けられているXMLIndexパラメータ文字列を削除します。

構文

DBMS_XMLINDEX.DROPPARAMETER (
   name        IN      VARCHAR2); 

パラメータ

表173-4 DROPPARAMETERプロシージャのパラメータ

パラメータ	説明
name	パラメータ文字列の識別子

例

DBMS_XMLINDEX.DROPPARAMETER ( 
   'myIndexParam');

---

MODIFYPARAMETERプロシージャ

このプロシージャは、指定したパラメータ識別子に関連付けられているXMLIndexパラメータ文字列を変更します。

構文

DBMS_XMLINDEX.MODIFYPARAMETER (
   name        IN      VARCHAR2, 
   parameter   IN      CLOB); 

パラメータ

表173-5 MODIFYPARAMETERプロシージャのパラメータ

パラメータ	説明
name	パラメータ文字列の識別子
parameter	CREATE INDEXまたはALTER INDEX文で使用可能なXMLIndexパラメータ句

例

DBMS_XMLINDEX.MODIFYPARAMETER ( 
   'myIndexParam', 
   'PATH TABLE po_ptab 
    PATH ID INDEX po_pidx 
    ORDER KEY INDEX po_oidx 
    VALUE INDEX po_vidx');

---

REGISTERPARAMETERプロシージャ

このプロシージャは、パラメータ識別子とXMLIndexパラメータ文字列のペアをXDBに登録します。

構文

DBMS_XMLINDEX.REGISTERPARAMETER (
   name        IN      VARCHAR2, 
   parameter   IN      CLOB); 

パラメータ

表173-6 REGISTERPARAMETERプロシージャのパラメータ

パラメータ	説明
name	パラメータ文字列の識別子
parameter	CREATE INDEXまたはALTER INDEX文で使用可能なXMLIndexパラメータ句

例

DBMS_XMLINDEX.REGISTERPARAMETER ( 
   'myIndexParam', 
   'PATH TABLE po_ptab 
    PATH ID INDEX po_pidx 
    ORDER KEY INDEX po_oidx 
    VALUE INDEX po_vidx 
    PATHS(NAMESPACE MAPPING(xmlns:p="http://www.example.com/IPO")) 
    GROUP MASTERGROUP XMLTABLE PO_TAB 
    (''/p:PurchaseOrder'' 
        COLUMNS 
           REFERENCE VARCHAR2(30) PATH ''p:Reference'', 
           REQUESTOR VARCHAR2(30) PATH ''p:Requestor'' ) 
    GROUP ITEMGROUP XMLTABLE ITEMGROUP_TAB     
    (''/p:PurchaseOrder/p:LineItems/p:LineItem'' 
        COLUMNS 
           LINENUMBER NUMBER(38) PATH ''@p:ItemNumber'', 
           QUANTITY NUMBER(38) PATH ''@p:Quantity'', 
           DESCRIPTION VARCHAR2(256) PATH ''p:Description'' ));

---

SYNCINDEXプロシージャ

このファンクションは、非同期にメンテナンスされたXMLIndexを同期化します。これは、保留中の表に記録されるXMLIndex変更に適用され、ベースXMLTYPE列を含むパス表を最新にします。

構文

DBMS_XMLINDEX.SYNCINDEX (
   xml_index_schema      IN VARCHAR2,
   xml_index_name        IN VARCHAR2,
   partition_name        IN VARCHAR2 DEFAULT NULL,
   reindex               IN BOOLEAN DEFAULT FALSE);

パラメータ

表173-7 SYNCINDEXプロシージャのパラメータ

パラメータ	説明
xml_index_schema	XMLIndexの所有者の名前。
xml_schema_name	XMLIndexの名前。
partition_name	現在サポートされていません。
reindex	デフォルトはFALSEです。TRUEに設定されている場合は、2次索引を削除して、バルクロードできるように再作成します。

例

EXEC DBMS_XMLINDEX.SYNCINDEX('USER1', 'SS_TAB_XMLI', REINDEX=>TRUE);