DESCRIBE SECRET¶
描述密钥的属性。
DESCRIBE 可以缩写为 DESC。
语法¶
{ DESC | DESCRIBE } SECRET <name>
参数¶
name
指定要描述的密钥的标识符。如果标识符包含空格或特殊字符,则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。
输出¶
命令输出在以下列中提供密钥属性和元数据:
列 |
描述 |
---|---|
|
创建密钥的日期和时间。 |
|
密钥的名称。 |
|
包含密钥的架构的名称。 |
|
包含密钥的数据库的名称。 |
|
拥有密钥的角色的名称。 |
|
密钥的注释,如果没有指定注释,则显示 NULL。 |
|
|
|
存储在密钥中的用户名。 |
|
OAuth 访问令牌过期的时间戳字符串。 |
|
OAuth 刷新令牌过期的时间戳字符串,如果密钥没有存储这个值,则显示 NULL。 |
|
在以下情况下使用的以逗号分隔的范围列表:在 OAuth 客户端凭据流程期间,对集成具有 USAGE 权限的角色从 OAuth 服务器发出请求。如果没有范围,则显示 NULL。 |
|
密钥中引用的外部 API 身份验证集成的名称,如果密钥没有引用外部 API 身份验证集成,则显示 NULL。 |
|
用于 对称密钥 的算法。 |
|
用于 对称密钥 的密钥长度。 |
访问控制要求¶
权限 |
对象 |
备注 |
---|---|---|
USAGE |
密钥 |
要对架构中的任何对象执行操作,需要对父数据库和架构的 USAGE 权限。
有关创建具有指定权限集的自定义角色的说明,请参阅 创建自定义角色。
使用说明¶
Snowflake 从不返回
PASSWORD
属性值。
To post-process the output of this command, you can use the pipe operator (
->>
) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.此命令的输出列名称以小写形式生成。如果您通过管道运算符或 RESULT_SCAN 函数使用此命令的结果集,请在查询中对列名使用 加双引号的标识符,以确保它们与已扫描输出中的列名相匹配。例如,如果输出列的名称为
type
,则为标识符指定"type"
。
示例¶
描述密钥:
DESC SECRET service_now_creds_pw;