DESCRIBE SECRET

Descreve as propriedades de um segredo.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

ALTER SECRET , CREATE SECRET , DROP SECRET , SHOW SECRETS

Sintaxe

{ DESC | DESCRIBE } SECRET <name>
Copy

Parâmetros

name

Especifica o identificador do segredo a ser descrito. 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 fornece propriedades do segredo e metadados nas seguintes colunas:

Coluna

Descrição

created_on

Data e hora em que o segredo foi criado.

name

Nome do segredo.

schema_name

Nome do esquema que contém o segredo.

database_name

Nome do banco de dados que contém o segredo.

owner

Nome da função proprietária do segredo.

comment

Comente o segredo ou NULL se um comentário não for especificado.

secret_type

OAUTH2, PASSWORD, GENERIC ou SYMMETRIC_KEY.

username

O nome de usuário armazenado no segredo.

oauth_access_token_expiry_time

O carimbo de data/hora como uma cadeia de caracteres quando o token de acesso do OAuth expira.

oauth_refresh_token_expiry_time

O carimbo de data/hora como uma cadeia de caracteres quando o token de atualização do OAuth expira ou NULL se o segredo não armazena esse valor.

oauth_scopes

Uma lista separada por vírgulas dos escopos a serem usados ao fazer uma solicitação do servidor OAuth por uma função com USAGE na integração durante o fluxo de credenciais do cliente OAuth ou NULL se não houver escopos.

integration_name

O nome da integração de autenticação API externa referenciada no segredo ou NULL se o segredo não fizer referência a uma integração de autenticação API externa.

algorithm

O algoritmo usado para segredos da chave simétrica.

key_length

Comprimento da chave utilizada, para segredos de chave simétrica.

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

Segredo

A operação em um objeto de esquema requer pelo menos um privilégio no banco de dados pai e um privilégio no esquema pai.

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

  • Snowflake nunca retorna o valor da propriedade PASSWORD.

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

    Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

    Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

    Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

Exemplos

Descreva o segredo:

DESC SECRET service_now_creds_pw;
Copy
Linguagem: Português