121 DBMS_XDB

DBMS_XDBの使用方法

この項では、DBMS_XDBパッケージの使用に関連する項目について説明します。

• 概要

• 定数

---

概要

DBMS_XDBパッケージは次の機能をサポートしています。

• リソース管理機能は、LINKプロシージャ、EXISTSRESOURCEファンクション、LOCKRESOURCEファンクション、GETLOCKTOKENプロシージャ、UNLOCKRESOURCEファンクション、CREATERESOURCEファンクション、RENAMERESOURCEプロシージャ、DELETERESOURCEプロシージャ、GETRESOIDファンクション、CREATEOIDPATHファンクション、REBUILDHIERARCHICALINDEXプロシージャおよびCREATEFOLDERファンクションのサブプログラムを提供し、リソース・ビューを補完します。

• アクセス制御リスト（ACL）ベースのセキュリティ・メカニズムは、データベースによって保存された階層内ACLまたはデータベース外から保存されたメモリー内ACLで使用できます。これらのメソッドの一部は、Oracleリソースおよび任意のデータベース・オブジェクトの両方に使用できます。Oracleリソースには、CHECKPRIVILEGESファンクション、GETACLDOCUMENTファンクション、CHANGEPRIVILEGESファンクション、GETPRIVILEGESファンクションおよびLINK プロシージャを使用します。ACLCHECKPRIVILEGESファンクションは、階層内にオブジェクトを格納せずに、OracleのACLベースのセキュリティ・メカニズムへのアクセスを提供します。

• 構成セッション管理はCFG_REFRESHプロシージャ、CFG_GETファンクションおよびCFG_UPDATEプロシージャのメソッドでサポートされます。

• XDBユーザー名はXDBインストール時に作成されます。このユーザーは一連のデフォルトの表およびパッケージを所有します。 GETXDB_TABLESPACEファンクションおよびMOVEXDB_TABLESPACEプロシージャは、指定した表領域にスキーマを移動でき、デフォルトのSYSAUX表領域の導入をサポートしています。

---

定数

DBMS_XDBサブプログラムの要約

---

ACLCHECKPRIVILEGESファンクション

このファンクションは、リソースのOWNERによる指定したACLドキュメントによって、現在のユーザーに付与されたアクセス権限をチェックします。すべての権限が付与されている場合は、正の整数を戻します。

構文

DBMS_XDB.ACLCHECKPRIVILEGES(
   acl_path  IN  VARCHAR2,
   owner     IN  VARCHAR2,
   privs     IN  xmltype)
 RETURN PLS_INTEGER;

パラメータ

---

APPENDRESOURCEMETADATAプロシージャ

このプロシージャは、ユーザー定義のメタデータをXMLTYPEへのREFまたはXMLTYPEとして使用し、目的のリソースに追加します。

構文

DBMS_XDB.APPENDRESOURCEMETADATA (
 abspath   IN  VARCHAR2,
 metadata  IN  XMLTYPE);

DBMS_XDB.APPENDRESOURCEMETADATA (
 abspath   IN  VARCHAR2,
 metadata  IN  REF SYS.XMLTYPE);

パラメータ

使用上の注意

• REFが渡された場合、このプロシージャは、REFをリソースに、メタデータは別の表に格納します。この場合は、メタデータ表のRESID列に移入する必要があります。渡されるREFは一意である必要があることに注意してください。つまり、リソース・メタデータ内に同じ値を持つREFを格納することはできません。プロパティの一意性に違反するためです。すでに存在するREFを追加しようとすると、エラーが発生します。

• XMLTYPEが渡された場合、データを解析してスキーマ・ベースかどうかを判断し、その結果に応じてデータを格納します。

---

CFG_GETファンクション

このファンクションは、セッションの構成情報をXMLTypeインスタンスとして取得します。

構文

DBMS_XDB.CFG_GET
 RETURN SYS.XMLType;

---

CFG_REFRESHプロシージャ

このプロシージャは、セッションの最新の構成情報を反映します。

構文

DBMS_XDB.CFG_REFRESH;

---

CFG_UPDATEプロシージャ

このプロシージャは、構成情報を更新して、変更をコミットします。

構文

DBMS_XDB.CFG_UPDATE(
   xdbconfig   IN  SYS.XMLTYPE);

パラメータ

---

