7 Oracle REST Data Services管理PL/SQLパッケージのリファレンス

Oracle REST Data Services(ORDS) ADMIN PL/SQLパッケージには、Oracle REST Data Servicesを使用してRESTfulサービスを開発および管理するための特権ユーザー用サブプログラム(プロシージャおよびファンクション)が含まれています。

ORDS_ADMINパッケージの実行権限を持つユーザーは、管理者であるとみなされます。この用途として、事前定義済データベース・ロールORDS_ADMINISTRATOR_ROLEが提供されています。

ORDS_ADMINパッケージはAUTHID CURRENT_USER権限を除いてORDSパッケージと同等であり、非推奨メソッドがなく、どのメソッドにもp_schemaパラメータ(ターゲット・スキーマの指定が必要)がありません。

7.1 RESTfulサービスの開発および管理のためのサブプログラムの例

この項では、ORDSを使用したRESTfulサービスの開発および管理に使用するサブプログラムの例を示します。

サブプログラムの例を次に示します。

例7-1 ORDS_ADMIN.CREATE_ROLE

形式

ORDS_ADMIN.CREATE_ROLE(
   p_schema    IN ords_schemas.parsing_schema%type,
   p_role_name IN sec_roles.name%type);

次の例では、ロールを作成します。

ORDS_ADMIN.CREATE_ROLE(
   p_schema    IN ords_schemas.parsing_schema%type,
   p_role_name IN sec_roles.name%type);

BEGIN
  ORDS_ADMIN.CREATE_ROLE(
    p_schema => 'tickets',
    p_role_name => 'Tickets User');
  };
END;
/

例7-2 ORDS_ADMIN.DEFINE_PARAMETER

形式

ORDS_ADMIN.DEFINE_PARAMETER(
   p_schema             IN ords_schemas.parsing_schema%type,
   p_module_name        IN ords_modules.name%type,
   p_pattern            IN ords_templates.uri_template%type,
   p_method             IN ords_handlers.method%type,
   p_name               IN ords_parameters.name%type ,
   p_bind_variable_name IN ords_parameters.bind_variable_name%type 
                              DEFAULT NULL,
   p_source_type        IN ords_parameters.source_type%type DEFAULT 'HEADER',
   p_param_type         IN ords_parameters.param_type%type DEFAULT 'STRING',
   p_access_method      IN ords_parameters.access_method%type DEFAULT 'IN',
   p_comments           IN ords_parameters.comments%type DEFAULT NULL);

次の例では、作成されたチケットの場所を格納するPOSTハンドラのアウトバウンド・パラメータを定義します。

BEGIN
  ORDS_ADMIN.DEFINE_PARAMETER(
    p_schema => 'tickets',
    p_module_name => 'my.tickets',
    p_pattern => '.',
    p_method => 'POST',
    p_name => 'X-APEX-FORWARD',
    p_bind_variable_name => 'location',
    p_source_type => 'HEADER',
    p_access_method => 'OUT'
  );
END;
/

表7-1 p-schemaパラメータの説明

パラメータ 説明
p_schema スキーマの名前を指定します。このパラメータは必須です。