日本語PDF
  1. PL/SQLパッケージおよびタイプ・リファレンス
  2. DBMS_XDB

196 DBMS_XDB

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

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

  • リソース・ビューを補完するリソース管理サブプログラム

  • アクセス制御リスト(ACL)ベースのセキュリティ・メカニズム

  • 構成セッション管理

  • XDBユーザー名の作成

この章のトピックは、次のとおりです:

参照:

196.1 DBMS_XDBの概要

DBMS_XDBは、管理機能の範囲を提供します。

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

196.2 DBMS_XDBのセキュリティ・モデル

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

196.3 DBMS_XDBの定数

次の表に示すすべての定数は、Oracleリリース12cでは非推奨です。

これらは、DBMS_XDB_CONFIGパッケージまたはDBMS_XDB_REPOSパッケージに再配置されます。ケースごとの転送の詳細は、再配置済の列に記載されています。

定数は、新規アプリケーションのDBMS_XDBコンテキストで使用しないことをお薦めします。推奨されない機能は、下位互換性を維持する目的のみでサポートされており、今後のバージョンでは終了する場合があります。

表196-1 DBMS_XDBの定数

定数 タイプ 値 説明 再配置済

DELETE_RESOURCE

NUMBER

1

リソースを削除します。リソースに子がある場合失敗します。

DBMS_XDB_REPOS

DELETE_RECURSIVE

NUMBER

2

リソースと子がある場合それを削除します。

DBMS_XDB_REPOS

DELETE_FORCE

NUMBER

3

含まれるオブジェクトが無効な場合でも、リソースを削除します。

DBMS_XDB_REPOS

DELETE_RECURSIVE_FORCE

NUMBER

4

含まれるオブジェクトが無効な場合でも、リソースと子がある場合それを削除します。

DBMS_XDB_REPOS

DELETE_RES_METADATA_CASCADE

NUMBER

1

メタデータ表内の対応する行を削除します。

DBMS_XDB_REPOS

DELETE_RES_METADATA_NOCASCADE

NUMBER

2

メタデータ表内の行を削除しません。

DBMS_XDB_REPOS

DEFAULT_LOCK_TIMEOUT CONSTANT

PLS_INTEGER

(60*60)

ロックが期限切れになるまでのデフォルト時間(秒)。

DBMS_XDB_REPOS

LINK_TYPE_HARD

NUMBER

1

作成するリンクのタイプ(デフォルト)。

DBMS_XDB_REPOS

LINK_TYPE_WEAK

NUMBER

2

作成するリンクのタイプ。

DBMS_XDB_REPOS

LINK_TYPE_SYMBOLIC

NUMBER

3

作成するリンクのタイプ。

DBMS_XDB_REPOS

ON_DENY_NEXT_CUSTOM

NUMBER

1

アクセスが拒否された場合、次のカスタム認可が試行されます。

DBMS_XDB_CONFIG

ON_DENY_BASIC

NUMBER

2

アクセスが拒否された場合、Basic認証が使用されます。

DBMS_XDB_CONFIG

196.4 DBMS_XDBサブプログラムの要約

この表は、DBMS_XDBサブプログラムを示し、簡単に説明しています。

表196-2 DBMS_XDBパッケージのサブプログラム

サブプログラム 説明

ACLCHECKPRIVILEGESファンクション

指定のACLドキュメントで指定されている現行ユーザーに付与されたアクセス権限をチェックします。このアクセス権限は、所有者が'owner'パラメータで指定されているリソースに対するものです。

APPENDRESOURCEMETADATAプロシージャ

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

CHANGEOWNERプロシージャ

リソースの所有者を指定した所有者に変更します。

CHANGEPRIVILEGESファンクション

指定したACEを、指定したリソースのACLに追加します。

CHECKPRIVILEGESファンクション

指定したリソースに対して現行ユーザーに付与されているアクセス権限をチェックします。

CREATEFOLDERファンクション

階層内に新規フォルダ・リソースを作成します。

CREATEOIDPATHファンクション

オブジェクトIDに基づいたリソースの仮想パスを作成します。