CHANGEPRIVILEGESファンクション

このファンクションは、指定したACEを、指定したリソースのACLに追加します。

構文

DBMS_XDB.CHANGEPRIVILEGES(
   res_path   IN    VARCHAR2,
   ace        IN    xmltype)
 RETURN PLS_INTEGER;

パラメータ

戻り値

ACLが正常に変更された場合は、正の整数。

使用上の注意

同じprincipalおよび同じ操作（grant/deny）を持つACEがACLに存在しない場合、新規のACEがACLの最後に追加されます。

---

CHECKPRIVILEGESファンクション

このファンクションは、指定したリソースに対して現行ユーザーに付与されているアクセス権限をチェックします。

構文

DBMS_XDB.CHECKPRIVILEGES(
   res_path   IN  VARCHAR2,
   privs      IN  xmltype)
 RETURN PLS_INTEGER;

パラメータ

戻り値

要求された権限がすべて付与されている場合は、正の整数。

---

CREATEFOLDERファンクション

このファンクションは階層内に新規フォルダ・リソースを作成します。

構文

DBMS_XDB.CREATEFOLDER(
   path   IN  VARCHAR2)
 RETURN BOOLEAN;

パラメータ

戻り値

操作が成功した場合はTRUE。そうでない場合はFALSE。

使用上の注意

指定したパス名の親フォルダは、階層内にすでに存在している必要があります。たとえば、pathパラメータに'/folder1/folder2'を指定する場合は、'/folder1'がすでに存在している必要があります。

---

CREATEOIDPATHファンクション

このファンクションは、オブジェクトIDに基づいたリソースの仮想パスを作成します。

構文

DBMS_XDB.CREATEOIDPATH(
   oid    IN   RAW)
 RETURN VARCHAR2;

パラメータ

---

CREATERESOURCEファンクション

このファンクションは新しいリソースを作成します。オーバーロード・オプションの記述は各バージョンの構文の前に配置します。

構文

指定した文字列を内容として使用し、新規リソースを作成します。

DBMS_XDB.CREATERESOURCE(
   path    IN  VARCHAR2,
   data    IN  VARCHAR2)
 RETURN BOOLEAN;

指定したXMLTypeデータを内容として使用し、新規リソースを作成します。

DBMS_XDB.CREATERESOURCE(
   path    IN  VARCHAR2,
   data    IN  SYS.XMLTYPE)
 RETURN BOOLEAN;

既存のXMLType行にREFを指定し、その行を指す内容を持つリソースを作成します。この行は、別のリソース内に事前に存在させることはできません。

DBMS_XDB.CREATERESOURCE(
   path     IN  VARCHAR2,
   datarow  IN  REF SYS.XMLTYPE)
 RETURN BOOLEAN;

内容として指定したBLOBを使用して、リソースを作成し、ソースBLOBのキャラクタ・セットを指定します。

DBMS_XDB.CREATERESOURCE(
   path    IN  VARCHAR2,
   data    IN  BLOB,
   csid    IN  NUMBER :=0)
 RETURN BOOLEAN;

内容として指定したBFILEを使用して、リソースを作成し、ソースBFILEのキャラクタ・セットを指定します。

DBMS_XDB.CREATERESOURCE(
   path    IN  VARCHAR2,
   data    IN  BFILE,
   csid    IN  NUMBER :=0)
 RETURN BOOLEAN;

指定したCLOBを内容として使用し、リソースを作成します。

DBMS_XDB.CREATERESOURCE(
   path    IN  VARCHAR2,
   data    IN  CLOB)
 RETURN BOOLEAN;

パラメータ

戻り値

操作が成功した場合はTRUE。そうでない場合はFALSE。

---

DELETERESOURCEプロシージャ

このプロシージャは、階層からリソースを削除します。

構文

DBMS_XDB.DELETERESOURCE(
   path          IN      VARCHAR2,
   delete_option IN      PLS_INTEGER);

パラメータ

---

DELETERESOURCEMETADATAプロシージャ

このプロシージャは、絶対パスでリソースを使用し、REFで識別されるスキーマ・ベースのメタデータ、またはネームスペースと名前の組合せで識別されるメタデータ（スキーマ・ベースまたは非スキーマ・ベースのメタデータ）を削除します。また、メタデータの削除方法を指定する追加パラメータ（オプション）も使用します。このパラメータは、削除する必要があるスキーマ・ベースのリソース・メタデータにのみ使用されます。非スキーマ・ベースのメタデータの場合、このパラメータは無視されます。

