DBMS_DATAMART 程序包参考

本节提供有关与 Data Studio 中的 Data Marketplace 工具一起使用的软件包的信息。DBMS_DATAMART 主题还介绍了 DBMS_DATAMART 软件包中包含的过程。DBMS_DATAMART 程序包提供了 API 来支持与数据市场的常见操作。

DBMS_DATAMART 子程序概要

您可以使用 Oracle 数据市场 API 注册和访问数据集。

DBMS_DATAMART 程序包子程序

DBMS_DATAMART 程序包简化了 Oracle 数据市场的常见操作,例如注册对象、请求访问权限、授予访问权限、撤消访问权限、取消注册和列出数据集。

下表列出了 DBMS_DATAMART 子程序并简要介绍了这些子程序。

子程序 说明
注册对象

此过程注册数据集。

request_access

此过程请求访问特定数据集。

grant_access

此过程授予对特定数据集的访问权限。

revoke_access

此过程将撤消对特定数据集的访问权限。

撤消注册

此过程将取消注册数据集。

list_data_set

此过程返回数据集列表。

获取库存图片 _urls

此过程返回可从中选择图像的 URL 基础。

get_reserved_namespace

此过程显示由系统保留且您无法使用的名称空间的 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

它指定多用途 Internet 邮件扩展 (Multipurpose Internet Mail Extensions,MIME) 缩略图类型。

Parameters

它指定 JSON 参数,例如 tagsdescriptiondata_set_ownerauthorization_requiredoffload_targetsoffload_targetsstore_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;

如果 registrationstrue,则返回您注册的数据集列表。如果为 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);

上面已经介绍了此过程的参数。