Resumo de DBMS_CATALOG

Esta seção abrange os subprogramas DBMS_CATALOG fornecidos com o Oracle Autonomous AI Database.

Os subprogramas são classificados nas seguintes áreas funcionais.

Montagem e desmontagem de catálogos

Subprograma Descrição

Procedimento MOUNT_DATA_CATALOG

Este procedimento monta um catálogo de dados, como AWS GLUE ou OCI Data Catalog.

Procedimento MOUNT_DB_LINK

Este procedimento monta um catálogo com base em um link de banco de dados.

Procedimento MOUNT_ICEBERG

Este procedimento monta um catálogo do Apache Iceberg com configurações específicas.

Procedimento MOUNT_SHARE

Este procedimento monta um único catálogo com base em um compartilhamento.

Procedimento MOUNT_SHARES

Este procedimento monta vários catálogos de um provedor de compartilhamento, com sobrecargas para suportar diferentes tipos de entrada.

Procedimento MOUNT_VIRTUAL_CATALOG

Este procedimento cria e monta um novo catálogo virtual.

Procedimento UNMOUNT

Este procedimento desmonta um catálogo externo existente.

Gerenciamento de propriedades do catálogo

Subprograma Descrição

Procedimento GET_CATALOG_PROPERTY

Procedimento GET_CATALOG_PROPERTY_CLOB

Esses procedimentos recuperam valores de propriedade para um catálogo.

Procedimento UPDATE_CATALOG_PROPERTY

Procedimento UPDATE_CATALOG_PROPERTY_CLOB

Esses procedimentos atualizam valores de propriedade para um catálogo.

Função GET_COLUMN_PROPERTY

Função GET_COLUMN_PROPERTY_CLOB

Essas funções recuperam valores de propriedade para uma coluna específica no formato VARCHAR2 ou CLOB.

Procedimento UPDATE_COLUMN_PROPERTY

Procedimento UPDATE_COLUMN_PROPERTY_CLOB

Esses procedimentos atualizam valores de propriedade para uma coluna específica com opções para enviar atualizações à origem.

Procedimento GET_SCHEMA_PROPERTY

Procedimento GET_SCHEMA_PROPERTY_CLOB

Esses procedimentos recuperam valores de propriedade do esquema.

Procedimento UPDATE_SCHEMA_PROPERTY

Procedimento UPDATE_SCHEMA_PROPERTY_CLOB

Esses procedimentos atualizam os valores da propriedade do esquema.

Procedimento GET_TABLE_PROPERTY

Procedimento GET_TABLE_PROPERTY_CLOB

Esses procedimentos recuperam valores de propriedade da tabela.

Procedimento UPDATE_TABLE_PROPERTY

Procedimento UPDATE_TABLE_PROPERTY_CLOB

Esses procedimentos atualizam os valores da propriedade da tabela.

Função GET_CLOUD_STORAGE_LINK_PROPERTY

Função GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Essas funções recuperam valores de propriedade para um link de armazenamento na nuvem no formato VARCHAR2 ou CLOB.

Procedimento UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Procedimento UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Esses procedimentos atualizam os valores de propriedade de um link de armazenamento na nuvem.

Gerenciamento de Credenciais

Subprograma Descrição

Procedimento ADD_REQUIRED_CREDENTIAL

Este procedimento define uma credencial obrigatória para um catálogo.

Procedimento REMOVE_REQUIRED_CREDENTIAL

Este procedimento remove uma credencial obrigatória de um catálogo.

Procedimento RENAME_REQUIRED_CREDENTIAL

Este procedimento renomeia uma credencial obrigatória.

Procedimento GET_REQUIRED_CREDENTIAL_PROPERTY

Este procedimento recupera uma propriedade de uma credencial necessária.

Procedimento UPDATE_REQUIRED_CREDENTIAL_PROPERTY

Este procedimento atualiza uma propriedade de uma credencial necessária.

Procedimento GET_LOCAL_CREDENTIAL_MAP (Sobrecarregado)

Este procedimento recupera mapeamentos entre credenciais necessárias e credenciais locais, com sobrecargas para vários formatos de saída.

Procedimento SET_LOCAL_CREDENTIAL

Este procedimento especifica uma credencial local para uma credencial necessária.

Gerenciamento de Entidade do Catálogo

Subprograma Descrição

Procedimento CREATE_CLOUD_STORAGE_LINK

Procedimento DROP_CLOUD_STORAGE_LINK

Esses procedimentos gerenciam links de armazenamento na nuvem em um catálogo.

Função GET_CLOUD_STORAGE_LINKS

