DESCRIBE CATALOG INTEGRATION

Descreve as propriedades de uma integração de catálogo.

DESCRIBE pode ser abreviado como DESC.

Dica

Além do SQL, você também pode usar outras interfaces, como Snowflake REST APIs, Snowflake Python APIs e Snowflake CLI. Consulte Interfaces alternativas.

Consulte também:

CREATE CATALOG INTEGRATION, ALTER CATALOG INTEGRATION, DROP CATALOG INTEGRATION, SHOW CATALOG INTEGRATIONS

Sintaxe

DESC[RIBE] CATALOG INTEGRATION <name>
Copy

Parâmetros

name

Especifica o identificador da integração de catálogo a ser descrita. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Saída

A saída do comando inclui as seguintes colunas, que descrevem as propriedades e metadados do objeto:

Coluna

Descrição

property

O nome da propriedade. Esta coluna pode incluir as propriedades listadas na tabela a seguir.

property_type

O tipo de propriedade.

property_value

O valor atribuído à propriedade.

property_default

O valor da propriedade padrão.

A coluna property pode incluir as seguintes propriedades do objeto de integração do catálogo:

Propriedade

Descrição

enabled

Especifica se a integração de catálogo está disponível para uso em tabelas Apache Iceberg™.

catalog_source

O tipo de fonte de catálogo; ICEBERG_REST, POLARIS, OBJECT_STORE ou GLUE (para integrações Glue não REST).

refresh_interval_seconds

Especifica o número de segundos que o Snowflake aguarda entre as tentativas de pesquisar o catálogo Iceberg externo para atualizações de metadados para atualização automatizada.

rest_authentication

Especifica os parâmetros de autenticação REST para a integração do catálogo.

rest_config

Especifica os parâmetros de configuração REST para a integração do catálogo.

catalog_namespace

A saída para essa coluna é a seguinte:

  • Se a integração do catálogo for para tabelas Iceberg gerenciadas externamente, especifica o namespace do catálogo Iceberg externo. Se o namespace for especificado apenas no nível da tabela, essa coluna não terá valor na saída da função.

  • Se a integração do catálogo for para sincronizar uma tabela gerenciada pelo Snowflake com o Snowflake Open Catalog, essa coluna não terá valor na saída da função porque esse campo não é obrigatório.

table_format

O formato da tabela fornecido pelo catálogo; por exemplo, ICEBERG.

glue_aws_role_arn

(AWS Glue) O Amazon Resource Name (ARN) da função IAM que o Snowflake assume para se conectar ao AWS Glue.

glue_catalog_id

(AWS Glue) Especifica o ID da sua conta AWS.

glue_region

(AWS Glue) A região AWS do catálogo de dados do AWS Glue.

glue_aws_iam_user_arn

(AWS Glue) O ARN do AWS do usuário IAM criado para sua conta Snowflake quando você criou a integração do catálogo.

glue_aws_external_id

(AWS Glue) O ID externo que o Snowflake usa para estabelecer uma relação de confiança com AWS Glue.

comment

O comentário para a integração do catálogo.

Requisitos de controle de acesso

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio

Objeto

Notas

USAGE

Integração (catálogo)

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso

  • Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

    Os nomes das colunas de saída para este comando são gerados em minúsculas. Se você consumir um conjunto de resultados deste comando com o operador de canal ou a função RESULT_SCAN, use identificadores entre aspas duplas para os nomes das colunas na consulta para garantir que eles correspondam aos nomes das colunas na saída que foi verificada. Por exemplo, se o nome de uma coluna de saída for type, especifique "type" para o identificador.

Exemplos

Descreva uma integração de catálogo:

DESC CATALOG INTEGRATION my_catalog_integration;
Copy

Veja a seguir a saída de DESCRIBE CATALOG INTEGRATION para uma integração do catálogo AWS Glue. A saída inclui propriedades de integração de catálogo AWS específicas do Glue (por exemplo, GLUE_AWS_ROLE_ARN) e comuns.

+-----------------------+---------------+----------------------------------+------------------+
|       property        | property_type |          property_value          | property_default |
+-----------------------+---------------+----------------------------------+------------------+
| ENABLED               | Boolean       | true                             | false            |
| CATALOG_SOURCE        | String        | GLUE                             |                  |
| CATALOG_NAMESPACE     | String        | dbname                           |                  |
| TABLE_FORMAT          | String        | ICEBERG                          |                  |
| GLUE_AWS_ROLE_ARN     | String        | arn:aws:iam::123:role/dummy-role |                  |
| GLUE_CATALOG_ID       | String        | 123456789012                     |                  |
| GLUE_REGION           | String        | us-west-2                        |                  |
| GLUE_AWS_IAM_USER_ARN | String        | arn:aws:iam::123:user/example    |                  |
| GLUE_AWS_EXTERNAL_ID  | String        | exampleGlueExternalId            |                  |
| COMMENT               | String        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+

Interfaces alternativas

Linguagem: Português