DBMS_DATAMARTパッケージ参照

この章では、Data Studioのデータ・マーケットプレイス・ツールで使用するパッケージについて説明します。DBMS_DATAMARTのトピックでは、DBMS_DATAMARTパッケージに含まれるプロシージャについても説明します。DBMS_DATAMARTパッケージは、Data Marketplaceでの一般的な操作をサポートするAPIを提供します。

DBMS_DATAMARTサブプログラムの要約
Oracle Data Marketplace APIを使用して、データセットを登録およびアクセスできます。

親トピック: データ・マーケットプレイス・ツール

DBMS_DATAMARTサブプログラムの概要

Oracle Data Marketplace APIを使用して、データセットを登録およびアクセスできます。

DBMS_DATAMARTパッケージ・サブプログラム

DBMS_DATAMARTパッケージは、オブジェクトの登録、アクセスのリクエスト、アクセス権の付与、アクセスの取消し、データの登録解除およびリストなど、Oracle Data Marketplaceでの一般的な操作を簡略化します。

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

サブプログラム	説明
register_object	この手順では、データセットを登録します。
request_access	このプロシージャは、特定のデータセットへのアクセスをリクエストします。
grant_access	このプロシージャは、特定のデータセットへのアクセス権を付与します。
revoke_access	このプロシージャは、特定のデータセットへのアクセスを取り消します。
登録解除	このプロシージャは、データセットを登録解除します。
list_data_sets	このプロシージャは、データセットのリストを返します。
get_stock_image_urls	このプロシージャは、イメージを選択できるURLベースを返します。
get_reserved_namespaces	このプロシージャは、システムによって予約され、ユーザーが使用できないネームスペースのJSON配列を表示します。
update_registration	この手順では、既存の登録を更新します。

オブジェクトの登録プロシージャ

この手順では、データセットを登録します。

構文

procedure register_object(schema_name         in varchar2,
                          object_name         in varchar2,
                          namespace           in varchar2,
                          data_set_name       in varchar2,
                          scope               in clob default null,
                          thumbnail           in blob default null,
                          thumbnail_url       in varchar2 default null,
                          thumbnail_mime_type in varchar2 default null,
                          parameters          in clob default null);

オブジェクト・パラメータの登録

Register Objectプロシージャにアクセスする場合は、次のパラメータを使用します。

パラメータ	説明
`schema_name`	このスキーマの名前。
`object_name`	オブジェクトの名前。
`namespace`	オブジェクトのネームスペース。
`data_set_name`	データセットの名前。
`scope`	このパラメータは、データにリモートでアクセスできます。有効範囲は、データベースが存在するリージョン、個々のテナンシ、コンパートメントなどの様々なレベルに設定できます。`MY$REGION`はサポートされていません。
`thumbnail`	ツールがデータセットのカバーに表示されるイメージ。このパラメータは使用できません。
`thumbnail_url`	独自の`thumbnail_url`は指定できません。Oracleには、このパラメータが用意されています。
`thumbnail_mime_type`	多目的インターネット・メール拡張(MIME)タイプのサムネイルを指定します。
`Parameters`	`tags`、`description`、`data_set_owner`、`authorization_required`、`offload_targets`、`offload_targets`、`store_sample`などのJSONパラメータを指定します。

要求アクセス手順

このプロシージャは、指定されたデータセットへのアクセスをリクエストします。

構文

procedure request_access(namespace     in  varchar2,
                         data_set_name in  varchar2,
                         auth_info     out clob);

リクエスト・アクセス・パラメータ

Request Accessプロシージャにアクセスする場合は、次のパラメータを使用します。

パラメータ	説明
`Namespace`	オブジェクトのネームスペース。
`Dataset name`	データセットの名前。
`Auth Info`	このパラメータは、戻り時にJSONとして生成されます。データセット・プロバイダが電子メール・アドレスを提供し、リクエスト元のユーザーがData Studio SMTP設定を設定している場合、リクエストは電子メールで送信され、このパラメータは`delivery`フィールドをSMTPに設定して生成されます。そうしないと、`delivery`フィールドが`browser`に設定され、残りのメタデータを使用して、電子メールを介して独自のリクエストを送信する必要があります。

付与アクセス・プロシージャ

このプロシージャは、指定されたデータセットへのアクセス権を付与します。認証情報パラメータには、共有IDが含まれている必要があります。

構文

procedure grant_access(namespace     in varchar2,
                       data_set_name in varchar2,
                       auth_info     in clob);

アクセスの取消しプロシージャ

このプロシージャは、指定されたデータセットへのアクセスを取り消します。認証情報パラメータには、共有IDが含まれている必要があります。

構文

procedure revoke_access(namespace     in varchar2,
                        data_set_name in varchar2,
                        auth_info     in clob);

プロシージャの登録解除

このプロシージャは、指定されたデータセットへのアクセスを取り消します。認証情報パラメータには、共有IDが含まれている必要があります。

構文

procedure unregister(namespace     in varchar2,
                     data_set_name in varchar2);

データセットのリスト・プロシージャ

このプロシージャは、データセットのリストを表示します。

構文

function list_data_sets(registrations in boolean default false)
  return clob;

registrationsがtrueの場合、リピーターするデータセットのリストが返されます。falseの場合、使用可能なデータ・セットを返します。

ストック・イメージURLの取得手順

このプロシージャは、イメージを選択できるURLを表示します。

構文

function get_stock_image_url return varchar2;

予約済ネームスペースの取得プロシージャ

このプロシージャは、システムによって予約されているネームスペースのJSON配列を表示します。これらのネームスペースは使用できません。

構文

function get_reserved_namespaces return clob;

登録プロシージャの更新

この手順では、既存の登録を更新します。

構文

procedure update_registration(namespace           in varchar2,
                              data_set_name       in varchar,
                              scope               in clob default null,
                              thumbnail           in blob default null,
                              thumbnail_url       in varchar2 default null,
                              thumbnail_mime_type in varchar2 default null,
                              parameters          in clob default null);

この手順のパラメータについては、すでに前述しています。

親トピック: DBMS_DATAMARTパッケージ参照

Oracle Cloud Infrastructureドキュメント

DBMS_DATAMARTサブプログラムの概要