Documentação do Oracle Cloud Infrastructure

Resumo de DBMS_CATALOG

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

Montagem e desmontagem de catálogos

Subprograma Descrição

mount_db_link

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

mount_shares

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

mount_share

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

mount_virtual_catalog

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

mount_data_catalog

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

mount_iceberg

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

desmontar

Este procedimento desmonta um catálogo externo existente.

Gerenciamento de propriedades do catálogo

Subprograma Descrição

get_catalog_property e get_catalog_property_clob

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

update_catalog_property e update_catalog_property_clob

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

get_schema_property e get_schema_property_clob

Esses procedimentos recuperam valores de propriedade do esquema.

update_schema_property e update_schema_property_clob

Esses procedimentos atualizam os valores da propriedade do esquema.

get_table_property e get_table_property_clob

Esses procedimentos recuperam valores de propriedades da tabela.

update_table_property e update_table_property_clob

Esses procedimentos atualizam os valores das propriedades da tabela.

Gerenciamento de Credenciais

Subprograma Descrição

add_required_credential

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

remove_required_credential

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

rename_required_credential

Este procedimento renomeia uma credencial obrigatória.

update_required_credential_property

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

get_required_credential_property

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

set_local_credential

Este procedimento especifica uma credencial local para uma credencial necessária.
get_local_credential_map Este procedimento recupera mapeamentos entre credenciais necessárias e credenciais locais, com sobrecargas para vários formatos de saída.

Gerenciamento de Entidade do Catálogo

Subprograma Descrição

create_cloud_storage_link e drop_cloud_storage_link

Esse procedimento gerencia links de armazenamento em nuvem dentro de um catálogo.

create_external_table

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

drop_schema e drop_table

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

get_tables, get_schemas e get_objects

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

Acesso a Dados e Cache

Subprograma Descrição

generate_table_select

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

open_table_cursor

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

flush_catalog_cache e prefill_catalog_cache

Este procedimento gerencia o cache de metadados do catálogo.

Sincronização e Compartilhamento

Subprograma Descrição

create_synchronized_schemas e drop_synchronized_schemas

Este procedimento gerencia esquemas sincronizados com definições de catálogo remoto.

update_synchronized_schema_property

Este procedimento atualiza propriedades de esquemas sincronizados.

grant_to_recipient e revoke_from_recipient

Este procedimento gerencia permissões de acesso para destinatários do catálogo.

Tópico principal: Gerenciar Catálogos com o DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

UPDATE_TABLE_PROPERTY_CLOB Procedimento

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

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

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 novo valor de propriedade em CLOB.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

GET_TABLE_PROPERTY Procedimento

Este procedimento retorna o valor de uma propriedade para 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

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

O nome do esquema.
table_property

A propriedade a ser recuperada.
table_name

O nome da tabela.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

UPDATE_TABLE_PROPERTY_CLOB Procedimento

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

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

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 novo valor de propriedade em CLOB.

Tópico pai: Resumo de DBMS_CATALOG

ADD_REQUIRED_CREDENTIAL Procedimento

Este 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

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

O nome da credencial necessária.
local_credential

É uma credencial local opcional a ser usada. Assume NULL como padrão.

credential_type

Esse campo é 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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

Procedimento CREATE_EXTERNAL_TABLE

Este procedimento 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,
  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

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

O nome do link de armazenamento.
file_uri_list

A lista de arquivos relativa como CLOB.
column_list

Lista de colunas opcional. O padrão é NULL.
field_list

Lista de campos opcionais. O padrão é NULL.
table_format

Informações de formato opcionais. O padrão é NULL.
credential_name

A credencial necessária. O padrão é NULL.
replace_if_exists

Substitua a tabela se ela já existir. Assume FALSE como padrão.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

CREATE_SCHEMA Procedimento

Este procedimento cria um novo esquema em um catálogo.

Sintaxe

PROCEDURE create_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 do esquema.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG

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

Tópico pai: Resumo de DBMS_CATALOG

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.

Tópico pai: Resumo de DBMS_CATALOG