Resumen de DBMS_CATALOG

En esta sección se tratan los subprogramas DBMS_CATALOG proporcionados con Oracle Autonomous AI Database.

Los subprogramas se clasifican en las siguientes áreas funcionales.

Montaje y desmontaje del catálogo

Subprograma Descripción

Procedimiento MOUNT_DATA_CATALOG

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

Procedimiento MOUNT_DB_LINK

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

Procedimiento MOUNT_ICEBERG

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

Procedimiento MOUNT_SHARE

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

Procedimiento MOUNT_SHARES

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

Procedimiento MOUNT_VIRTUAL_CATALOG

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

Procedimiento UNMOUNT

Este procedimiento desmonta un catálogo externo existente.

Gestión de propiedades de catálogo

Subprograma Descripción

Procedimiento GET_CATALOG_PROPERTY

Procedimiento GET_CATALOG_PROPERTY_CLOB

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

Procedimiento UPDATE_CATALOG_PROPERTY

Procedimiento UPDATE_CATALOG_PROPERTY_CLOB

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

Función GET_COLUMN_PROPERTY

Función GET_COLUMN_PROPERTY_CLOB

Estas funciones recuperan valores de propiedad para una columna específica en formato VARCHAR2 o CLOB.

Procedimiento UPDATE_COLUMN_PROPERTY

Procedimiento UPDATE_COLUMN_PROPERTY_CLOB

Estos procedimientos actualizan los valores de propiedad de una columna específica con opciones para enviar actualizaciones al origen.

Procedimiento GET_SCHEMA_PROPERTY

Procedimiento GET_SCHEMA_PROPERTY_CLOB

Estos procedimientos recuperan los valores de propiedad del esquema.

Procedimiento UPDATE_SCHEMA_PROPERTY

Procedimiento UPDATE_SCHEMA_PROPERTY_CLOB

Estos procedimientos actualizan los valores de propiedad del esquema.

Procedimiento GET_TABLE_PROPERTY

Procedimiento GET_TABLE_PROPERTY_CLOB

Estos procedimientos recuperan los valores de propiedad de la tabla.

Procedimiento UPDATE_TABLE_PROPERTY

Procedimiento UPDATE_TABLE_PROPERTY_CLOB

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

Función GET_CLOUD_STORAGE_LINK_PROPERTY

Función GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Estas funciones recuperan valores de propiedad para un enlace de almacenamiento en la nube en formato VARCHAR2 o CLOB.

Procedimiento UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Procedimiento UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Estos procedimientos actualizan los valores de propiedad de un enlace de almacenamiento en la nube.

Gestión de Credenciales

Subprograma Descripción

Procedimiento ADD_REQUIRED_CREDENTIAL

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

Procedimiento REMOVE_REQUIRED_CREDENTIAL

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

Procedimiento RENAME_REQUIRED_CREDENTIAL

Este procedimiento cambia el nombre de una credencial necesaria.

Procedimiento GET_REQUIRED_CREDENTIAL_PROPERTY

Este procedimiento recupera una propiedad de una credencial necesaria.

Procedimiento UPDATE_REQUIRED_CREDENTIAL_PROPERTY

Este procedimiento actualiza una propiedad de una credencial necesaria.

Procedimiento GET_LOCAL_CREDENTIAL_MAP (sobrecargado)

Este procedimiento recupera las asignaciones entre las credenciales necesarias y las credenciales locales, con sobrecargas para varios formatos de salida.

Procedimiento SET_LOCAL_CREDENTIAL

Este procedimiento especifica una credencial local para una credencial necesaria.

Gestión de entidades de catálogo

Subprograma Descripción

Procedimiento CREATE_CLOUD_STORAGE_LINK

Procedimiento DROP_CLOUD_STORAGE_LINK

Estos procedimientos gestionan los enlaces de almacenamiento en la nube en un catálogo.

Función GET_CLOUD_STORAGE_LINKS

Esta función recupera metadatos para enlaces de almacenamiento en la nube en un catálogo con filtros opcionales.

Procedimiento CREATE_EXTERNAL_TABLE

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

