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

O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema. Observe que uma função com privilégio concedido em um esquema permite que essa função resolva o esquema. Por exemplo, uma função com privilégio CREATE concedido em um esquema pode criar objetos nesse esquema sem também ter USAGE concedido nesse esquema.

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.

For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

Exemplos¶

Descreva o segredo:

DESC SECRET service_now_creds_pw;

Copy