11 ORDS_EXPORT_ADMIN PL/SQLパッケージのリファレンス

この項では、ORDS_EXPORT_ADMINパッケージを使用して、ユーザーがスキーマ内のREST対応オブジェクトをエクスポートする方法について説明します。

ORDS_EXPORT_ADMINパッケージを使用すると、ユーザーは、ORDS_ADMINISTRATOR_ROLEロールを持つスキーマ内のREST対応オブジェクトをエクスポートできます。管理者は、指定されたスキーマ名と追加パラメータを使用して、特定のREST関連アーティファクトを選択的にエクスポートできます。この機能は、必要なオブジェクトのみが含まれるようにするため、RESTサービスのドキュメント化および移行に特に役立ちます。

次の項では、エクスポート・プロセスをきめ細かく制御し、様々な管理ニーズに対応するためにパラメータがどのように使用されるかについて説明します。

• ords_export_admin.export_schema
  

11.1 ords_export_admin.export_schema

形式

FUNCTION ords_export_admin.export_schema(
  p_schema                  IN VARCHAR2,
  p_include_modules         IN BOOLEAN DEFAULT TRUE,
  p_include_privileges      IN BOOLEAN DEFAULT TRUE,
  p_include_roles           IN BOOLEAN DEFAULT TRUE,
  p_include_oauth           IN BOOLEAN DEFAULT TRUE,
  p_include_rest_objects    IN BOOLEAN DEFAULT TRUE,
  p_include_jwt_profiles    IN BOOLEAN DEFAULT TRUE,
  p_include_enable_schema   IN BOOLEAN DEFAULT TRUE,
  p_export_date             IN BOOLEAN DEFAULT TRUE,
  p_runnable_as_admin       IN BOOLEAN DEFAULT TRUE
)
RETURN CLOB;

説明

ords_export_admin.export_schemaファンクションは、以前にREST対応であったスキーマをエクスポートする場合にのみ有効です。

表11-1 パラメータ

パラメータ	説明
p_schema	エクスポートするREST対応スキーマの名前を指定します。
p_include_modules	modules/templates/handlers/parametersコールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_include_privileges	すべての権限コールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
P_include_roles	すべてのロール・コールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_include_oauth	すべてのOauthクライアント・コールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_include_rest_object	すべてのRESTオブジェクト・コールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_include_jwt_profiles	JWTプロファイル・コールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_include_enable_schema	ORDS.ENABLE_SCHEMAコールをエクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_export_date	エクスポートが行われる日付をヘッダー・エクスポートに含めるかどうかを指定します。コールを含めるには値をTRUEに設定し、それ以外の場合は値をFALSEに設定します。
p_runnable_as_admin	エクスポートされたスクリプトでパブリック・パッケージまたは管理パッケージを使用するかどうかを指定します。エクスポートされたスクリプトが別のスキーマをターゲットとする管理者ユーザーとして実行されるように計画されている場合は、値をTRUEに設定します。それ以外の場合、現在のユーザーがターゲット・スキーマである場合は、値をFALSEに設定します。

例

例11-1 デフォルトを使用したエクスポート

次に、すべてのブール・パラメータがデフォルトとしてTRUEに設定されているスキーマをエクスポートする例を示します。エクスポートされたスクリプトには、すべてのオブジェクトが含まれます。

DECLARE
  v_exported_script CLOB;
BEGIN
  v_exported_script := ORDS_EXPORT_ADMIN.EXPORT_SCHEMA(
    P_SCHEMA => 'TEST_SCHEMA'
  );
END;

例11-2 パラメータを使用したエクスポート

次の例では、すべてのオプション・パラメータを使用して次を示します。

• エクスポート・スクリプトにJWTプロファイルを含めない
• 出力スクリプトにエクスポートされた日付がない(差異の実行に役立ちます)

DECLARE
  v_exported_script CLOB;
BEGIN
  v_exported_script := ORDS_EXPORT_ADMIN.EXPORT_SCHEMA(
    P_SCHEMA => 'TEST_SCHEMA',
    P_INCLUDE_MODULES => TRUE,
    P_INCLUDE_PRIVILEGES => TRUE,
    P_INCLUDE_ROLES => TRUE,
    P_INCLUDE_OAUTH => TRUE,
    P_INCLUDE_REST_OBJECTS => TRUE,
    P_INCLUDE_JWT_PROFILES => FALSE,
    P_INCLUDE_ENABLE_SCHEMA => TRUE,
    P_EXPORT_DATE => FALSE,
    P_RUNNABLE_AS_ADMIN => TRUE
  );
END;