Esta função recupera metadados para links de armazenamento na nuvem em um catálogo com filtros opcionais.

Procedimento CREATE_EXTERNAL_TABLE

Este procedimento cria uma tabela externa em um catálogo.

Procedimento CREATE_SCHEMA

Este procedimento cria um novo esquema em um catálogo e também cria um esquema do Apache Iceberg em catálogos remotos.

Procedimento GET_OBJECTS

Procedimento GET_SCHEMAS

Procedimento GET_TABLES

Este procedimento recupera metadados para tabelas, esquemas e objetos dentro de um catálogo usando funções pipelined.

Procedimento DROP_SCHEMA

Procedimento DROP_TABLE

Este procedimento elimina esquemas e tabelas de um catálogo.

Função GET_COLUMNS

Esta função recupera metadados para colunas em tabelas ou views em um catálogo.

Procedimento GET_TABLE

Função GET_TABLE

Este procedimento e função recupera informações detalhadas sobre uma tabela específica no formato de registro ou JSON.

Acesso a Dados e Cache

Subprograma Descrição

Procedimento GENERATE_TABLE_SELECT (Sobrecarregado)

Este procedimento cria uma instrução SELECT para uma tabela lógica, com sobrecargas para procedimento e função.

Procedimento OPEN_TABLE_CURSOR

Este procedimento abre um cursor para retornar dados de uma tabela lógica.

Procedimento FLUSH_CATALOG_CACHE

Procedimento PREFILL_CATALOG_CACHE

Esses procedimentos gerenciam o armazenamento em cache de metadados do catálogo.

Sincronização e Compartilhamento

Subprograma Descrição

Procedimento CREATE_SYNCHRONIZED_SCHEMAS

Procedimento DROP_SYNCHRONIZED_SCHEMAS

Esses procedimentos gerenciam esquemas sincronizados com definições de catálogo remoto.

Procedimento UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY

Este procedimento atualiza propriedades de esquemas sincronizados.

Procedimento SYNCHRONIZE_SHARED_CATALOGS

Este procedimento gerencia os catálogos correspondentes aos compartilhamentos indisponíveis com opções para desmontar ou desabilitar.

Procedimento CREATE_SYNCHRONIZED_VIEWS

Este procedimento cria exibições em tabelas de catálogo para aplicar restrições.

Procedimento COPY_TABLE_PROPERTIES

Este procedimento copia propriedades de uma tabela para outra, incluindo propriedades de coluna opcionais.

Procedimento GRANT_TO_RECIPIENT

Procedimento REVOKE_FROM_RECIPIENT

Esses procedimentos gerenciam permissões de acesso para destinatários do catálogo.

Log de Eventos

Subprograma Descrição

Procedimento CLEAR_CATALOG_EVENTS

Este procedimento limpa os eventos do log de eventos do catálogo dentro de um intervalo de tempo.

Gerenciamento Específico de Iceberg

Subprograma Descrição

Procedimento CREATE_ICEBERG_TABLE

Este procedimento cria uma nova tabela Iceberg dentro de um esquema especificado em um catálogo.

Procedimento ADD_ICEBERG_SNAPSHOT

Este procedimento adiciona um snapshot a uma tabela Iceberg para representar alterações de dados com metadados detalhados.

MOUNT_DATA_CATALOG Procedimento

Este procedimento monta um catálogo de dados (por exemplo, AWS GLUE ou OCI Data Catalog).

Sintaxe

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 Descrição

catalog_name

O nome do novo catálogo. Isso será convertido em letras maiúsculas.

data_catalog_type

Tipo de catálogo de dados (por exemplo, OCI_DCAT ou AWS_GLUE).

data_catalog_region

A região de recursos da nuvem do catálogo de dados.

data_catalog_credential

A credencial local usada para acessar o catálogo de dados.

data_catalog_id

O nome ou identificador do catálogo de dados. O padrão é NULL.

data_storage_credential

Especifica a credencial local para acesso aos dados. O padrão é NULL. Esse campo é opcional.

enabled

Indica se o catálogo está ativado para pesquisa. Assume TRUE como padrão.

Exemplo