CREATERESOURCEファンクション

新規リソースを作成します。

DELETERESOURCEプロシージャ

階層からリソースを削除します。

DELETERESOURCEMETADATAプロシージャ

リソースからメタデータを削除します(スキーマ・ベースまたは非スキーマ・ベースのメタデータに使用できます)。

ENABLEDIGESTAUTHENTICATIONプロシージャ

Digest認証を有効にします

EXISTSRESOURCEファンクション

リソースの絶対パスに基づいて、リソースが階層であるかどうかを判別します。

GETACLDOCUMENTファンクション

パス名を指定して、リソースを保護するACLドキュメントを取得します。

GETCONTENTBLOBファンクション

BLOBとして戻されたリソースの内容を取り出します。

GETCONTENTCLOBファンクション

CLOBとして戻されたリソースの内容を取り出します。

GETCONTENTVARCHAR2ファンクション

文字列として戻されたリソースの内容を取り出します。

GETCONTENTXMLREFファンクション

XMLTYPEへのREFとして戻されたリソースの内容を取り出します。

GETCONTENTXMLTYPEファンクション

XMLTYPEとして戻されたリソースの内容を取り出します。

GETHTTPREQUESTHEADERファンクション

渡されたヘッダーの値を取得します。

GETLOCKTOKENプロシージャ

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

GETPRIVILEGESファンクション

指定したリソース上の現在のユーザーに付与された権限をすべて取得します。

GETRESOIDファンクション

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

GETXDB_TABLESPACEファンクション

XDB(ユーザー)の現行の表領域を戻します。

HASBLOBCONTENTファンクション

リソースにBLOBコンテンツがある場合はTRUEを戻します。

HASCHARCONTENTファンクション

リソースに文字コンテンツがある場合はTRUEを戻します。

HASXMLCONTENTファンクション

リソースにXMLコンテンツがある場合はTRUEを戻します。

HASXMLREFERENCEファンクション

リソースにXMLコンテンツへのREFがある場合は、TRUEを戻します。

ISFOLDERファンクション

リソースがフォルダまたはコンテナの場合は、TRUEを戻します。

LINKプロシージャ

既存のリソースへのリンクを作成します。

LOCKRESOURCEファンクション

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

PROCESSLINKSプロシージャ

指定したリソース内のドキュメント・リンクを処理します。

PURGERESOURCEMETADATAプロシージャ

リソースからすべてのユーザー・メタデータを削除します。

RENAMERESOURCEプロシージャ

XDBリソースの名前を変更します。

SETACLプロシージャ

指定したリソースにACLを設定します。

SPLITPATHプロシージャ

パスを親のパスと子のパスに分割します。

TOUCHRESOURCEプロシージャ

リソースの変更時刻を現在の時刻に変更します。

UNLOCKRESOURCEファンクション

ロック・トークンおよびリソース・パスを指定して、リソースのロックを解除します。

UPDATERESOURCEMETADATAプロシージャ

リソースのメタデータを更新します。

196.4.1 ACLCHECKPRIVILEGESファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(ACLCHECKPRIVILEGESファンクション)を使用してください。

構文

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

パラメータ

表196-3 ACLCHECKPRIVILEGESファンクションのパラメータ

パラメータ 説明

acl_path

ACLドキュメントの階層内の絶対パス。

owner

リソースの所有者名。疑似ユーザー「DAV:owner」は、ACL権限の解決時にこのユーザーに置き換えられます。

privs

privilege要素のXMLTypeインスタンスで、要求された一連のアクセス権限を指定します。CHECKPRIVILEGESファンクションを参照してください。

196.4.2 APPENDRESOURCEMETADATAプロシージャ

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(APPENDRESOURCEMETADATAプロシージャ)を使用してください。

構文

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

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

パラメータ

表196-4 APPENDRESOURCEMETADATAプロシージャ

パラメータ 説明

abspath

リソースの絶対パス。

metadata

メタデータには、スキーマ・ベースまたは非スキーマ・ベースのメタデータを使用できます。スキーマ・ベースのメタデータは、独自の表に格納されます。

使用上のノート

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

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