Procedimiento CREATE_SCHEMA

Este procedimiento crea un nuevo esquema en un catálogo y también crea un esquema Apache Iceberg en catálogos remotos.

Procedimiento GET_OBJECTS

Procedimiento GET_SCHEMAS

Procedimiento GET_TABLES

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

Procedimiento DROP_SCHEMA

Procedimiento DROP_TABLE

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

Función GET_COLUMNS

Esta función recupera metadatos para columnas en tablas o vistas de un catálogo.

Procedimiento GET_TABLE

Función GET_TABLE

Este procedimiento y función recupera información detallada sobre una tabla específica en formato de registro o JSON.

Acceso y almacenamiento en caché de datos

Subprograma Descripción

Procedimiento GENERATE_TABLE_SELECT (sobrecargado)

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

Procedimiento OPEN_TABLE_CURSOR

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

Procedimiento FLUSH_CATALOG_CACHE

Procedimiento PREFILL_CATALOG_CACHE

Estos procedimientos gestionan el almacenamiento en caché de metadatos del catálogo.

Sincronización y uso compartido

Subprograma Descripción

Procedimiento CREATE_SYNCHRONIZED_SCHEMAS

Procedimiento DROP_SYNCHRONIZED_SCHEMAS

Estos procedimientos gestionan esquemas sincronizados con definiciones de catálogo remotas.

Procedimiento UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY

Este procedimiento actualiza las propiedades de los esquemas sincronizados.

Procedimiento SYNCHRONIZE_SHARED_CATALOGS

Este procedimiento gestiona los catálogos correspondientes a recursos compartidos no disponibles con opciones para desmontar o desactivar.

Procedimiento CREATE_SYNCHRONIZED_VIEWS

Este procedimiento crea vistas en las tablas del catálogo para aplicar restricciones.

Procedimiento COPY_TABLE_PROPERTIES

Este procedimiento copia las propiedades de una tabla a otra, incluidas las propiedades de columna opcionales.

Procedimiento GRANT_TO_RECIPIENT

Procedimiento REVOKE_FROM_RECIPIENT

Estos procedimientos gestionan los permisos de acceso para los destinatarios del catálogo.

Registro de eventos

Subprograma Descripción

Procedimiento CLEAR_CATALOG_EVENTS

Este procedimiento borra los eventos del registro de eventos del catálogo dentro de un intervalo de tiempo.

Gestión específica de icebergs

Subprograma Descripción

Procedimiento CREATE_ICEBERG_TABLE

Este procedimiento crea una nueva tabla Iceberg dentro de un esquema especificado en un catálogo.

Procedimiento ADD_ICEBERG_SNAPSHOT

Este procedimiento agrega una instantánea a una tabla Iceberg para representar los cambios de datos con metadatos detallados.

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;
/

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.

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;
/

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;
/

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;
/

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.

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.

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.

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.

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.

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.

Función GET_COLUMN_PROPERTY

Recupera un valor de propiedad específico, por ejemplo PROP_CUSTOM, PROP_METADATA, para una columna de una tabla de catálogo.

Sintaxis

FUNCTION GET_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

column_name

Nombre de la columna.

column_property

Devuelve el valor de la propiedad, por ejemplo PROP_CUSTOM, PROP_METADATA.

Función GET_COLUMN_PROPERTY_CLOB

Recupera un valor de propiedad específico para una columna como objeto grande de caracteres (CLOB).

Sintaxis

FUNCTION GET_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

column_name

Nombre de la columna.

column_property

Devuelve el valor de la propiedad, por ejemplo PROP_CUSTOM, PROP_METADATA.

Procedimiento UPDATE_COLUMN_PROPERTY

Actualiza el valor de propiedad de una columna específica, con una opción para transferir la actualización a las anotaciones del objeto de origen.

Sintaxis

PROCEDURE UPDATE_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN VARCHAR2,
  push_to_source                 IN BOOLEAN := FALSE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

column_name

Nombre de la columna.

column_property

Actualiza el valor de la propiedad, por ejemplo, PROP_CUSTOM, PROP_METADATA

new_value

Asigna un nuevo valor para la propiedad.

