Documentación de Oracle Cloud Infrastructure

Resumen de DBMS_CATALOG

En esta sección se tratan los subprogramas DBMS_CATALOG que se proporcionan con Autonomous AI Database.

Montaje y desmontaje del catálogo

Subprograma Descripción

mount_db_link

Este procedimiento monta un catálogo basado en un enlace de base de datos.

mount_shares

Este procedimiento monta varios catálogos de un proveedor de recursos compartidos, con sobrecargas para admitir diferentes tipos de entrada.

mount_share

Este procedimiento monta un único catálogo basado en un recurso compartido.

mount_virtual_catalog

Este procedimiento crea y monta un nuevo catálogo virtual.

mount_data_catalog

Este procedimiento monta un catálogo de datos como AWS GLUE o OCI Data Catalog.

mount_iceberg

Este procedimiento monta un catálogo de Iceberg con configuraciones específicas.

desmontar

Este procedimiento desmonta un catálogo externo existente.

Gestión de propiedades de catálogo

Subprograma Descripción

get_catalog_property y get_catalog_property_clob

Estos procedimientos recuperan los valores de propiedad de un catálogo.

update_catalog_property y update_catalog_property_clob

Estos procedimientos actualizan los valores de propiedad de un catálogo.

get_schema_property y get_schema_property_clob

Estos procedimientos recuperan los valores de propiedad del esquema.

update_schema_property y update_schema_property_clob

Estos procedimientos actualizan los valores de propiedad del esquema.

get_table_property y get_table_property_clob

Estos procedimientos recuperan los valores de las propiedades de la tabla.

update_table_property y update_table_property_clob

Estos procedimientos actualizan los valores de las propiedades de la tabla.

Gestión de Credenciales

Subprograma Descripción

add_required_credential

Este procedimiento define una credencial necesaria para un catálogo.

remove_required_credential

Este procedimiento elimina una credencial necesaria de un catálogo.

rename_required_credential

Este procedimiento cambia el nombre de una credencial necesaria.

update_required_credential_property

Este procedimiento actualiza una propiedad de una credencial necesaria.

get_required_credential_property

Este procedimiento recupera una propiedad de una credencial necesaria.

set_local_credential

Este procedimiento especifica una credencial local para una credencial necesaria.
get_local_credential_map Este procedimiento recupera las asignaciones entre las credenciales necesarias y las credenciales locales, con sobrecargas para varios formatos de salida.

Gestión de entidades de catálogo

Subprograma Descripción

create_cloud_storage_link y drop_cloud_storage_link

Este procedimiento gestiona los enlaces de almacenamiento en la nube dentro de un catálogo.

create_external_table

Este procedimiento crea una tabla externa en un catálogo.

drop_schema y drop_table

Este procedimiento elimina los esquemas y las tablas de un catálogo.

get_tables, get_schemas y get_objects

Este procedimiento recupera metadatos para tablas, esquemas y objetos de un catálogo mediante funciones con líneas de pipeline.

Acceso y almacenamiento en caché de datos

Subprograma Descripción

generate_table_select

Este procedimiento crea una sentencia SELECT para una tabla lógica, con sobrecargas para el procedimiento y la función.

open_table_cursor

Este procedimiento abre un cursor para devolver datos de una tabla lógica.

flush_catalog_cache y prefill_catalog_cache

Este procedimiento gestiona el almacenamiento en caché de metadatos del catálogo.

Sincronización y uso compartido

Subprograma Descripción

create_synchronized_schemas y drop_synchronized_schemas

Este procedimiento gestiona esquemas sincronizados con definiciones de catálogo remotas.

update_synchronized_schema_property

Este procedimiento actualiza las propiedades de los esquemas sincronizados.

grant_to_recipient y revoke_from_recipient

Este procedimiento gestiona los permisos de acceso para los destinatarios del catálogo.

Tema principal: Gestión de catálogos con DBMS_CATALOG