196.4.3 CHANGEOWNERプロシージャ

このプロシージャは、リソースの所有者を指定した所有者に変更します。リリース12cでは、このプロシージャの使用は推奨されていません。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CHANGEOWNERプロシージャ)を使用してください。

構文

DBMS_XDB.CHANGEOWNER(
     abspath    IN   VARCHAR2,
     owner      IN   VARCHAR2,
     recurse    IN   BOOLEAN := FALSE);

パラメータ

表196-5 CHANGEOWNERプロシージャのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

owner

リソースの新しい所有者。

recurse

TRUEの場合は、フォルダ・ツリー内のすべてのリソースの所有者を再帰的に変更します。

196.4.4 CHANGEPRIVILEGESファンクション

このファンクションは、指定したACEを指定したリソースのACLに追加します。リリース12cでは、このプロシージャの使用は推奨されていません。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CHANGEPRIVILEGESファンクション)を使用してください。

構文

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

パラメータ

表196-6 CHANGEPRIVILEGESファンクションのパラメータ

パラメータ 説明

res_path

権限を変更する必要があるリソースのパス名。

ace

<ace>要素のXMLTypeインスタンス。この要素は、<principal>、<grant>操作および権限リストを指定します。

戻り値

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

使用上のノート

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

196.4.5 CHECKPRIVILEGESファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CHECKPRIVILEGESファンクション)を使用してください。

構文

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

パラメータ

表196-7 CHECKPRIVILEGESファンクションのパラメータ

パラメータ 説明

res_path

リソースの階層内の絶対パス。

privs

privilege要素のXMLTypeインスタンスで、要求された一連のアクセス権限を指定します

戻り値

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

196.4.6 CREATEFOLDERファンクション

この非推奨となったファンクションは、階層内に新規フォルダ・リソースを作成します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CREATEFOLDERファンクション)を使用してください。

構文

DBMS_XDB.CREATEFOLDER(
   path   IN  VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-8 CREATEFOLDERファンクションのパラメータ

パラメータ 説明

path

新規フォルダのパス名。

戻り値

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

使用上のノート

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

196.4.7 CREATEOIDPATHファンクション

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

ノート:

リリース12cでは、このファンクションの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CREATEOIDPATHファンクション)を使用してください。

構文

DBMS_XDB.CREATEOIDPATH(
   oid    IN   RAW)
 RETURN VARCHAR2;

パラメータ

表196-9 CREATEOIDPATHファンクションのパラメータ

パラメータ 説明

oid

リソースのオブジェクトID。

196.4.8 CREATERESOURCEファンクション

この非推奨となったファンクションは、新規リソースを作成します。オーバーロード・オプションの記述は各バージョンの構文の前に配置します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(CREATERESOURCEファンクション)を使用してください。

構文

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

