DESCRIBE STORAGE LIFECYCLE POLICY¶

DESCRIBE 可以缩写为 DESC。

另请参阅：: CREATE STORAGE LIFECYCLE POLICY、ALTER STORAGE LIFECYCLE POLICY、DROP STORAGE LIFECYCLE POLICY、SHOW STORAGE LIFECYCLE POLICIES

语法¶

{ DESC | DESCRIBE } STORAGE LIFECYCLE POLICY <policy_name>

参数¶

policy_name

指定要描述的策略的标识符。

如果标识符包含空格或特殊字符，则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

有关更多信息，请参阅标识符要求。

输出¶

命令的输出包括以下列，它们描述了对象的属性和元数据：


列	描述
`name`	策略的名称。
`signature`	该策略用于评估行是否过期的列。
`return_type`	包含返回值的数据类型的 VARCHAR 值。例如，BOOLEAN、NUMBER、ARRAY 和 OBJECT。
`body`	用于评估行是否应过期的函数主体。
`archive_tier`	归档存储层；COOL 或 COLD。
`archive_for_days`	过期前将表行归档的（可选）天数。如果未设置此属性，则值为 NULL。

访问控制要求¶

用于执行此 SQL 命令的角色必须至少具有以下一项权限：


权限	对象	备注
APPLY STORAGE LIFECYCLE POLICY	账户	允许对账户中的所有存储生命周期策略执行 DESC 操作。
APPLY	存储生命周期策略	允许对存储生命周期策略执行 DESC 操作。
OWNERSHIP	存储生命周期策略	OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

对架构中的对象进行操作至少需要父数据库的一项权限和父架构的一项权限。

有关创建具有指定权限集的自定义角色的说明，请参阅创建自定义角色。

有关对安全对象执行 SQL 操作的相应角色和权限授予的一般信息，请参阅访问控制概述。

使用说明¶

要对该命令的输出进行后处理，可以使用管道运算符 (->>) 或 RESULT_SCAN 函数。这两种构造都将输出视为可以查询的结果集。

例如，您可使用管道操作符或 RESULT_SCAN 函数，从 SHOW 命令输出中选择特定列或筛选行数据。

引用输出列时，为列名使用双引号标识符。例如，选择输出列 type，指定 SELECT "type"。

必须使用双引号标识符，因为 SHOW 命令的输出列名均为小写格式。双引号确保 SELECT 列表或 WHERE 子句中的列名，与已扫描的 SHOW 命令输出中的列名完全匹配。

如果您曾经为策略启用过归档存储，则该命令输出中的 archive_tier 属性会显示归档层（COOL 或 COLD）已设置。即使您使用 ALTER STORAGE LIFECYCLE POLICY 取消设置 ARCHIVE_FOR_DAYS 参数，将归档策略转换为过期策略，情况也是如此。归档层设置后无法更改。

示例¶

以下示例描述了名为 my_storage_lifecycle_policy 的存储生命周期策略：

DESCRIBE STORAGE LIFECYCLE POLICY example_slp;

输出：

+-----------------------------+----------------+-------------+------+------------------+
| name                        | signature      | return_type | body | archive_for_days |
|-----------------------------+----------------+-------------+------+------------------|
| MY_STORAGE_LIFECYCLE_POLICY | (ARG1 BOOLEAN) | BOOLEAN     | arg1 |              365 |
+-----------------------------+----------------+-------------+------+------------------+