push_to_source

Indica si se debe transferir la actualización de la propiedad a las anotaciones del objeto de origen.

El valor por defecto es FALSO.

Procedimiento UPDATE_COLUMN_PROPERTY_CLOB

Actualiza el valor de propiedad de una columna específica como objeto grande de caracteres (CLOB) para datos grandes, con una opción para transferir la actualización a las anotaciones del objeto de origen.

Sintaxis

PROCEDURE UPDATE_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN CLOB,
  push_to_source                 IN BOOLEAN := FALSE
);

Parámetros

Parámetro Descripción
catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

column_name

Nombre de la columna.

column_property

Actualiza el valor de la propiedad, por ejemplo, PROP_CUSTOM, PROP_METADATA

new_value

Asigna un nuevo valor en formato CLOB.

push_to_source

Indica si se debe transferir la actualización de la propiedad a las anotaciones del objeto de origen.

El valor por defecto es FALSO.

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).

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).

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.

Procedimiento UPDATE_SCHEMA_PROPERTY_CLOB

Actualiza el valor de propiedad de un esquema como objeto grande de caracteres (CLOB) para datos grandes.

Sintaxis

PROCEDURE UPDATE_SCHEMA_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  schema_property                IN VARCHAR2,
  new_value                      IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

schema_property

Actualiza el valor de la propiedad, por ejemplo, PROP_CUSTOM, PROP_METADATA

new_value

Asigna un nuevo valor para la propiedad.

GET_TABLE_PROPERTY 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 de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

table_property

Propiedad que se va a recuperar.

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).

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.

UPDATE_TABLE_PROPERTY_CLOB Procedimiento

Actualiza el valor de una propiedad de tabla mediante un tipo de dato Character Large Object (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,
  push_to_source                 IN BOOLEAN := FALSE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

table_property

Propiedad de tabla que se va a actualizar.

new_value

Asigna un nuevo valor en formato CLOB.

push_to_source

Indica si se debe transferir la actualización de la propiedad a las anotaciones del objeto de origen.

El valor por defecto es FALSO.

ADD_REQUIRED_CREDENTIAL 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 de origen. El valor está en mayúsculas.

required_credential

Nombre de la credencial necesaria.

local_credential

Es una credencial local opcional para utilizar.

El valor por defecto es NULL.

credential_type

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.

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.

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.

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).

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.

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.

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.

Función GET_CLOUD_STORAGE_LINK_PROPERTY

Recupera un valor de propiedad específico, por ejemplo PROP_CUSTOM, PROP_METADATA, para un enlace de almacenamiento en la nube en un catálogo.

Sintaxis

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN VARCHAR2;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

storage_link_name

Nombre del enlace de almacenamiento en la nube.

storage_link_property

Devuelve el valor de la propiedad, por ejemplo PROP_CUSTOM, PROP_METADATA.

Función GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Recupera un valor de propiedad específico para un enlace de almacenamiento en la nube como objeto grande de caracteres (CLOB).

Sintaxis

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN CLOB;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

storage_link_name

Nombre del enlace de almacenamiento en la nube.

storage_link_property

Devuelve el valor de la propiedad, por ejemplo PROP_CUSTOM, PROP_METADATA.

Procedimiento UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Actualiza un valor de propiedad específico para un enlace de almacenamiento en la nube en un catálogo.

Sintaxis

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN VARCHAR2
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

storage_link_name

Nombre del enlace de almacenamiento en la nube.

storage_link_property

Actualiza el valor de la propiedad, por ejemplo, PROP_CUSTOM, PROP_METADATA

new_value

Asigna un nuevo valor para la propiedad.

Procedimiento UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Actualiza un valor de propiedad específico para un enlace de almacenamiento en la nube como objeto grande de caracteres (CLOB) para datos más grandes.

Sintaxis

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN CLOB
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

storage_link_name

Nombre del enlace de almacenamiento en la nube.

storage_link_property

Actualiza el valor de la propiedad, por ejemplo, PROP_CUSTOM, PROP_METADATA

new_value

Asigna un nuevo valor en formato CLOB.

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.

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.