MOUNT_DB_LINK Procedimiento

Este procedimiento monta un catálogo externo basado en un enlace de base de datos.

Sintaxis

PROCEDURE mount_db_link
(
  catalog_name 	IN VARCHAR2,
  db_link 		IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del nuevo catálogo. Se convertirá a mayúsculas.

db_link

Enlace de base de datos que se va a utilizar para montar el catálogo.

enabled

Indica si el catálogo está activado para la búsqueda. El valor por defecto es TRUE.

Tema principal: Resumen de DBMS_CATALOG

MOUNT_SHARES Procedimiento

Este procedimiento monta varios catálogos según los recursos compartidos de un proveedor de recursos compartidos.

Sintaxis

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  created_catalogs 		IN OUT NOCOPY SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

Parámetros

Parámetro Descripción

share_provider:

El nombre del proveedor de recursos compartidos.

shares

Matriz JSON que define la lista de recursos compartidos que se deben montar. Cada elemento especifica propiedades como shareName, required, shareNameRule, catalogName, skipExisting, placeholder y enabled.

created_catalogs

Matriz JSON de catálogos recién creados, devuelta como salida con propiedades como shareName y catalogName.

share_provider_owner

Propietario del proveedor de recursos compartidos. El valor por defecto es el catálogo actual si es NULL.

Sintaxis del segundo procedimiento

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

Sintaxis del tercer procedimiento

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN CLOB := '[{shareName:"%"}]',
  share_provider_owner 	IN VARCHAR2 := NULL
);

Parámetros del segundo procedimiento

Los parámetros son idénticos al procedimiento 1, excepto que no tienen created_catalogs.

Parámetros del tercer procedimiento

Los parámetros son idénticos a la firma 1, excepto que los recursos compartidos son CLOB con un valor predeterminado que incluye todos los recursos compartidos.

Ejemplo

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount shares as catalogs
  dbms_catalog.mount_shares(
    share_provider       => 'MY_SHARE_PROVIDER');
END;
/

Tema principal: Resumen de DBMS_CATALOG

MOUNT_SHARE Procedimiento

Este procedimiento monta un catálogo basado en un único recurso compartido.

Sintaxis

