DESCRIBE INTEGRATION

Descreve as propriedades de uma integração.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

CREATE INTEGRATION , DROP INTEGRATION , ALTER INTEGRATION , SHOW INTEGRATIONS

API de integração:

ALTER API INTEGRATION , CREATE API INTEGRATION

Integrações de catálogo:

ALTER CATALOG INTEGRATION , CREATE CATALOG INTEGRATION

Integrações de acesso externo:

ALTER EXTERNAL ACCESS INTEGRATION , CREATE EXTERNAL ACCESS INTEGRATION

Integrações de notificação:

ALTER NOTIFICATION INTEGRATION , CREATE NOTIFICATION INTEGRATION

Integrações de segurança:

ALTER SECURITY INTEGRATION , CREATE SECURITY INTEGRATION

Integrações de armazenamento:

ALTER STORAGE INTEGRATION , CREATE STORAGE INTEGRATION

Sintaxe

{ DESC | DESCRIBE } [ { API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATION <name>
Copy

Parâmetros

{ API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE }

Descreve uma integração do tipo especificado.

Para obter mais informações sobre alguns desses tipos, consulte os tópicos a seguir:

name

Especifica o identificador da integração 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.

Para obter mais informações, consulte Requisitos para identificadores.

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.

  • Se a integração for uma integração de API, então a saída inclui a coluna API_KEY. O API_KEY exibe um valor mascarado se uma chave API foi inserida. (Não exibe a chave original não criptografada nem a versão criptografada da chave).

  • Se a integração de segurança tiver a propriedade TYPE definida como OAUTH (isto é, Snowflake OAuth), o Snowflake retorna duas propriedades adicionais de integração de segurança no resultado da consulta que não podem ser definidas com um comando CREATE SECURITY INTEGRATION ou um comando ALTER SECURITY INTEGRATION:

    OAUTH_ALLOWED_AUTHORIZATION_ENDPOINTS

    Uma lista de todos os pontos de extremidade com suporte para que um aplicativo de cliente possa receber um código de autorização de Snowflake.

    OAUTH_ALLOWED_TOKEN_ENDPOINTS

    Uma lista de todos os pontos de extremidade com suporte para que um aplicativo cliente possa trocar um código de autorização por um token de acesso ou obter um token de atualização.

Exemplos

Descreva as propriedades de uma integração chamada my_int:

DESC INTEGRATION my_int;
Copy