DBMS_DATAMARTパッケージ・リファレンス
この項では、Data Studioのデータ・マーケットプレイス・ツールで使用されるパッケージについて説明します。DBMS_DATAMART
トピックでは、DBMS_DATAMART
パッケージに含まれるプロシージャについても説明します。DBMS_DATAMART
パッケージは、データ・マーケットプレイスとの共通操作をサポートする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
プロシージャにアクセスする場合は、次のパラメータを使用します。
パラメータ | 摘要 |
---|---|
|
このスキーマの名前。 |
|
オブジェクトの名前。 |
|
オブジェクトのネームスペース。 |
|
データセットの名前。 |
|
このパラメータは、データにリモートでアクセスできるユーザーを示します。スコープは、データベースが存在するリージョン、個々のテナンシ、コンパートメントなど、様々なレベルに設定できます。 |
|
ツールがデータセットのカバーに表示するイメージ。このパラメータを使用することはできません。 |
|
独自の |
|
マルチパーパス・インターネット・メール拡張(MIME)タイプのサムネイルを指定します。 |
|
|
アクセス・プロシージャの要求
このプロシージャは、指定されたデータセットへのアクセスをリクエストします。
構文
procedure request_access(namespace in varchar2,
data_set_name in varchar2,
auth_info out clob);
アクセス・パラメータのリクエスト
Request Access
プロシージャにアクセスする場合は、次のパラメータを使用します。
パラメータ | 摘要 |
---|---|
|
オブジェクトのネームスペース。 |
|
データセットの名前。 |
|
このパラメータは、戻り時にJSONとして移入されます。データセット・プロバイダが電子メール・アドレスを指定し、リクエスト元のユーザーがData Studio SMTP設定を設定している場合、リクエストは電子メールで送信され、このパラメータは |
アクセス許可プロシージャ
このプロシージャは、指定されたデータセットへのアクセス権を付与します。認証情報パラメータには共有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パッケージ・リファレンス