DBMS_XDB.CREATERESOURCE(
     abspath        IN  VARCHAR2,
     datarow        IN  REF SYS.XMLTYPE,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

内容として指定したBLOBを使用して、リソースを作成し、ソースBLOBの文字セットを指定します。 

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

内容として指定したBFILEを使用して、リソースを作成し、ソースBFILEの文字セットを指定します。 

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

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

DBMS_XDB.CREATERESOURCE (
     abspath        IN  VARCHAR2,
     data           IN  CLOB,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

文字列を指定すると、その文字列を内容として持つ新規リソースを階層に挿入します。

DBMS_XDB.CREATERESOURCE (
   abspath        IN  VARCHAR2, 
   data           IN  VARCHAR2,
   schemaurl      IN  VARCHAR2 := NULL,
   elem           IN  VARCHAR2 := NULL)
 RETURN BOOLEAN;

XMLTYPEおよびスキーマURLを指定すると、XMLTYPEを内容として持つ新規リソースを階層に挿入します。 

DBMS_XDB.CREATERESOURCE (
   abspath        IN  VARCHAR2, 
   data           IN  SYS.XMLTYPE,
   schemaurl      IN  VARCHAR2 := NULL,
   elem           IN  VARCHAR2 := NULL)
 RETURN BOOLEAN;

パラメータ

表196-10 CREATERESOURCEファンクションのパラメータ

パラメータ 説明

abspath

作成するリソースの絶対パス。パス名の親フォルダは、階層内にすでに存在している必要があります。たとえば、/foo/bar.txtと指定する場合は、フォルダ/fooがすでに存在している必要があります。

data

新規リソースの内容が含まれている文字列バッファ。データは解析され、スキーマに基づいたXML文書が含まれているかどうかがチェックされ、含まれている場合、内容はスキーマのデフォルト表にスキーマに基づいたものとして格納されます。含まれていない場合は、バイナリ・データとして保存されます。

datarow

内容として使用するXMLType行へのREF

csid

ドキュメントの文字セットID。有効なOracle IDである必要があり、無効な場合、エラーが戻されます。

CSIDを指定しない場合またはCSIDに0(ゼロ)を指定した場合、ドキュメントの文字セットIDは次のように判断されます。

  • abspath拡張子から、リソースのMIMEタイプを判断します。

  • MIMEタイプが*/xmlの場合、エンコードはhttp://www.w3.org/TR/2000/REC-xml-20001006のW3C XML 1.0 ReferenceのAppendix Fに基づいて検出されます。

  • それ以外の場合、デフォルトでデータベースの文字セットに設定されます。

createfolders

TRUEの場合、親フォルダが存在しないときには作成します。

schemaurl

XMLデータの場合、データが準拠するスキーマURL(デフォルトはNULL)。

elem

要素名(デフォルトはNULL)。

戻り値

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

196.4.9 DELETERESOURCEプロシージャ

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(DELETERESOURCEプロシージャ)を使用してください。

構文

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

パラメータ

表196-11 DELETERESOURCEプロシージャのパラメータ

パラメータ 説明

path

削除するリソースのパス名。

delete_option

表196-1で定義されたリソースの削除方法を制御するオプション:

  • DELETE_RESOURCE

  • DELETE_RECURSIVE

  • DELETE_FORCE

  • DELETE_RECURSIVE_FORCE

196.4.10 DELETERESOURCEMETADATAプロシージャ

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(DELETERESOURCEMETADATAプロシージャ)を使用してください。

構文

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

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

パラメータ

表196-12 DELETERESOURCEMETADATAプロシージャのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

metadata

削除する(スキーマ・ベースの)メタデータの一部へのREF。

mettadatans

削除するメタデータの断片のネームスペース。

mettadataname

削除するメタデータの断片のローカル名。

delete_option

スキーマ・ベースのメタデータにのみ適用できます。このパラメータは次のいずれかになります。

  • DELETE_RES_METADATA_CASCADE - メタデータ表内の対応する行を削除します。

  • DELETE_RES_METADATA_NOCASCADE - メタデータ表内の行を削除しません。

196.4.11 ENABLEDIGESTAUTHENTICATIONプロシージャ

この推奨されないプロシージャはDigest認証を有効にします。DigestがXML DB HTTPサーバーで使用される最初の認証メカニズムとしてリストされます。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_CONFIG パッケージの同じ名前のサブプログラム(ENABLEDIGESTAUTHENTICATIONプロシージャ)を使用してください。

構文

DBMS_XDB.ENABLEDIGESTAUTHENTICATION;

196.4.12 EXISTSRESOURCEファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(EXISTSRESOURCEファンクション)を使用してください。

構文

DBMS_XDB.EXISTSRESOURCE(
   abspath    IN    VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-13 EXISTSRESOURCEファンクションのパラメータ

パラメータ 説明

abspath

ACLドキュメントが必要なリソースのパス名。

戻り値

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

196.4.13 GETACLDOCUMENTファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETACLDOCUMENTファンクション)を使用してください。

構文

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

パラメータ

表196-14 GETACLDOCUMENTファンクションのパラメータ

パラメータ 説明

abspath

ACLドキュメントが必要なリソースのパス名。

戻り値

ACLドキュメントのXMLType。

196.4.14 GETCONTENTBLOBファンクション

この推奨されないファンクションは、BLOBとして戻されたリソースの内容を取り出します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETCONTENTBLOBファンクション)を使用してください。

構文

DBMS_XDB.GETCONTENTBLOB(
     abspath    IN     VARCHAR2, 
     csid       OUT    PLS_INTEGER,
     locksrc    IN     BOOLEAN := FALSE) 
  RETURN BLOB;

パラメータ

表196-15 GETCONTENTBLOBファンクションのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

csid

TRUEの場合、ソースLOBをロックして戻します。FALSEの場合、一時LOBコピーを戻します。

locksrc

BLOBとしてのリソースの内容。

戻り値

BLOBとしてのリソースの内容。

196.4.15 GETCONTENTCLOBファンクション

この推奨されないファンクションは、CLOBとして戻されたリソースの内容を取得します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETCONTENTCLOBファンクション)を使用してください。