Función GET_CLOUD_STORAGE_LINKS

Recupera un enlace de almacenamiento en la nube específico o todos los enlaces de un catálogo.

Sintaxis

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

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

(Opcional)

Nombre del esquema del catálogo de origen.

El valor por defecto es NULL.

storage_link_name

(Opcional)

Nombre del enlace de almacenamiento en la nube.

El valor por defecto es NULL.

conditions

(Opcional)

Expresiones de filtro adicionales con sintaxis de linaje.

El valor por defecto es NULL.

flags

(Opcional)

Indicadores para control adicional.

El valor por defecto es 0 (cero).

result_limit

(Opcional)

Número máximo de filas que se van a devolver.

El valor por defecto es NULL.

column_flags

(Opcional)

Indicadores de columna, por ejemplo FETCH_PROPERTIES, FETCH_METADATA.

Función GET_COLUMNS

Recupera todas las columnas de una tabla o vista de un catálogo.

Sintaxis

FUNCTION GET_COLUMNS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  parent_type                    IN VARCHAR2 := NULL,
  column_name                    IN VARCHAR2 := NULL,
  conditions                     IN VARCHAR2 := NULL,
  flags                          IN NUMBER := 0,
  result_limit                   IN NUMBER := NULL,
  column_flags                   IN NUMBER := 0,
  table_name                     IN VARCHAR2 := NULL
)
RETURN COLUMN_RECORDS PIPELINED;

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

(Opcional)

Nombre del esquema del catálogo de origen.

El valor por defecto es NULL.

parent_type

(Opcional)

Tipo de objeto principal, es decir, tabla o vista.

El valor por defecto es NULL.

column_name

(Opcional)

Nombre de la columna.

El valor por defecto es NULL.

conditions

(Opcional)

Expresiones de filtro adicionales con sintaxis de linaje.

El valor por defecto es NULL.

flags

(Opcional)

Indicadores para control adicional.

El valor por defecto es 0 (cero).

result_limit

(Opcional)

El número máximo de filas que se deben devolver.

El valor por defecto es NULL.

column_flags

(Opcional)

Indicadores de columna, por ejemplo FETCH_PROPERTIES, FETCH_METADATA.

El valor por defecto es 0 (cero).

table_name

(Opcional)

Nombre de la tabla del catálogo de origen.

El valor por defecto es NULL.

Procedimiento CREATE_EXTERNAL_TABLE

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 := NULL,
  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 de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

storage_link_name

(Opcional)

Nombre del enlace de almacenamiento en la nube.

El valor por defecto es NULL.

file_uri_list

La lista de archivos relativos como CLOB.

column_list

(Opcional)

Lista de columnas.

El valor por defecto es NULL.

field_list

(Opcional)

Lista de Campos.

El valor por defecto es NULL.

table_format

(Opcional)

Formato u opciones para leer archivos externos, por ejemplo, CSV, Parquet o Avro, delimitadores, cabeceras, configuración de derivación de esquema, etc.). Se expresa como pares clave-valor JSON.

El valor por defecto es NULL.

credential_name

Nombre de la Credencial.

El valor por defecto es NULL.

replace_if_exists

Indica si se debe sustituir un objeto si ya existe.

El valor por defecto es FALSO.

CREATE_SCHEMA Procedimiento

Crea un nuevo esquema en un catálogo. También puede crear un esquema Apache Iceberg en catálogos remotos.

Sintaxis

