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 ou GENERIC.

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.

Requisitos de controle de acesso

Uma função usada para executar este comando SQL deve ter os seguintes privilégios no mínimo:

Privilégio

Objeto

Notas

USAGE

Segredo

Observe que operar em qualquer objeto de um esquema também requer o privilégio USAGE no banco de dados e esquema principais.

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 a função RESULT_SCAN, que trata a saída como uma tabela que pode ser consultada.

Exemplos

Descreva o segredo:

DESC SECRET service_now_creds_pw;
Copy