構文

DBMS_XDB.GETCONTENTCLOB(
     abspath    IN     VARCHAR2,
  RETURN CLOB;

パラメータ

表196-16 GETCONTENTCLOBファンクションのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

戻り値

CLOBとしてのリソースの内容。

196.4.16 GETCONTENTVARCHAR2ファンクション

この推奨されないファンクションは、文字列として戻されたリソースの内容を取得します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETCONTENTVARCHAR2ファンクション)を使用してください。

構文

DBMS_XDB.GETCONTENTVARCHAR2(
     abspath    IN     VARCHAR2,
  RETURN BLOB;

パラメータ

表196-17 GETCONTENTVARCHAR2ファンクションのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

戻り値

文字列としてのリソースの内容。

196.4.17 GETCONTENTXMLREFファンクション

この推奨されないファンクションは、XMLTYPEへのREFとして戻されたリソースの内容を取り出します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETCONTENTXMLREFファンクション)を使用してください。

構文

DBMS_XDB.GETCONTENTXMLREF(
     abspath    IN     VARCHAR2,
  RETURN SYS.XMLTYPE;

パラメータ

表196-18 GETCONTENTXMLREFファンクションのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

戻り値

XMLTYPEへのREFとしてのリソースの内容。

196.4.18 GETCONTENTXMLTYPEファンクション

この推奨されないファンクションは、XMLTYPEとして戻されたリソースの内容を取り出します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETCONTENTXMLTYPEファンクション)を使用してください。

構文

DBMS_XDB.GETCONTENTXMLTYPE(
     abspath    IN     VARCHAR2,
  RETURN SYS.XMLTYPE;

パラメータ

表196-19 GETCONTENTXMLTYPEファンクションのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

戻り値

XMLTYPEとしてのリソースの内容。

196.4.19 GETHTTPREQUESTHEADERファンクション

この推奨されないファンクションは、XDBによるHTTPリクエストの処理中にコールされた場合、渡されたヘッダーの値を戻します。これは、カスタム認証を実装するルーチンによって使用されます。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。

構文

DBMS_XDB.GETHTTPREQUESTHEADER(
    header_name    IN   VARCHAR2)
 RETURN VARCHAR2;

パラメータ

表196-20 GETHTTPREQUESTHEADERファンクションのパラメータ

パラメータ 説明

header_name

渡されたヘッダー

戻り値

ヘッダーがリクエストに含まれていない場合、またはセキュリティ上の理由でAUTHENTICATIONを実行する場合は、NULLを戻します。

196.4.20 GETLOCKTOKENプロシージャ

この推奨されないファンクションは、リソースへのパスを指定されると、リソースへのパスを指定して、現行ユーザーのリソースのロック・トークンを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETLOCKTOKENプロシージャ)を使用してください。

構文

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

パラメータ

表196-21 GETLOCKTOKENプロシージャのパラメータ

パラメータ 説明

path

リソースへのパス名。

locktoken

ログインしたユーザーのリソースに対するロック・トークン。

使用上のノート

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

196.4.21 GETPRIVILEGESファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETPRIVILEGESファンクション)を使用してください。

構文

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

パラメータ

表196-22 GETPRIVILEGESファンクションのパラメータ

パラメータ 説明

res_path

リソースの階層内の絶対パス。