PROCEDURE mount_share
(
  catalog_name 				IN VARCHAR2,
  share_provider 			IN VARCHAR2,
  share_name 				IN VARCHAR2,
  share_provider_owner 		IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del nuevo catálogo. Se convertirá a mayúsculas.

share_provider

El nombre del proveedor de recursos compartidos.

share_name

Nombre del recurso compartido que se montará.

share_provider_owner

Propietario del proveedor de recursos compartidos. El valor por defecto es el catálogo actual si es NULL.
enabled

Indica si el catálogo está activado para la búsqueda. El valor predeterminado es TRUE.

Ejemplo

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount a share catalog
  dbms_catalog.mount_share(
    catalog_name         => 'SHARE_CAT',
    share_provider       => 'MY_SHARE_PROVIDER',
    share_name           => 'MY_SHARE_1');
END;
/

Tema principal: Resumen de DBMS_CATALOG

MOUNT_VIRTUAL_CATALOG Procedimiento

Este procedimiento crea y monta un nuevo catálogo virtual.

Sintaxis

PROCEDURE mount_virtual_catalog
(
  catalog_name 	IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del nuevo catálogo. Se convertirá a mayúsculas.

enabled

Indica si el catálogo está activado para la búsqueda. El valor predeterminado es TRUE.

Tema principal: Resumen de DBMS_CATALOG

MOUNT_DATA_CATALOG Procedimiento

Este procedimiento monta un catálogo de datos (por ejemplo, AWS GLUE o OCI Data Catalog).

Sintaxis

PROCEDURE mount_data_catalog
(
  catalog_name 				IN VARCHAR2,
  data_catalog_type 		IN VARCHAR2,
  data_catalog_region 		IN VARCHAR2,
  data_catalog_credential 	IN VARCHAR2,
  data_catalog_id 			IN VARCHAR2 := NULL,
  data_storage_credential 	IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del nuevo catálogo. Se convertirá a mayúsculas.

data_catalog_type

Tipo de catálogo de datos (por ejemplo, OCI_DCAT o AWS_GLUE).

data_catalog_region

Región de recurso en la nube del catálogo de datos.

data_catalog_credential

Credencial local utilizada para acceder al catálogo de datos.

data_catalog_id

El nombre o identificador del catálogo de datos. El valor por defecto es NULL.

data_storage_credential

Especifica la credencial local para el acceso a datos. El valor por defecto es NULL. Este campo es opcional.

enabled

Indica si el catálogo está activado para la búsqueda. El valor por defecto es TRUE.

Ejemplo

/****************** Glue Catalog ******************/
BEGIN
  -- Create a credential capable of accessing a glue catalog
  dbms_cloud.create_credential('GLUE_CATALOG_CREDENTIAL', ...); 

  -- Mount a glue catalog
  dbms_catalog.mount_data_catalog(
    catalog_name             => 'GLUE_CAT',
    data_catalog_type        => 'AWS_GLUE',
    data_catalog_region      => 'us-east-1', 
    data_catalog_credential  => 'GLUE_CATALOG_CREDENTIAL');
END;
/

Tema principal: Resumen de DBMS_CATALOG

MOUNT_ICEBERG Procedimiento

Este procedimiento monta un catálogo de Iceberg.

Sintaxis

Consulte Especificación de catálogo de REST de Iceberg para obtener más información sobre el catálogo de Iceberg. 

PROCEDURE mount_iceberg
(
  catalog_name 				IN VARCHAR2,
  endpoint 					IN VARCHAR2,
  catalog_credential 		IN VARCHAR2,
  data_storage_credential 	IN VARCHAR2,
  configuration 			IN SYS.JSON_OBJECT_T := NULL,
  enabled 					IN BOOLEAN := TRUE,
  catalog_type 				IN VARCHAR2 := 'ICEBERG_GENERIC'
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del nuevo catálogo. Se convertirá a mayúsculas.

endpoint

URL del servidor base de Iceberg.

catalog_credential

Credencial utilizada para acceder al catálogo de Iceberg.
data_storage_credential

Credencial utilizada para acceder a los datos.
configuration

Describe la configuración del catálogo como un objeto JSON.

Las siguientes son configuraciones admitidas:
  • namespacePath: el valor por defecto es NULL.
  • namespaceSeparator: el valor predeterminado es punto (.) para Unity, %1F para otros catálogos de Iceberg.
  • isCaseSensitive: el valor por defecto es FALSE para Unity, TRUE para otros catálogos de Iceberg)
  • isPublicCatalog: el valor por defecto es FALSE.
  • bucketRegion: el valor por defecto es NULL. Solo es relevante si el catálogo utiliza almacenamiento S3.
enabled

Indica si el catálogo está activado para búsqueda. El valor por defecto es TRUE.

catalog_type

Tipo de catálogo Iceberg (p. ej., ICEBERG_GENERIC, ICEBERG_POLARIS, ICEBERG_UNITY). El valor por defecto es ICEBERG_GENERIC.

Ejemplo

/****************** Iceberg Catalog - Unity ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'all-apis');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://...//api/2.1/unity-catalog/iceberg/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_UNITY');
END;
/

/****************** Iceberg Catalog - Polaris ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/oauth/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'PRINCIPAL_ROLE:ALL');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://.../polaris/api/catalog/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_POLARIS');
END;
/

Tema principal: Resumen de DBMS_CATALOG

Procedimiento UNMOUNT

Este procedimiento desmonta un catálogo externo.

Sintaxis

PROCEDURE unmount
(
  catalog_name IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre de un catálogo existente para desmontar. Se convertirá a mayúsculas.

Tema principal: Resumen de DBMS_CATALOG

GET_CATALOG_PROPERTY Procedimiento

Este procedimiento devuelve el valor de una propiedad para un catálogo.

Sintaxis

FUNCTION get_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
catalog_property

Describe la propiedad que se va a recuperar. (Por ejemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

El valor puede ser cualquiera de las siguientes constantes:
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DCAT_TYPE
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Consulte Tipos de catálogo y constantes para obtener más información.

Tema principal: Resumen de DBMS_CATALOG

GET_CATALOG_PROPERTY_CLOB Procedimiento

Este procedimiento devuelve el valor de una propiedad para un catálogo en formato CLOB.

Sintaxis

FUNCTION get_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
catalog_property

Describe la propiedad que se va a recuperar (por ejemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

El valor puede ser cualquiera de las siguientes constantes:
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DCAT_TYPE
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Consulte Tipos de catálogo y constantes para obtener más información.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_CATALOG_PROPERTY Procedimiento

Este procedimiento actualiza el valor de una propiedad para un catálogo.

Sintaxis

PROCEDURE update_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
catalog_property

Esto describe la propiedad a actualizar (por ejemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

El valor puede ser cualquiera de las siguientes constantes:
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Consulte Tipos de catálogo y constantes para obtener más información.

new_value

El nuevo valor de la propiedad.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_CATALOG_PROPERTY_CLOB Procedimiento

Este procedimiento actualiza el valor de una propiedad para un catálogo en CLOB.

Sintaxis

PROCEDURE update_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
catalog_property

Describe la propiedad que se va a recuperar (por ejemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

new_value

El nuevo valor de propiedad en CLOB.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_TABLE_PROPERTY_CLOB Procedimiento

Este procedimiento actualiza el valor de una propiedad para una tabla en formato CLOB.

Sintaxis

PROCEDURE update_table_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name		IN VARCHAR2,
  table_property 	IN VARCHAR2,
  new_value 		IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
table_property

Propiedad que se va a actualizar.
new_value

El nuevo valor de propiedad en CLOB.

Tema principal: Resumen de DBMS_CATALOG

GET_SCHEMA_PROPERTY Procedimiento

Este procedimiento devuelve el valor de una propiedad para un esquema.

Sintaxis

FUNCTION get_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
schema_property

Describe la propiedad que se va a recuperar (por ejemplo, PROP_CUSTOM, PROP_METADATA).

Tema principal: Resumen de DBMS_CATALOG

GET_SCHEMA_PROPERTY_CLOB Procedimiento

Este procedimiento devuelve el valor de una propiedad para un esquema en formato CLOB.

Sintaxis

FUNCTION get_schema_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
schema_property

Describe la propiedad que se va a recuperar (por ejemplo, PROP_CUSTOM, PROP_METADATA).

Tema principal: Resumen de DBMS_CATALOG

UPDATE_SCHEMA_PROPERTY Procedimiento

Este procedimiento devuelve el valor de una propiedad para un esquema.

Sintaxis

PROCEDURE update_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
schema_property

Describe la propiedad que se va a recuperar (por ejemplo, PROP_CUSTOM, PROP_METADATA).

new_value

El nuevo valor de la propiedad.

Tema principal: Resumen de DBMS_CATALOG

GET_TABLE_PROPERTY Procedimiento

Este procedimiento devuelve el valor de una propiedad para una tabla.

Sintaxis

FUNCTION get_table_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_property

Propiedad que se va a recuperar.
table_name

Nombre de la tabla.

Tema principal: Resumen de DBMS_CATALOG

GET_TABLE_PROPERTY_CLOB Procedimiento

Este procedimiento devuelve el valor de una propiedad para una tabla en formato CLOB.

Sintaxis

FUNCTION get_table_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
table_property

La propiedad que se va a actualizar (por ejemplo, PROP_CUSTOM).

Tema principal: Resumen de DBMS_CATALOG

UPDATE_TABLE_PROPERTY Procedimiento

Este procedimiento actualiza el valor de una propiedad para una tabla.

Sintaxis

PROCEDURE update_table_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
table_property

Propiedad que se va a actualizar.
new_value

El nuevo valor de la propiedad.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_TABLE_PROPERTY_CLOB Procedimiento

Este procedimiento actualiza el valor de una propiedad para una tabla en formato CLOB.

Sintaxis

PROCEDURE update_table_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name		IN VARCHAR2,
  table_property 	IN VARCHAR2,
  new_value 		IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
table_property

Propiedad que se va a actualizar.
new_value

El nuevo valor de propiedad en CLOB.

Tema principal: Resumen de DBMS_CATALOG

ADD_REQUIRED_CREDENTIAL Procedimiento

Este procedimiento define una credencial necesaria para utilizar el catálogo.

Sintaxis

PROCEDURE add_required_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  local_credential	 	IN VARCHAR2 := NULL
  credential_type       IN VARCHAR2 := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
required_credential

Nombre de la credencial necesaria.
local_credential

Es una credencial local opcional que se debe utilizar. El valor por defecto es NULL.

credential_type

Este campo es opcional. Este parámetro especifica el tipo de mecanismo de autenticación que se utiliza para acceder a servicios externos, como el almacenamiento de objetos u otras bases de datos. Por ejemplo, oci, aws, azure o slack_credential.

Consulte Tipos de catálogo y constantes para obtener más información.

Tema principal: Resumen de DBMS_CATALOG

REMOVE_REQUIRED_CREDENTIAL Procedimiento

Este procedimiento elimina una credencial necesaria de un catálogo.

Sintaxis

PROCEDURE remove_required_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
required_credential

Nombre de la credencial necesaria para eliminar.

Tema principal: Resumen de DBMS_CATALOG

RENAME_REQUIRED_CREDENTIAL Procedimiento

Este procedimiento cambia el nombre de una credencial necesaria de un catálogo.

Sintaxis

PROCEDURE rename_required_credential
(
  catalog_name 			IN VARCHAR2,
  old_credential_name 	IN VARCHAR2,
  new_credential_name 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
old_credential_name

El nombre antiguo de la credencial necesaria.
new_credential_name

El nuevo nombre de la credencial necesaria.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_REQUIRED_CREDENTIAL_PROPERTY Procedimiento

Este procedimiento actualiza una propiedad de una credencial requerida con nombre.

Sintaxis

PROCEDURE update_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2,
  new_value 			IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
required_credential

Nombre de la credencial necesaria.
credential_property

El nombre de la propiedad (por ejemplo, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

new_value

Nuevo valor de la propiedad.

Tema principal: Resumen de DBMS_CATALOG

GET_REQUIRED_CREDENTIAL_PROPERTY Procedimiento

Este procedimiento recupera una propiedad de una credencial necesaria con nombre.

Sintaxis

FUNCTION get_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
required_credential

Nombre de la credencial necesaria.
credential_property

El nombre de la propiedad (por ejemplo, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

Tema principal: Resumen de DBMS_CATALOG

SET_LOCAL_CREDENTIAL Procedimiento

Este procedimiento especifica una credencial local para utilizar al consumir un catálogo.

Sintaxis

PROCEDURE set_local_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  local_credential 		IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
required_credential

Nombre de la credencial necesaria.
local_credential

Credencial que se va a utilizar.

Tema principal: Resumen de DBMS_CATALOG

Procedimiento GET_LOCAL_CREDENTIAL_MAP (sobrecargado)

Este procedimiento recupera una asignación de las credenciales necesarias a las credenciales locales.

Sintaxis 1

PROCEDURE get_local_credential_map
(
  catalog_name 		IN VARCHAR2,
  credential_map 	OUT NOCOPY credential_info_map
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
credential_map

La asignación rellena de credenciales.

Sintaxis 2

FUNCTION get_local_credential_map
(
  catalog_name 	IN VARCHAR2,
  show_errors 	IN NUMBER := 0,
  pretty_json 	IN NUMBER := 0
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente.
show_errors

Esto muestra mensajes de error para credenciales locales no válidas. El valor por defecto es 0.

pretty_json

Aplique formato al JSON con la opción PRETTY. El valor por defecto es 0.

Sintaxis 3

PROCEDURE get_local_credential_map
(
  catalog_id 		IN NUMBER,
  credential_map 	OUT NOCOPY SYS.JSON_OBJECT_T
);

Parámetros

Parámetro Descripción

catalog_id

ID de un catálogo existente de la columna CATALOG_ID en ALL_MOUNTED_CATALOGS.

credential_map

El mapa rellenado como objeto JSON.

Tema principal: Resumen de DBMS_CATALOG

CREATE_CLOUD_STORAGE_LINK Procedimiento

Este procedimiento crea un enlace de almacenamiento en la nube en un catálogo.

Sintaxis

PROCEDURE create_cloud_storage_link
(
  catalog_name 			IN VARCHAR2,
  schema_name 			IN VARCHAR2,
  storage_link_name 	IN VARCHAR2,
  uri 					IN VARCHAR2,
  required_credential 	IN VARCHAR2 := NULL,
  enabled 				IN BOOLEAN := TRUE,
  replace_if_exists 	IN BOOLEAN := FALSE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name:

Nombre del esquema.
storage_link_name

Nombre del enlace de almacenamiento.
uri

URI de cubo.
required_credential

Credencial necesaria (o NULL para cubos públicos).

El valor por defecto es NULL.
enabled

Indica si el enlace de almacenamiento está activado para la búsqueda. El valor predeterminado es TRUE.
replace_if_exists

Sustituya el enlace si ya existe. El valor por defecto es FALSE.

Tema principal: Resumen de DBMS_CATALOG

DROP_CLOUD_STORAGE_LINK Procedimiento

Este procedimiento borra un enlace de almacenamiento en la nube de un catálogo.

Sintaxis

PROCEDURE drop_cloud_storage_link
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  storage_link_name IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name:

Nombre del esquema.
storage_link_name

Nombre del enlace de almacenamiento.

Tema principal: Resumen de DBMS_CATALOG

Procedimiento CREATE_EXTERNAL_TABLE

Este procedimiento crea una tabla externa en un catálogo.

Sintaxis

PROCEDURE create_external_table
(
  catalog_name 			IN VARCHAR2,
  schema_name 			IN VARCHAR2,
  table_name 			IN VARCHAR2,
  storage_link_name 	IN VARCHAR2,
  file_uri_list 		IN CLOB,
  column_list 			IN CLOB := NULL,
  field_list 			IN CLOB := NULL,
  table_format 			IN CLOB := NULL,
  credential_name 		IN VARCHAR2 := NULL,
  replace_if_exists 	IN BOOLEAN := FALSE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
storage_link_name

Nombre del enlace de almacenamiento.
file_uri_list

La lista de archivos relativos como CLOB.
column_list

Lista de columnas opcional. El valor por defecto es NULL.
field_list

Lista de campos opcional. El valor por defecto es NULL.
table_format

Información de formato opcional. El valor por defecto es NULL.
credential_name

Credencial necesaria. El valor por defecto es NULL.
replace_if_exists

Sustituya la tabla si ya existe. El valor por defecto es FALSE.

Tema principal: Resumen de DBMS_CATALOG

DROP_SCHEMA Procedimiento

Este procedimiento borra un esquema de un catálogo junto con todo su contenido.

Sintaxis

PROCEDURE drop_schema
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name:

Nombre del esquema que se va a borrar.

Tema principal: Resumen de DBMS_CATALOG

DROP_TABLE Procedimiento

Este procedimiento borra una tabla de un catálogo.

Sintaxis

PROCEDURE drop_table
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.

Tema principal: Resumen de DBMS_CATALOG

CREATE_SCHEMA Procedimiento

Este procedimiento crea un nuevo esquema en un catálogo.

Sintaxis

PROCEDURE create_schema
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.

Tema principal: Resumen de DBMS_CATALOG

GET_TABLES Procedimiento

Este procedimiento recupera todas las tablas de un catálogo.

Sintaxis

FUNCTION get_tables
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2 := NULL,
  table_name 		IN VARCHAR2 := NULL,
  conditions 		IN VARCHAR2 := NULL,
  flags 			IN NUMBER := 0,
  result_limit 		IN NUMBER := NULL,
  column_flags 		IN NUMBER := 0
)
RETURN catalog_tables PIPELINED;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre de esquema opcional. El valor por defecto es NULL.

table_name

Nombre de tabla opcional. El valor por defecto es NULL.

conditions

Condiciones adicionales opcionales que utilizan sintaxis de linaje. El valor por defecto es NULL.

result_limit

Límite de resultados opcional. El valor por defecto es NULL.
column_flags

Indicadores de columna opcionales (por ejemplo, FETCH_PROPERTIES, FETCH_METADATA). El valor por defecto es 0.

Nota

  • Los tipos RECORD describen datos estructurados con campos con nombre en las bases de datos.

  • Tiene que consultar el esquema de información de la base de datos, los catálogos del sistema o utilizar herramientas de introspección de base de datos para ver la estructura de los tipos RECORD.

Tema principal: Resumen de DBMS_CATALOG

GET_SCHEMAS Procedimiento

Este procedimiento recupera todos los esquemas de un catálogo.

Sintaxis

FUNCTION get_schemas
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL,
  column_flags 	IN NUMBER := 0
)
RETURN catalog_schemas PIPELINED;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre de esquema opcional. El valor por defecto es NULL.

conditions

Condiciones adicionales opcionales que utilizan sintaxis de linaje. El valor por defecto es NULL.

result_limit

Límite de resultados opcional. El valor por defecto es NULL.
column_flags

Indicadores de columna opcionales (por ejemplo, FETCH_PROPERTIES, FETCH_METADATA). El valor por defecto es 0.

Tema principal: Resumen de DBMS_CATALOG

GET_OBJECTS Procedimiento

Este procedimiento recupera todos los objetos de un catálogo.

Sintaxis

FUNCTION get_objects
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  object_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL
)
RETURN catalog_objects PIPELINED;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre de esquema opcional. El valor por defecto es NULL.

object_name

Nombre de objeto opcional. El valor por defecto es NULL.

conditions

Condiciones adicionales opcionales que utilizan sintaxis de linaje. El valor por defecto es NULL.

result_limit

Límite de resultados opcional. El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG

Procedimiento GENERATE_TABLE_SELECT (sobrecargado)

Este procedimiento genera una sentencia SELECT para una tabla lógica.

Sintaxis

PROCEDURE generate_table_select
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  stmt 				IN OUT NOCOPY CLOB,
  options 			IN CLOB := NULL,
  prev_gen_sql 		IN CLOB := NULL,
  prev_ts 			IN TIMESTAMP WITH TIME ZONE := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
stmt

La sentencia SELECT generada como salida.
options

Opciones de generación como un objeto JSON (por ejemplo, distinto, rowLimit, select, orderBy). El valor por defecto es NULL.
prev_gen_sql

La sentencia SELECT generada anteriormente, si se conoce. El valor por defecto es NULL.
prev_ts

Registro de hora de generación anterior, si se conoce. El valor por defecto es NULL.

Sintaxis

FUNCTION generate_table_select
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  options 		IN CLOB := NULL,
  prev_gen_sql 	IN CLOB := NULL,
  prev_ts 		IN TIMESTAMP WITH TIME ZONE := NULL
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
table_name

Nombre de la tabla.
stmt

La sentencia SELECT generada como salida.
options

Opciones de generación como un objeto JSON (por ejemplo, distinto, rowLimit, select, orderBy). El valor por defecto es NULL.
prev_gen_sql

La sentencia SELECT generada anteriormente, si se conoce. El valor por defecto es NULL.
prev_ts

Registro de hora de generación anterior, si se conoce. El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG

OPEN_TABLE_CURSOR Procedimiento

Este procedimiento abre un cursor que devuelve datos de una tabla lógica.

Sintaxis

PROCEDURE open_table_cursor
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  table_cursor 	IN OUT NOCOPY SYS_REFCURSOR,
  options 		IN CLOB := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre de esquema opcional. El valor por defecto es NULL.

table_name

Nombre de tabla opcional. El valor por defecto es NULL.

table_cursor

Cursor para devolver datos.
options

Genera opciones como un objeto JSON (por ejemplo, rowLimit, select, orderBy). El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG

FLUSH_CATALOG_CACHE Procedimiento

Este procedimiento vacía la caché de metadatos del catálogo.

Sintaxis

PROCEDURE flush_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  auto_commit	IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
auto_commit

Indica si los cambios se deben confirmar automáticamente. El valor predeterminado es TRUE.

Tema principal: Resumen de DBMS_CATALOG

PREFILL_CATALOG_CACHE Procedimiento

Este procedimiento rellena la caché del catálogo especificado con los datos actuales.

Sintaxis

PROCEDURE prefill_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  auto_commit 	IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Nombre del esquema.
auto_commit

Indica si los cambios se deben confirmar automáticamente. El valor predeterminado es TRUE.

Tema principal: Resumen de DBMS_CATALOG

CREATE_SYNCHRONIZED_SCHEMAS Procedimiento

Este procedimiento crea esquemas de base de datos locales sincronizados con definiciones de catálogo remotas.

Sintaxis

PROCEDURE create_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Lista delimitada por comas de nombres de esquema (entre comillas o sin comillas). El valor por defecto es NULL para sincronizar todos los esquemas.
restrictions

Documento JSON que especifica el ámbito de las entidades de catálogo. El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG

DROP_SYNCHRONIZED_SCHEMAS Procedimiento

Este procedimiento borra uno o más esquemas sincronizados.

Sintaxis

PROCEDURE drop_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
schema_name

Lista delimitada por comas de nombres de esquema (entre comillas o sin comillas). El valor por defecto es NULL para sincronizar todos los esquemas.
restrictions

Documento JSON que especifica el ámbito de las entidades de catálogo. El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG

UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY Procedimiento

Este procedimiento actualiza una propiedad de esquemas sincronizados.

Sintaxis

PROCEDURE update_synchronized_schema_property
(
  catalog_name 	IN VARCHAR2,
  property_name IN VARCHAR2,
  new_value 	IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
property_name

Nombre de propiedad que se va a actualizar.
new_value

El nuevo valor como CLOB.

Tema principal: Resumen de DBMS_CATALOG

GRANT_TO_RECIPIENT Procedimiento

Este procedimiento otorga acceso en un catálogo a un destinatario de recursos compartidos específico.

Sintaxis

PROCEDURE grant_to_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
recipient_name

Nombre del destinatario del recurso compartido (creado por DBMS_SHARE.CREATE_SHARE_RECIPIENT).

Tema principal: Resumen de DBMS_CATALOG

REVOKE_FROM_RECIPIENT Procedimiento

Este procedimiento revoca el acceso a un catálogo de un destinatario específico.

Sintaxis

PROCEDURE revoke_from_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2,
  owner 			IN VARCHAR2 := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo existente. Se convertirá a mayúsculas.
recipient_name

Nombre del destinatario del recurso compartido (creado por DBMS_SHARE.CREATE_SHARE_RECIPIENT).

owner

Propietario del catálogo y del destinatario. El valor por defecto es NULL.

Tema principal: Resumen de DBMS_CATALOG