構文

次の構文は、スキーマ・ベースのメタデータにのみ使用できます。

DBMS_XDB.DELETERESOURCEMETADATA (
   abspath        IN  VARCHAR2,
   metadata       IN  REF SYS.XMLTYPE,
   delete_option  IN  pls_integer := dbms_xdb.DELETE_RESOURCE_METADATA_CASCADE);

次の構文は、スキーマ・ベースまたは非スキーマ・ベースのメタデータに使用できます。

DBMS_XDB.DELETERESOURCEMETADATA (
   abspath        IN VARCHAR2,
   metadatans     IN VARCHAR2,
   metadataname   IN VARCHAR2,
   delete_option  IN pls_integer := dbms_xdb.DELETE_RESOURCE_METADATA_CASCADE);

パラメータ

---

EXISTSRESOURCEファンクション

このファンクションは、リソースが階層内にあるかどうかを示します。絶対パスを表す文字列によってリソースを照合します。

構文

DBMS_XDB.EXISTSRESOURCE(
   abspath    IN    VARCHAR2)
 RETURN BOOLEAN;

パラメータ

戻り値

リソースが見つかった場合はTRUE。

---

GETACLDOCUMENTファンクション

このファンクションは、パス名を指定して、リソースを保護するACLドキュメントを取得します。

構文

DBMS_XDB.GETACLDOCUMENT(
   abspath  IN  VARCHAR2)
  RETURN sys.xmltype;

パラメータ

戻り値

ACLドキュメントのXMLType。

---

GETFTPPORTファンクション

このプロシージャは、現在のFTPポートの値を取得します。

構文

DBMS_XDB.GETFTPPORT
 RETURN NUMBER;

---

GETHTTPPORTファンクション

このプロシージャは、現在のHTTPポートの値を取得します。

構文

DBMS_XDB.GETHTTPPORT
 RETURN NUMBER;

---

GETLOCKTOKENプロシージャ

リソースへのパスを指定して、現行ユーザーのリソースのロック・トークンを戻します。

構文

DBMS_XDB.GETLOCKTOKEN(
   path         IN      VARCHAR2,
   locktoken    OUT     VARCHAR2);

パラメータ

使用上の注意

ユーザーには、リソースに対するREADPROPERTIES権限が必要です。

---

GETPRIVILEGESファンクション

このファンクションは、指定したリソースに対して現行ユーザーに付与されている権限をすべて取得します。

構文

DBMS_XDB.GETPRIVILEGES(
   res_path    IN     VARCHAR2)
 RETURN sys.xmltype;

パラメータ

戻り値

<privilege>要素のXMLTypeインスタンス。これには、このリソースに対して現行のユーザーに付与されたすべてのリーフ権限のリストが含まれています。

---

GETRESOIDファンクション

リソースの絶対パスからオブジェクトIDを戻します。

構文

DBMS_XDB.GETRESOID(
   abspath IN VARCHAR2)
RETURN RAW;

パラメータ

戻り値

リソースが存在しない場合はNULL。

---

GETXDB_TABLESPACEファンクション

このファンクションは、XDB（ユーザー）の現行の表領域を戻します。

構文

DBMS_XDB.GETXDB_TABLESPACE
 RETURN VARCHAR2;

---

LINKプロシージャ

このプロシージャは、既存のリソースへのリンクを作成します。

構文

DBMS_XDB.LINK(
   srcpath    IN  VARCHAR2,
   linkfolder IN  VARCHAR2,
   linkname   IN  VARCHAR2);

パラメータ

---

LOCKRESOURCEファンクション

リソースへのパスを指定して、リソースに対するWebDAVスタイルのロックを取得します。

構文

DBMS_XDB.LOCKRESOURCE(
   path      IN  VARCHAR2,
   depthzero IN  BOOLEAN,
   shared    IN  boolean)
RETURN BOOLEAN;

パラメータ

戻り値

成功した場合はTRUE。

使用上の注意

ユーザーには、リソースに対するUPDATE権限が必要です。

---

MOVEXDB_TABLESPACEプロシージャ

このプロシージャは、指定した表領域にXDB（ユーザー）を移動します。