戻り値

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

196.4.22 GETRESOIDファンクション

この推奨されないプロシージャは、リソースの絶対パスからオブジェクトIDを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETRESOIDファンクション)を使用してください。

構文

DBMS_XDB.GETRESOID(
   abspath IN VARCHAR2)
RETURN RAW;

パラメータ

表196-23 GETRESOIDファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

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

196.4.23 GETXDB_TABLESPACEファンクション

この推奨されないファンクションは、XDB (ユーザー)の現行の表領域を戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(GETXDB_TABLESPACEファンクション)を使用してください。

構文

DBMS_XDB.GETXDB_TABLESPACE
 RETURN VARCHAR2;

196.4.24 HASBLOBCONTENTファンクション

この推奨されないファンクションは、リソースにBLOBコンテンツがある場合はTRUEを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(HASBLOBCONTENTファンクション)を使用してください。

構文

DBMS_XDB.HASBLOBCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-24 HASBLOBCONTENTファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

リソースにBOBコンテンツがある場合はTRUE。

196.4.25 HASCHARCONTENTファンクション

この推奨されないファンクションは、リソースに文字コンテンツがある場合はTRUEを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(HASCHARCONTENTファンクション)を使用してください。

構文

DBMS_XDB.HASCHARCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-25 HASCHARCONTENTファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

リソースに文字コンテンツがある場合はTRUE。

196.4.26 HASXMLCONTENTファンクション

この推奨されないファンクションは、リソースにXMLコンテンツがある場合はTRUEを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(HASXMLCONTENTファンクション)を使用してください。

構文

DBMS_XDB.HASXMLCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-26 HASXMLCONTENTファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

リソースにXMLコンテンツがある場合はTRUE。

196.4.27 HASXMLREFERENCEファンクション

この推奨されないファンクションは、リソースにXMLコンテンツに対するREFがある場合はTRUEを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(HASXMLREFERENCEファンクション)を使用してください。

構文

DBMS_XDB.HASXMLREFERENCE 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-27 HASXMLREFERENCEファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

リソースにXMLコンテンツへのREFがある場合はTRUE。

196.4.28 ISFOLDERファンクション

この推奨されないファンクションは、リソースがフォルダまたはコンテナの場合はTRUEを戻します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(ISFOLDERファンクション)を使用してください。

構文

DBMS_XDB.ISFOLDER 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表196-28 DBMS_XDB.ISFOLDERファンクションのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

戻り値

リソースがフォルダまたはコンテナの場合はTRUE。

196.4.29 LINKプロシージャ

この推奨されないプロシージャは、指定したフォルダから指定したリソースへのリンクを作成します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(LINKプロシージャ)を使用してください。

構文

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

DBMS_XDB.LINK(
   srcpath      IN   VARCHAR2,
   linkfolder   IN   VARCHAR2,
   linkname     IN   VARCHAR2,
   linktype     IN   PLS_INTEGER := DBMS_XDB.LINK_TYPE_HARD);

パラメータ

表196-29 LINKプロシージャのパラメータ

パラメータ 説明

srcpath

リンクを作成するリソースのパス名。

linkfolder

新規リンクを格納するフォルダ。

linkname

新規リンクの名前。

linktype

作成するリンクのタイプ。

  • DBMS_XDB.LINK_TYPE_HARD(デフォルト)

  • DBMS_XDB.LINK_TYPE_WEAK

  • DBMS_XDB.LINK_TYPE_SYMBOLIC

196.4.30 LOCKRESOURCEファンクション

この推奨されないファンクションは、リソースへのパスを指定されると、リソースに対するWebDAVスタイルのロックを取得します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(LOCKRESOURCEファンクション)を使用してください。

構文

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

パラメータ

表196-30 LOCKRESOURCEファンクションのパラメータ

パラメータ 説明

path

ロックするリソースのパス名。

depthzero

現在サポートされていません。

shared

TRUEを設定すると、共有書込みロックを取得します。

戻り値

成功した場合はTRUE。

使用上のノート

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

196.4.31 PROCESSLINKSプロシージャ

