OWA_CACHE

223 OWA_CACHE

OWA_CACHEパッケージは、PL/SQL GatewayキャッシュでPL/SQL Webアプリケーションの性能を向上できるようにするためのインタフェースを提供します。

参照:

このパッケージの実装の詳細は、次のマニュアルを参照してください。

この章の内容は次のとおりです。

223.1 OWA_CACHEの定数

OWA_CACHEは、パラメータ値の指定時に使用するいくつかの定数を定義します。

system_level CONSTANT VARCHAR(6) := 'SYSTEM';
user_level CONSTANT VARCHAR(4) := 'USER';

223.2 OWA_CACHEサブプログラムの要約

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

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

サブプログラム	説明
DISABLEプロシージャ	指定した特定の要求に対するキャッシュを使用禁止にします。
GET_ETAGファンクション	キャッシュされた内容に関連するタグを戻します(検証テクニック・モデルのみで使用)。
GET_LEVELファンクション	キャッシュ・レベルを戻します(検証テクニック・モデルのみで使用)。
SET_CACHEプロシージャ	検証モデル・キャッシュ・タイプのキャッシュ・ヘッダーを設定します。
SET_EXPIRESプロシージャ	期限切れモデル・キャッシュ・タイプのキャッシュ・ヘッダーを設定します。
SET_NOT_MODIFIEDプロシージャ	変更なしキャッシュ・ヒットのヘッダーを設定します(検証テクニック・モデルのみで使用)。
SET_SURROGATE_CONTROLプロシージャ	Webキャッシュのサロゲート制御ヘッダーに使用するヘッダーを設定します。

223.2.1 DISABLEプロシージャ

このプロシージャは、指定した特定の要求に対するキャッシュを使用禁止にします。

構文

OWA_CACHE.DISABLE;

223.2.2 GET_ETAGファンクション

キャッシュされた内容に関連するタグを戻します。検証方式でのみ使用します。

構文

OWA_CACHE.GET_ETAG
  RETURN VARCHAR2;

戻り値

キャッシュ・ヒットのタグ。それ以外はNULLが戻されます。

223.2.3 GET_LEVELファンクション

キャッシュ・レベルを返します。検証方式モデルでのみ使用します。

構文

OWA_CACHE.GET_LEVEL
  RETURN VARCHAR2;

戻り値

キャッシュ・ヒットのキャッシュ・レベル文字列('USER'または'SYSTEM')。それ以外はNULLが戻されます。

223.2.4 SET_CACHEプロシージャ

この-実行は、検証モデル・キャッシュ・タイプのキャッシュ・ヘッダーを設定します。

構文

OWA_CACHE.SET_CACHE(
   p_etag        IN       VARCHAR2,
   p_level       IN       VARCHAR2);

パラメータ

表223-2 SET_CACHEプロシージャのパラメータ

パラメータ	説明
`p_etag`	指定した内容に関連する`etag`。
`p_level`	キャッシュ・レベル('`USER'`または'`SYSTEM'`)。

例外

次の場合はVALUE_ERRORがスローされます。

p_etagが55より大きい場合
p_levelが'USER'または'SYSTEM'ではない場合

223.2.5 SET_EXPIRESプロシージャ

このプロシージャは、期限切れモデル・キャッシュ・タイプのキャッシュ・ヘッダーを設定します。

構文

OWA_CACHE.SET_EXPIRES(
   p_expires      IN       NUMBER,
   p_level        IN       VARCHAR2);

パラメータ

表223-3 SET_EXPIRESプロシージャのパラメータ

パラメータ	説明
`p_expires`	指定した内容の有効期間(分)。
`p_level`	キャッシュ・レベル('`USER'`または'`SYSTEM'`)。

例外

次の場合はVALUE_ERRORがスローされます。

p_expiresが負の値または0の場合
p_levelが'USER'または'SYSTEM'ではない場合
p_expiresが525600(1年)より大きい場合

223.2.6 SET_NOT_MODIFIEDプロシージャ

変更なしキャッシュ・ヒットのヘッダーを設定します。検証方式でのみ使用します。

構文

OWA_CACHE.SET_NOT_MODIFIED;

例外

etagが渡されていない場合は、VALUE_ERRORがスローされます。

223.2.7 SET_SURROGATE_CONTROLプロシージャ

このプロシージャは、Webキャッシュのサロゲート制御ヘッダーに使用するヘッダーを設定します。

構文

OWA_CACHE.SET_SURROGATE_CONTROL(
   p_value        IN       VARCHAR2);

パラメータ

表223-4 SET_SURROGATE_CONTROLプロシージャのパラメータ

パラメータ	説明
`p_value`	サロゲート制御ヘッダーとして渡される値。

例外

p_valueの長さが55よりも長い場合は、VALUE_ERRORがスローされます。