/****************** 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 Procedimento

Este procedimento monta um catálogo externo com base em um link de banco de dados.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do novo catálogo. Isso será convertido em letras maiúsculas.

db_link

O link de banco de dados a ser usado para montar o catálogo.

enabled

Indica se o catálogo está ativado para pesquisa. Assume TRUE como padrão.

MOUNT_ICEBERG Procedimento

Este procedimento monta um catálogo Iceberg.

Sintaxe

Consulte Especificação do Catálogo REST Iceberg para obter mais informações sobre o Catálogo 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 Descrição

catalog_name

O nome do novo catálogo. Isso será convertido em letras maiúsculas.

endpoint

O URL do servidor base do Iceberg.

catalog_credential

A credencial usada para acessar o catálogo Iceberg.

data_storage_credential

A credencial usada para acessar os dados.

configuration

Isso descreve a configuração do catálogo como um objeto JSON.

Estas são as configurações suportadas:
  • namespacePath: O padrão é NULL.
  • namespaceSeparator: O padrão é ponto (.) para Unity, %1F para outros catálogos de Iceberg.
  • isCaseSensitive: O padrão é FALSE para Unity, TRUE para outros catálogos de Iceberg)
  • isPublicCatalog: O padrão é FALSE.
  • bucketRegion: O padrão é NULL. Só será relevante se o catálogo usar o armazenamento S3.
enabled

Indica se o catálogo está ativado para pesquisa. Assume TRUE como padrão.

catalog_type

Tipo de catálogo Iceberg (por exemplo, ICEBERG_GENERIC, ICEBERG_POLARIS, ICEBERG_UNITY). O padrão é ICEBERG_GENERIC.

Exemplo

/****************** 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 Procedimento

Este procedimento monta um catálogo com base em um único compartilhamento.

Sintaxe

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 Descrição

catalog_name

O nome do novo catálogo. Isso será convertido em letras maiúsculas.

share_provider

O nome do provedor de compartilhamento.

share_name

O nome do compartilhamento a ser montado.

share_provider_owner

O proprietário do provedor de compartilhamento. O padrão é o catálogo atual, se NULL.

enabled

Indica se o catálogo está ativado para pesquisa. O padrão é TRUE.

Exemplo

/****************** 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 Procedimento

Este procedimento monta vários catálogos com base em compartilhamentos de um provedor de compartilhamento.

Sintaxe

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 Descrição

share_provider:

O nome do provedor de compartilhamento.

shares

Um array JSON que define a lista de compartilhamentos a serem montados. Cada elemento especifica propriedades como shareName, required, shareNameRule, catalogName, skipExisting, placeholder e enabled.

created_catalogs

Um array JSON de catálogos recém-criados, retornado como saída com propriedades como shareName e catalogName.

share_provider_owner

O proprietário do provedor de compartilhamento. O padrão é o catálogo atual, se NULL.

Sintaxe do Segundo Procedimento

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

Sintaxe do terceiro procedimento

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

Parâmetros do segundo procedimento

Os parâmetros são Idênticos ao Procedimento 1, exceto sem created_catalogs.

Parâmetros do terceiro procedimento

Os parâmetros são Idênticos à Assinatura 1, exceto que os compartilhamentos são um CLOB com um valor padrão que inclui todos os compartilhamentos.

Exemplo

/****************** 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 Procedimento

Este procedimento cria e monta um novo catálogo virtual.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do novo catálogo. Isso será convertido em letras maiúsculas.

enabled

Indica se o catálogo está ativado para pesquisa. O padrão é TRUE.

Procedimento UNMOUNT

Este procedimento desmonta um catálogo externo.

Sintaxe

PROCEDURE unmount
(
  catalog_name IN VARCHAR2
);

Parâmetros

Parâmetro Descrição

catalog_name

O nome de um catálogo existente a ser desmontado. Isso será convertido em letras maiúsculas.

GET_CATALOG_PROPERTY Procedimento

Este procedimento retorna o valor de uma propriedade de um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

catalog_property

Isso descreve a propriedade a ser recuperada. (por exemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

O valor pode ser qualquer uma das seguintes 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 e Constantes para obter mais informações.

GET_CATALOG_PROPERTY_CLOB Procedimento

Este procedimento retorna o valor de uma propriedade para um catálogo no formato CLOB.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

catalog_property

Isso descreve a propriedade a ser recuperada (por exemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

O valor pode ser qualquer uma das seguintes 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 e Constantes para obter mais informações.

UPDATE_CATALOG_PROPERTY Procedimento

Este procedimento atualiza o valor de uma propriedade para um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

catalog_property

Descreve a propriedade a ser atualizada (por exemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

O valor pode ser qualquer uma das seguintes 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 e Constantes para obter mais informações.

new_value

O valor da nova propriedade.

UPDATE_CATALOG_PROPERTY_CLOB Procedimento

Este procedimento atualiza o valor de uma propriedade para um catálogo no CLOB.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

catalog_property

Isso descreve a propriedade a ser recuperada (por exemplo, PROP_CACHE_DURATION, PROP_IS_ENABLED).

new_value

O novo valor de propriedade em CLOB.

Função GET_COLUMN_PROPERTY

Recupera um valor de propriedade específico, por exemplo, PROP_CUSTOM, PROP_METADATA, para uma coluna em uma tabela de catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

column_name

Nome da coluna.

column_property

Retorna o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA.

Função GET_COLUMN_PROPERTY_CLOB

Recupera um valor de propriedade específico para uma coluna como um Objeto Caractere Grande (CLOB).

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

column_name

Nome da coluna.

column_property

Retorna o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA.

Procedimento UPDATE_COLUMN_PROPERTY

Atualiza o valor da propriedade de uma coluna específica, com a opção de enviar a atualização para as anotações do objeto de origem.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

column_name

Nome da coluna.

column_property

Atualiza o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA

new_value

Atribui um novo valor para a propriedade.

push_to_source

Indica se a atualização da propriedade deve ser enviada para as anotações do objeto de origem.

O padrão é FALSE.

Procedimento UPDATE_COLUMN_PROPERTY_CLOB

Atualiza o valor da propriedade de uma coluna específica como um Objeto Caractere Grande (CLOB) para dados grandes, com a opção de enviar a atualização para as anotações do objeto de origem.

Sintaxe

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 Descrição
catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

column_name

Nome da coluna.

column_property

Atualiza o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA

new_value

Atribui um novo valor no formato CLOB.

push_to_source

Indica se a atualização da propriedade deve ser enviada para as anotações do objeto de origem.

O padrão é FALSE.

GET_SCHEMA_PROPERTY Procedimento

Este procedimento retorna o valor de uma propriedade para um esquema.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

schema_property

Isso descreve a propriedade a ser recuperada (por exemplo, PROP_CUSTOM, PROP_METADATA).

GET_SCHEMA_PROPERTY_CLOB Procedimento

Este procedimento retorna o valor de uma propriedade para um esquema no formato CLOB.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

schema_property

Isso descreve a propriedade a ser recuperada (por exemplo, PROP_CUSTOM, PROP_METADATA).

UPDATE_SCHEMA_PROPERTY Procedimento

Este procedimento retorna o valor de uma propriedade para um esquema.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

schema_property

Isso descreve a propriedade a ser recuperada (por exemplo, PROP_CUSTOM, PROP_METADATA).

new_value

O valor da nova propriedade.

Procedimento UPDATE_SCHEMA_PROPERTY_CLOB

Atualiza o valor da propriedade de um esquema como um Objeto Caractere Grande (CLOB) para dados grandes.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

schema_property

Atualiza o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA

new_value

Atribui um novo valor para a propriedade.

GET_TABLE_PROPERTY Procedimento

Retorna o valor de uma propriedade de uma tabela.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

table_property

A propriedade a ser recuperada.

GET_TABLE_PROPERTY_CLOB Procedimento

Este procedimento retorna o valor de uma propriedade para uma tabela no formato CLOB.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

table_name

O nome da tabela.

table_property

A propriedade a ser atualizada (por exemplo, PROP_CUSTOM).

UPDATE_TABLE_PROPERTY Procedimento

Este procedimento atualiza o valor de uma propriedade para uma tabela.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

table_name

O nome da tabela.

table_property

A propriedade a ser atualizada.

new_value

O valor da nova propriedade.

UPDATE_TABLE_PROPERTY_CLOB Procedimento

Atualiza o valor de uma propriedade de tabela usando um tipo de dados CLOB (Caracter Large Object).

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

table_property

A propriedade de tabela a ser atualizada.

new_value

Atribui um novo valor no formato CLOB.

push_to_source

Indica se a atualização da propriedade deve ser enviada para anotações do objeto de origem.

O padrão é FALSE.

ADD_REQUIRED_CREDENTIAL Procedimento

Define uma credencial necessária para usar o catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

required_credential

O nome da credencial necessária.

local_credential

É uma credencial local opcional a ser usada.

O default é NULL.

credential_type

Opcional

Este parâmetro especifica o tipo de mecanismo de autenticação que está sendo usado para acessar serviços externos, como armazenamento de objetos ou outros bancos de dados. Por exemplo, oci, aws, azure ou slack_credential.

Consulte Tipos de Catálogo e Constantes para obter mais informações.

REMOVE_REQUIRED_CREDENTIAL Procedimento

Este procedimento remove uma credencial obrigatória de um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

required_credential

O nome da credencial necessária a ser removida.

RENAME_REQUIRED_CREDENTIAL Procedimento

Este procedimento renomeia uma credencial obrigatória de um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

old_credential_name

O nome antigo da credencial necessária.

new_credential_name

O novo nome da credencial necessária.

GET_REQUIRED_CREDENTIAL_PROPERTY Procedimento

Este procedimento recupera uma propriedade de uma credencial obrigatória nomeada.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

required_credential

O nome da credencial necessária.

credential_property

O nome da propriedade (por exemplo, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

UPDATE_REQUIRED_CREDENTIAL_PROPERTY Procedimento

Este procedimento atualiza uma propriedade de uma credencial obrigatória nomeada.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

required_credential

O nome da credencial necessária.

credential_property

O nome da propriedade (por exemplo, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

new_value

O novo valor da propriedade.

GET_LOCAL_CREDENTIAL_MAP (Sobreposto) Procedimento

Este procedimento recupera um mapa de credenciais necessárias para credenciais locais.

Sintaxe 1

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

credential_map

O mapa de credenciais preenchido.

Sintaxe 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 Descrição

catalog_name

O nome do catálogo existente.

show_errors

Isso exibe mensagens de erro para credenciais locais inválidas. O padrão é 0.

pretty_json

Formate o JSON com a opção PRETTY. Assume 0 como padrão.

Sintaxe 3

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

Parâmetros

Parâmetro Descrição

catalog_id

O ID de um catálogo existente da coluna CATALOG_ID no ALL_MOUNTED_CATALOGS.

credential_map

O mapa preenchido como um objeto JSON.

SET_LOCAL_CREDENTIAL Procedimento

Este procedimento especifica uma credencial local a ser usada ao consumir um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

required_credential

O nome da credencial necessária.

local_credential

A credencial a ser usada.

Função GET_CLOUD_STORAGE_LINK_PROPERTY

Recupera um valor de propriedade específico, por exemplo, PROP_CUSTOM, PROP_METADATA, para um link de armazenamento na nuvem em um catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

storage_link_name

Nome do link de armazenamento na nuvem.

storage_link_property

Retorna o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA.

Função GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Recupera um valor de propriedade específico para um link de armazenamento em nuvem como um Objeto de Caractere Grande (CLOB).

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

storage_link_name

Nome do link de armazenamento na nuvem.

storage_link_property

Retorna o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA.

Procedimento UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Atualiza um valor de propriedade específico para um link de armazenamento na nuvem em um catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

storage_link_name

Nome do link de armazenamento na nuvem.

storage_link_property

Atualiza o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA

new_value

Atribui um novo valor para a propriedade.

Procedimento UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Atualiza um valor de propriedade específico para um link de armazenamento na nuvem como um Objeto de Caractere Grande (CLOB) para dados maiores.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

storage_link_name

Nome do link de armazenamento na nuvem.

storage_link_property

Atualiza o valor da propriedade, por exemplo, PROP_CUSTOM, PROP_METADATA

new_value

Atribui um novo valor no formato CLOB.

CREATE_CLOUD_STORAGE_LINK Procedimento

Este procedimento cria um link de armazenamento na nuvem em um catálogo.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name:

O nome do esquema.

storage_link_name

O nome do link de armazenamento.

uri

O URI do bucket.

required_credential

A credencial necessária (ou NULL para buckets públicos).

O padrão é NULL.

enabled

Indica se o link de armazenamento está ativado para pesquisa. O padrão é TRUE.

replace_if_exists

Substitua o link se ele já existir. Assume FALSE como padrão.

DROP_CLOUD_STORAGE_LINK Procedimento

Este procedimento elimina um link de armazenamento na nuvem de um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name:

O nome do esquema.

storage_link_name

O nome do link de armazenamento.

Função GET_CLOUD_STORAGE_LINKS

Recupera um link específico ou todos os links de armazenamento na nuvem de um catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

(Opcional)

Nome do esquema do catálogo de origem.

O default é NULL.

storage_link_name

(Opcional)

Nome do link de armazenamento na nuvem.

O default é NULL.

conditions

(Opcional)

Expressões de filtro adicionais usando sintaxe de linhagem.

O default é NULL.

flags

(Opcional)

Bandeiras para controle adicional.

O padrão é 0 (zero).

result_limit

(Opcional)

O número máximo de linhas a serem retornadas.

O default é NULL.

column_flags

(Opcional)

Sinalizadores de coluna, por exemplo, FETCH_PROPERTIES, FETCH_METADATA.

Função GET_COLUMNS

Recupera todas as colunas de uma tabela ou view em um catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

(Opcional)

Nome do esquema do catálogo de origem.

O default é NULL.

parent_type

(Opcional)

O tipo de objeto pai, ou seja, tabela ou view.

O default é NULL.

column_name

(Opcional)

Nome da coluna.

O default é NULL.

conditions

(Opcional)

Expressões de filtro adicionais usando sintaxe de linhagem.

O default é NULL.

flags

(Opcional)

Bandeiras para controle adicional.

O padrão é 0 (zero).

result_limit

(Opcional)

O número máximo de linhas a serem retornadas.

O default é NULL.

column_flags

(Opcional)

Sinalizadores de coluna, por exemplo, FETCH_PROPERTIES, FETCH_METADATA.

O padrão é 0 (zero).

table_name

(Opcional)

Nome da tabela do catálogo de origem.

O default é NULL.

Procedimento CREATE_EXTERNAL_TABLE

Cria uma tabela externa em um catálogo.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

storage_link_name

(Opcional)

Nome do link de armazenamento na nuvem.

O default é NULL.

file_uri_list

A lista de arquivos relativa como CLOB.

column_list

(Opcional)

Lista de colunas.

O default é NULL.

field_list

(Opcional)

Lista de campos

O default é NULL.

table_format

(Opcional)

O formato ou as opções para ler arquivos externos, por exemplo, CSV, Parquet ou Avro, delimitadores, cabeçalhos, definições de derivação de esquema etc.). É expresso como pares de chave/valor JSON.

O default é NULL.

credential_name

Nome da credencial.

O default é NULL.

replace_if_exists

Indica se um objeto deve ser substituído se já existir.

O padrão é FALSE.

CREATE_SCHEMA Procedimento

Cria um novo esquema em um catálogo. Você também pode criar o esquema do Apache Iceberg em catálogos remotos.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

schema_definition

(Opcional)

Payload de definição do esquema.

O default é NULL.

DROP_SCHEMA Procedimento

Este procedimento elimina um esquema de um catálogo junto com todo o seu conteúdo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name:

O nome de esquema a ser eliminado.

GET_OBJECTS Procedimento

Este procedimento extrai todos os objetos de um catálogo.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Nome do esquema opcional. Assume NULL como padrão.

object_name

Nome do objeto opcional. Assume NULL como padrão.

conditions

Condições adicionais opcionais usando sintaxe de linhagem. Assume NULL como padrão.

result_limit

Limite de resultados opcionais. O padrão é NULL.

GET_SCHEMAS Procedimento

Este procedimento extrai todos os esquemas de um catálogo.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Nome do esquema opcional. Assume NULL como padrão.

conditions

Condições adicionais opcionais usando sintaxe de linhagem. Assume NULL como padrão.

result_limit

Limite de resultados opcionais. O padrão é NULL.

column_flags

Sinalizadores de coluna opcionais (por exemplo, FETCH_PROPERTIES, FETCH_METADATA). O padrão é 0.

GET_TABLES Procedimento

Este procedimento extrai todas as tabelas de um catálogo.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Nome do esquema opcional. Assume NULL como padrão.

table_name

Nome da tabela opcional. Assume NULL como padrão.

conditions

Condições adicionais opcionais usando sintaxe de linhagem. Assume NULL como padrão.

result_limit

Limite de resultados opcionais. O padrão é NULL.

column_flags

Sinalizadores de coluna opcionais (por exemplo, FETCH_PROPERTIES, FETCH_METADATA). O padrão é 0.

Observação

  • Os tipos RECORD descrevem dados estruturados com campos nomeados em bancos de dados.

  • Você tem que consultar o esquema de informações do banco de dados, catálogos do sistema ou usar ferramentas de introspecção do banco de dados para ver a estrutura dos tipos RECORD.

Procedimento GET_TABLE

Recupera informações detalhadas de uma tabela específica em um catálogo como um registro, com opções para personalizar as considerações de saída e armazenamento em cache.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

options

Opções de geração como um objeto JSON, por exemplo, distinto, rowLimit, select, orderBy e diretiva.

O default é NULL.

flags

(Opcional)

Bandeiras para controle adicional.

O padrão é 0 (zero).

column_flags

(Opcional)

Sinalizadores de coluna, por exemplo, FETCH_PROPERTIES, FETCH_METADATA.

O padrão é 0 (zero).

prev_gen_sql

Instrução SELECT gerada anteriormente para processamento incremental, se conhecida.

O default é NULL.

prev_ts

Carimbo de data/hora da geração anterior, se conhecido.

O default é NULL.

Observação

Função GET_TABLE

Função GET_TABLE

Recupera informações detalhadas de uma tabela específica no formato JSON como um Objeto de Caractere Grande (CLOB).

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

options

Opções de geração como um objeto JSON, por exemplo, distinto, rowLimit, select, orderBy e diretiva.

O default é NULL.

flags

(Opcional)

Bandeiras para controle adicional.

O padrão é 0 (zero).

column_flags

(Opcional)

Sinalizadores de coluna, por exemplo, FETCH_PROPERTIES, FETCH_METADATA.

O padrão é 0 (zero).

prev_gen_sql

Instrução SELECT gerada anteriormente para processamento incremental, se conhecida.

O default é NULL.

prev_ts

Carimbo de data/hora da geração anterior, se conhecido.

O default é NULL.

DROP_TABLE Procedimento

Este procedimento elimina uma tabela de um catálogo.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

table_name

O nome da tabela.

GENERATE_TABLE_SELECT (Sobreposto) Procedimento

Este procedimento gera uma instrução SELECT para uma tabela lógica.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

table_name

O nome da tabela.

stmt

A instrução SELECT gerada como saída.

options

Opções de geração como um objeto JSON (por exemplo, distinto, rowLimit, selecione, orderBy). O padrão é NULL.

prev_gen_sql

A instrução SELECT gerada anteriormente, se conhecida. O padrão é NULL.

prev_ts

O marcador de data/hora da geração anterior, se conhecido. O padrão é NULL.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

table_name

O nome da tabela.

stmt

A instrução SELECT gerada como saída.

options

Opções de geração como um objeto JSON (por exemplo, distinto, rowLimit, selecione, orderBy). O padrão é NULL.

prev_gen_sql

A instrução SELECT gerada anteriormente, se conhecida. O padrão é NULL.

prev_ts

O marcador de data/hora da geração anterior, se conhecido. O padrão é NULL.

OPEN_TABLE_CURSOR Procedimento

Este procedimento abre um cursor que retorna dados de uma tabela lógica.

Sintaxe

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 Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Nome do esquema opcional. Assume NULL como padrão.

table_name

Nome da tabela opcional. Assume NULL como padrão.

table_cursor

O cursor para retornar dados.

options

Gera opções como um objeto JSON (por exemplo, rowLimit, select, orderBy). O padrão é NULL.

FLUSH_CATALOG_CACHE Procedimento

Este procedimento descarrega o cache de metadados do catálogo,

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

auto_commit

Indica se as alterações devem ser confirmadas automaticamente. O padrão é TRUE.

PREFILL_CATALOG_CACHE Procedimento

Este procedimento preenche o cache do catálogo especificado com os dados atuais.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

O nome do esquema.

auto_commit

Indica se as alterações devem ser confirmadas automaticamente. O padrão é TRUE.

CREATE_SYNCHRONIZED_SCHEMAS Procedimento

Este procedimento cria esquemas de banco de dados local sincronizados com definições de catálogo remoto.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Uma lista de nomes de esquema delimitados por vírgulas (citado ou sem aspas). O padrão é NULL para sincronizar todos os esquemas.

restrictions

Documento JSON especificando o escopo das entidades do catálogo. O padrão é NULL.

DROP_SYNCHRONIZED_SCHEMAS Procedimento

Este procedimento elimina um ou mais esquemas sincronizados.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

schema_name

Uma lista de nomes de esquema delimitados por vírgulas (citado ou sem aspas). O padrão é NULL para sincronizar todos os esquemas.

restrictions

Documento JSON especificando o escopo das entidades do catálogo. O padrão é NULL.

UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY Procedimento

Este procedimento atualiza uma propriedade de esquemas sincronizados.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

property_name

O nome da propriedade a ser atualizado.

new_value

O novo valor como CLOB.

Procedimento SYNCHRONIZE_SHARED_CATALOGS

Tratar catálogos com base em compartilhamentos que não estão mais disponíveis.

Sintaxe

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

Parâmetros

Parâmetro Descrição
provider_id

(Opcional)

Identifica o escopo da sincronização. As alterações são restritas ao ID do provedor de compartilhamento especificado. Se NULL, ele sincroniza todos os provedores de compartilhamento registrados, incluindo os compartilhamentos expirados.

O default é NULL.

remove_unavailable

Determina a ação nos catálogos com base na disponibilidade do compartilhamento.

  • TRUE: Desmonta os objetos para compartilhamentos excluídos ou não disponíveis.

  • FALSE: Desativa os objetos se os compartilhamentos não estiverem disponíveis.

O default é TRUE.

Procedimento CREATE_SYNCHRONIZED_VIEWS

Cria visualizações em tabelas de catálogo para definir restrições.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

O default é NULL.

target_schema

Nome do esquema de destino.

O default é NULL.

table_names

Lista de nomes de tabela separados por vírgulas se tabelas específicas forem direcionadas.

O default é NULL.

view_prefix

String para anexar a cada nome de view gerado.

O default é NULL.

replace_existing

Indica se um objeto deve ser substituído se já existir.

O padrão é FALSE.

ignore_errors

Indica se os erros devem ser ignorados e continua o processamento com os objetos restantes.

O default é TRUE.

Procedimento COPY_TABLE_PROPERTIES

Copia propriedades de tabela e, opcionalmente, propriedades de coluna de uma tabela de origem para uma tabela de destino em catálogos e esquemas, com opções para selecionar um conjunto de propriedades e especificar mapeamentos de renomeação de coluna.

Sintaxe

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 Descrição
catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da tabela do catálogo de origem.

target_catalog_name

Nome do catálogo de destino.

O padrão é DEFAULT_CATALOG.

target_schema_name

Nome do esquema de destino.

O default é NULL.

target_table_name

Nome da tabela do catálogo de destino.

O default é NULL.

properties

As propriedades a serem copiadas, por exemplo CUSTOM:prop_x. O padrão é PROP_CUSTOM.

copy_column_props

Indica se as propriedades personalizadas da coluna devem ser copiadas.

O default é TRUE.

renamed_columns

Mapeamento JSON de colunas de destino renomeadas, por exemplo, {"source_col":"target_col"}.

O default é NULL.

GRANT_TO_RECIPIENT Procedimento

Este procedimento concede acesso em um catálogo a um destinatário de compartilhamento específico.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

recipient_name

O nome do destinatário do compartilhamento (criado por DBMS_SHARE.CREATE_SHARE_RECIPIENT).

REVOKE_FROM_RECIPIENT Procedimento

Este procedimento revoga o acesso em um catálogo de um destinatário específico.

Sintaxe

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

Parâmetros

Parâmetro Descrição

catalog_name

O nome do catálogo existente. Isso será convertido em letras maiúsculas.

recipient_name

O nome do destinatário do compartilhamento (criado por DBMS_SHARE.CREATE_SHARE_RECIPIENT).

owner

O proprietário do catálogo e do destinatário. Assume NULL como padrão.

Procedimento CLEAR_CATALOG_EVENTS

Recupera informações detalhadas de uma tabela específica em um catálogo como um registro, com opções para personalizar as considerações de saída e armazenamento em cache.

Sintaxe

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 Descrição

catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

from_time

Opcional

O horário de início para a limpeza do intervalo de eventos.

O default é NULL.

to_time

Opcional

O horário final para a limpeza do intervalo de eventos.

O default é NULL.

Procedimento CREATE_ICEBERG_TABLE

Cria uma nova tabela Iceberg dentro de um esquema especificado em um catálogo, retornando os metadados resultantes.

Sintaxe

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 Descrição
catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da nova tabela.

table_definition

A definição de tabela como CLOB.

out_metadata

Os metadados da tabela resultante após a saída.

Procedimento ADD_ICEBERG_SNAPSHOT

Adiciona um snapshot a uma tabela Iceberg para representar alterações de dados, incluindo metadados detalhados e parâmetros opcionais para rastrear linhagem e conteúdo.

Sintaxe

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 Descrição
catalog_name

Nome do catálogo de origem. O valor está em maiúscula.

schema_name

Nome do esquema do catálogo de origem.

table_name

Nome da nova tabela.

new_snapshot_id

Um identificador exclusivo para o novo instantâneo.

new_timestamp

O timestamp de criação do snapshot.

new_manifest_list

O local, o caminho ou o URI do arquivo da lista de manifestos.

new_summary

Um resumo de metadados do snapshot que inclui pelo menos um campo "operação".

new_parent_snapshot_id

O ID do pai deste instantâneo. Isso não se aplica aos instantâneos raiz.

new_sequence_number

Um número incremental para rastrear a ordem das alterações de tabela.

new_first_row_id

O ID da linha inicial atribuído à primeira linha no primeiro arquivo de dados da captura.

new_added_row_count

O número de linhas adicionadas no instantâneo.

new_schema_id

O ID do esquema de tabela ativo quando o snapshot foi criado.

requirements

Pré-condições para o commit, no formato de array JSON.

out_metadata

Os metadados da tabela resultante após a saída.