この推奨されないプロシージャは、指定したリソース内のドキュメント・リンクを処理します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(PROCESSLINKSプロシージャ)を使用してください。

構文

DBMS_XDB.PURGERESOURCEMETADATA( 
 abspath  IN  VARCHAR2,
 recurse  IN  BOOLEAN := FALSE);

パラメータ

表196-31 PROCESSLINKSプロシージャのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。パスがフォルダの場合は、recurseフラグを使用します。

recurse

abspathがフォルダを指定する場合にのみ使用します。TRUEの場合、指定したリソースをルートとするフォルダ階層内のすべてのリソースのリンクを処理します。FALSEの場合、このフォルダ内のみのすべてのドキュメントのリンクを処理します。

196.4.32 PURGERESOURCEMETADATAプロシージャ

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(PURGERESOURCEMETADATAプロシージャ)を使用してください。

構文

DBMS_XDB.PURGERESOURCEMETADATA(  
 abspath  IN  VARCHAR2);

パラメータ

表196-32 PURGERESOURCEMETADATAプロシージャのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

196.4.33 RENAMERESOURCEプロシージャ

この推奨されないプロシージャは、XDBリソースの名前を変更します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(RENAMERESOURCEプロシージャ)を使用してください。

構文

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

パラメータ

表196-33 RENAMERESOURCEプロシージャのパラメータ

パラメータ 説明

srcpath

ソース・リソース宛先フォルダの階層内の絶対パス。

destfolder

宛先フォルダの階層内の絶対パス。

newname

宛先フォルダ内の子の名前。

196.4.34 SETACLプロシージャ

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(SETACLプロシージャ)を使用してください。

構文

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

パラメータ

表196-34 SETACLプロシージャのパラメータ

パラメータ 説明

res_path

リソースの階層内の絶対パス。

acl_path

ACLの階層内の絶対パス。

使用上のノート

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

196.4.35 SPLITPATHプロシージャ

この推奨されないプロシージャは、パスを親のパスと子のパスに分割します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(SPLITPATHプロシージャ)を使用してください。

構文

DBMS_XDB.SPLITPATH(
      abspath     IN  VARCHAR2,
      parentpath  OUT VARCHAR2,
     childpath    OUT VARCHAR2);

パラメータ

表196-35 SPLITPATHプロシージャのパラメータ

パラメータ 説明

abspath

分割する絶対パス。

parentpath

親のパス。

childpath

子のパス。

196.4.36 TOUCHRESOURCEプロシージャ

この推奨されないプロシージャは、リソースの変更時間を現在の時間に変更します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(TOUCHRESOURCEプロシージャ)を使用してください。

構文

DBMS_XDB.TOUCHRESOURCE 
     abspath    IN     VARCHAR2);

パラメータ

表196-36 DBMS_XDB.TOUCHRESOURCEプロシージャのパラメータ

パラメータ 説明

abspath_path

リソースの絶対パス。

196.4.37 UNLOCKRESOURCEファンクション

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

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(UNLOCKRESOURCEファンクション)を使用してください。

構文

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

パラメータ

表196-37 UNLOCKRESOURCEファンクションのパラメータ

パラメータ 説明

path

リソースへのパス名。

deltoken

削除するロック・トークン。

戻り値

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

使用上のノート

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

196.4.38 UPDATERESOURCEMETADATAプロシージャ

この推奨されないプロシージャは、リソースのメタデータを更新します。

ノート:

リリース12cでは、このプロシージャの使用は推奨されていません。この機能のかわりに、 DBMS_XDB_REPOS パッケージの同じ名前のサブプログラム(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);

パラメータ

表196-38 UPDATERESOURCEMETADATAプロシージャのパラメータ

パラメータ 説明

abspath

リソースの絶対パス。

oldmetadata

古いメタデータへのREF。

newmetadata

新しい置換メタデータへのREF(オーバーロードに応じてスキーマ・ベースまたは非スキーマ・ベースのメタデータを使用できます)。

oldns

古いメタデータを識別するネームスペース。

oldname

古いメタデータを識別するローカル名。

使用上のノート

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