構文

DBMS_XDB.MOVEXDB_TABLESPACE(
   new_tablespace   IN  VARCHAR2);

パラメータ

使用上の注意

この処理は、すべての同時XDBセッションの終了を待機します。

---

PURGERESOURCEMETADATAプロシージャ

このプロシージャは、リソースからすべてのユーザー・メタデータを削除します。スキーマ・ベースのメタデータはカスケード・モードで削除され、対応するメタデータ表から行が削除されます。

構文

DBMS_XDB.PURGERESOURCEMETADATA(
 abspath  IN  VARCHAR2);

パラメータ

---

REBUILDHIERARCHICALINDEXプロシージャ

このプロシージャは、インポートまたはエクスポート操作後に、階層の索引を再作成します。これは、データを索引表からエクスポートできないため必要です。

構文

DBMS_XDB.REBUILDHIERARCHICALINDEX;

---

RENAMERESOURCEプロシージャ

このプロシージャは、XDBリソースの名前を変更します。

構文

DBMS_XDB.RENAMERESOURCE(
   srcpath    IN  VARCHAR2,
   destfolder IN  CARCHAR2,
   newname    IN  VARCHAR2);

パラメータ

---

SETACLプロシージャ

このプロシージャは、指定のリソースに対するACLを、パスで指定したACLに設定します。

構文

DBMS_XDB.SETACL(
   res_path   IN  VARCHAR2,
   acl_path   IN  VARCHAR2);

パラメータ

使用上の注意

ユーザーには、リソースに対する<write-acl>権限が必要です。

---

SETFTPPORTプロシージャ

このプロシージャは、FTPポートを新しい値に設定します。

構文

DBMS_XDB.SETFTPPORT(
   new_port  IN  NUMBER);

パラメータ

---

SETHTTPPORTプロシージャ

このプロシージャは、HTTPポートを新しい値に設定します。

構文

DBMS_XDB.SETHTTPPORT(
   new_port  IN  NUMBER);

パラメータ

---

UPDATERESOURCEMETADATAプロシージャ

このプロシージャは、リソースのメタデータを更新します。このプロシージャは、絶対パスで識別されるリソース、およびREFで識別されて置き換えられる、そのリソース内のメタデータを使用します。メタデータの一部をユーザー定義のメタデータ（XMLTYPEへのREFまたはXMLTYPEのいずれかの形式）に置き換えます。

構文

次の構文は、スキーマ・ベースのメタデータの更新にのみ使用できます。新しいメタデータは、スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath  IN VARCHAR2,
   oldmetadata    IN   REF SYS.XMLTYPE,
   newmetadata    IN   REF SYS.XMLTYPE)

次の構文は、スキーマ・ベースのメタデータの更新にのみ使用できます。新しいメタデータは、スキーマ・ベースまたは非スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath        IN   VARCHAR2,
   oldmetadata    IN   REF SYS.XMLTYPE,
   newmetadata    IN   XMLTYPE);

次の構文は、スキーマ・ベースおよび非スキーマ・ベースの両方のメタデータに使用できます。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath        IN   VARCHAR2,
   oldns          IN   VARCHAR2,
   oldname IN VARCHAR,
   newmetadata IN XMLTYPE);

次の構文は、スキーマ・ベースおよび非スキーマ・ベースの両方のメタデータに使用できます。新しいメタデータは、スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath       IN   VARCHAR2,
   oldns         IN   VARCHAR2,
   oldname       IN   VARCHAR,
   newmetadata   IN   REF SYS.XMLTYPE);

パラメータ

使用上の注意

REFの場合、このプロシージャは、REFをリソースに、メタデータは別の表に格納します。REFの一意性が維持されます。XMLTYPEが渡された場合、データを解析してスキーマ・ベースかどうかを判断し、その結果に応じてデータを格納します。

---

UNLOCKRESOURCEファンクション

このファンクションは、ロック・トークンとリソースへのパスを指定して、リソースのロックを解除します。

構文

DBMS_XDB.UNLOCKRESOURCE(
   path     IN  VARCHAR2,
   deltoken IN  VARCHAR2)
 RETURN BOOLEAN;

パラメータ

戻り値

操作が成功した場合はTRUE。

使用上の注意

ユーザーには、リソースに対するUPDATE権限が必要です。