DBMS_DATAMART 套裝程式參照

本節提供與 Data Studio 中 Data Marketplace 工具搭配使用的套裝程式相關資訊。DBMS_DATAMART 主題也涵蓋 DBMS_DATAMART 套裝程式中包含的程序。DBMS_DATAMART 套裝程式提供 API，以支援 Data Marketplace 的一般作業。

主題：

DBMS_DATAMART 程序

DBMS_DATAMART 子程式摘要
您可以使用 Oracle Data Marketplace API 來註冊及存取資料集。

父項主題： Data Marketplace 工具

DBMS_DATAMART 子程式摘要

您可以使用 Oracle Data Marketplace API 來註冊和存取資料集。

DBMS_DATAMART 套裝程式子程式

DBMS_DATAMART 套裝程式可簡化 Oracle Data Marketplace 的一般作業，例如註冊物件、要求存取權、授予存取權、撤銷存取權、取消註冊及列出資料集。

下表列出 DBMS_DATAMART 子程式並簡短說明它們。

子程式	描述
註冊物件	此程序會註冊資料集。
請求存取	此程序要求存取特定資料集。
grant_access	此程序會授予特定資料集的存取權。
revoke_access	此程序會撤銷對特定資料集的存取權。
取消登記	此程序會取消註冊資料集。
清單資料集	此程序會傳回資料集清單。
取得庫存影像 URL	此程序會傳回可供您選取影像的 URL 基本資料。
取得保留名稱空間	此程序顯示系統保留且無法供您使用之命名空間的 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 程序，請使用下列參數。

Parameter - 參數	描述
`schema_name`	綱要的名稱。
`object_name`	物件名稱。
`namespace`	物件的命名空間。
`data_set_name`	資料集名稱。
`scope`	此參數指示誰可以遠端存取資料。範圍可設為各種層次，包括資料庫所在的區域、個別租用戶或區間。不支援 `MY$REGION`。
`thumbnail`	工具顯示在資料集封面上的影像。您無法使用此參數。
`thumbnail_url`	您無法指定自己的 `thumbnail_url`。Oracle 提供此參數。
`thumbnail_mime_type`	它會指定縮圖的「多用途網際網路郵件延伸模組 (MIME)」類型。
`Parameters`	它會指定 JSON 參數，例如 `tags`、`description`、`data_set_owner`、`authorization_required`、`offload_targets`、`offload_targets` 和 `store_sample`。

要求存取程序

此程序會要求存取指定的資料集。

語法

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

要求存取參數

如果您正在存取 Request Access 程序，請使用下列參數。

Parameter - 參數	描述
`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 套裝程式參照