PROCEDURE CREATE_SCHEMA
(
  catalog_name          IN VARCHAR2,
  schema_name           IN VARCHAR2,
  schema_definition     IN CLOB := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

schema_definition

(Opcional)

Carga útil de definición de esquema.

El valor por defecto es NULL.

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.

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.

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.

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.

Procedimiento GET_TABLE

Recupera información detallada para una tabla específica de un catálogo como registro, con opciones para personalizar las consideraciones de salida y almacenamiento en caché.

Sintaxis

PROCEDURE GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_info                     OUT NOCOPY catalog_table,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  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 de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

options

Opciones de generación como un objeto JSON, por ejemplo, distinto, rowLimit, select, orderBy y directiva.

El valor por defecto es NULL.

flags

(Opcional)

Indicadores para control adicional.

El valor por defecto es 0 (cero).

column_flags

(Opcional)

Indicadores de columna, por ejemplo FETCH_PROPERTIES, FETCH_METADATA.

El valor por defecto es 0 (cero).

prev_gen_sql

Sentencia SELECT generada anteriormente para el procesamiento incremental, 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.

Función GET_TABLE

Recupera información detallada para una tabla específica en formato JSON como objeto grande de caracteres (CLOB).

Sintaxis

FUNCTION GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  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 de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

options

Opciones de generación como un objeto JSON, por ejemplo, distinto, rowLimit, select, orderBy y directiva.

El valor por defecto es NULL.

flags

(Opcional)

Indicadores para control adicional.

El valor por defecto es 0 (cero).

column_flags

(Opcional)

Indicadores de columna, por ejemplo FETCH_PROPERTIES, FETCH_METADATA.

El valor por defecto es 0 (cero).

prev_gen_sql

Sentencia SELECT generada anteriormente para el procesamiento incremental, 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.

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.

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.

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.

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.

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.

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.

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.

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.

Procedimiento SYNCHRONIZE_SHARED_CATALOGS

Gestione los catálogos según los recursos compartidos que ya no estén disponibles.

Sintaxis

PROCEDURE SYNCHRONIZE_SHARED_CATALOGS
(
  provider_id                    IN NUMBER := NULL,
  remove_unavailable             IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción
provider_id

(Opcional)

Identifica el ámbito de la sincronización. Los cambios están restringidos al ID de proveedor de recursos compartidos especificado. Si es NULL, sincroniza todos los proveedores de recursos compartidos registrados, incluidos los recursos compartidos caducados.

El valor por defecto es NULL.

remove_unavailable

Determina la acción en los catálogos en función de la disponibilidad de recursos compartidos.

  • TRUE: desmonta los objetos para los recursos compartidos que se han suprimido o no están disponibles.

  • FALSE: desactiva los objetos si los recursos compartidos no están disponibles.

El valor por defecto es TRUE.

Procedimiento CREATE_SYNCHRONIZED_VIEWS

Permite crear vistas en las tablas de catálogo para definir restricciones.

Sintaxis

PROCEDURE CREATE_SYNCHRONIZED_VIEWS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  target_schema                  IN VARCHAR2 := NULL,
  table_names                    IN VARCHAR2 := NULL,
  view_prefix                    IN VARCHAR2 := NULL,
  replace_existing               IN BOOLEAN := FALSE,
  ignore_errors                  IN BOOLEAN := TRUE
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

El valor por defecto es NULL.

target_schema

Nombre del esquema de destino.

El valor por defecto es NULL.

table_names

Lista separada por comas de nombres de tabla si se dirigen tablas específicas.

El valor por defecto es NULL.

view_prefix

Cadena que antepone a cada nombre de vista generado.

El valor por defecto es NULL.

replace_existing

Indica si se debe sustituir un objeto si ya existe.

El valor por defecto es FALSO.

ignore_errors

Indica si se deben ignorar los errores y continuar el procesamiento con los objetos restantes.

El valor por defecto es TRUE.

Procedimiento COPY_TABLE_PROPERTIES

Copia las propiedades de tabla y, opcionalmente, las propiedades de columna de una tabla de origen a una tabla de destino en catálogos y esquemas, con opciones para seleccionar un juego de propiedades y especificar asignaciones de cambio de nombre de columna.

Sintaxis

PROCEDURE COPY_TABLE_PROPERTIES
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  target_catalog_name            IN VARCHAR2 := DEFAULT_CATALOG,
  target_schema_name             IN VARCHAR2 := NULL,
  target_table_name              IN VARCHAR2 := NULL,
  properties                     IN VARCHAR2 := PROP_CUSTOM,
  copy_column_props              IN BOOLEAN := TRUE,
  renamed_columns                IN CLOB := NULL
);

Parámetros

Parámetro Descripción
catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la tabla del catálogo de origen.

target_catalog_name

Nombre del catálogo de destino.

El valor por defecto es DEFAULT_CATALOG.

target_schema_name

Nombre del esquema de destino.

El valor por defecto es NULL.

target_table_name

Nombre de la tabla del catálogo destino.

El valor por defecto es NULL.

properties

Propiedades que copiar, por ejemplo CUSTOM:prop_x. El valor por defecto es PROP_CUSTOM.

copy_column_props

Indica si se deben copiar las propiedades personalizadas de columna.

El valor por defecto es TRUE.

renamed_columns

Asignación de JSON de columnas de destino con nombre cambiado, por ejemplo, {"source_col":"target_col"}.

El valor por defecto es NULL.

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).

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.

Procedimiento CLEAR_CATALOG_EVENTS

Recupera información detallada para una tabla específica de un catálogo como registro, con opciones para personalizar las consideraciones de salida y almacenamiento en caché.

Sintaxis

PROCEDURE CLEAR_CATALOG_EVENTS
(
  catalog_name                   IN VARCHAR2,
  from_time                      IN TIMESTAMP WITH TIME ZONE := NULL,
  to_time                        IN TIMESTAMP WITH TIME ZONE := NULL
);

Parámetros

Parámetro Descripción

catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

from_time

Opcional

Hora de inicio para que se borre el rango de eventos.

El valor por defecto es NULL.

to_time

Opcional

La hora de finalización para que se borre el rango de eventos.

El valor por defecto es NULL.

Procedimiento CREATE_ICEBERG_TABLE

Crea una nueva tabla Iceberg dentro de un esquema especificado en un catálogo, devolviendo los metadatos resultantes.

Sintaxis

PROCEDURE CREATE_ICEBERG_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_definition               IN CLOB,
  out_metadata                   OUT NOCOPY CLOB
);

Parámetros

Parámetro Descripción
catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la nueva tabla.

table_definition

La definición de tabla como CLOB.

out_metadata

Los metadatos de la tabla resultante que siguen a la salida.

Procedimiento ADD_ICEBERG_SNAPSHOT

Agrega una instantánea a una tabla Iceberg para representar los cambios de datos, incluidos los metadatos detallados y los parámetros opcionales para el seguimiento del linaje y el contenido.

Sintaxis

PROCEDURE ADD_ICEBERG_SNAPSHOT
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  new_snapshot_id                IN NUMBER,
  new_timestamp                  TIMESTAMP WITH TIME ZONE,
  new_manifest_list              IN VARCHAR2,
  new_summary                    IN CLOB := NULL,
  new_parent_snapshot_id         IN NUMBER := NULL,
  new_sequence_number            IN NUMBER := NULL,
  new_first_row_id               IN NUMBER := NULL,
  new_added_row_count            IN NUMBER := NULL,
  new_schema_id                  IN NUMBER := NULL,
  requirements                   IN CLOB := NULL,
  out_metadata                   OUT NOCOPY CLOB
);

Parámetros

Parámetro Descripción
catalog_name

Nombre del catálogo de origen. El valor está en mayúsculas.

schema_name

Nombre del esquema del catálogo de origen.

table_name

Nombre de la nueva tabla.

new_snapshot_id

Un identificador único para la nueva instantánea.

new_timestamp

Registro de hora en el que se creó la instantánea.

new_manifest_list

Ubicación, ruta o URI del archivo de lista de manifiestos.

new_summary

Resumen de metadatos de la instantánea que incluye al menos un campo de "operación".

new_parent_snapshot_id

ID del principal de esta instantánea. Esto no se aplica a las instantáneas raíz.

new_sequence_number

Número incremental para realizar un seguimiento del orden de los cambios de tabla.

new_first_row_id

El ID de fila inicial asignado a la primera fila del primer archivo de datos de la instantánea.

new_added_row_count

Número de filas agregadas en la instantánea.

new_schema_id

ID del esquema de tabla activo cuando se creó la instantánea.

requirements

Condiciones previas para la confirmación, en formato de matriz JSON.

out_metadata

Los metadatos de la tabla resultante que siguen a la salida.